org.codice.ddf.platform.filter.clientinfo

Class ClientInfoFilter

java.lang.Object

org.codice.ddf.platform.filter.clientinfo.ClientInfoFilter

All Implemented Interfaces:

javax.servlet.Filter, SecurityFilter

public class ClientInfoFilter
extends Object
implements SecurityFilter

This servlet filter extracts client-specific information and places it in the shiro ThreadContext so it can be forwarded to useful areas of interest. Also contains the constants for working with the client info map.

The information currently all comes from the servlet API; specifically a select few getters within ServletRequest. The format of the keys follows the format of java beans. The keys are camel-cased names without the preceeding 'get' found in the method name.

For example, the key associated with ServletRequest.getRemoteAddr() would be the string remoteAddr.

The only exception to this rule, CLIENT_INFO_KEY, which holds a value string of client-info, is the key used to access the entire client information map. It may contain different kinds of data that does not necessarily correlate to the servlet API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_INFO_KEY
static String	SERVLET_CONTEXT_PATH
static String	SERVLET_REMOTE_ADDR
static String	SERVLET_REMOTE_HOST
static String	SERVLET_SCHEME

Constructor Summary

Constructors

Constructor and Description
ClientInfoFilter()

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain filterChain)
void	init(javax.servlet.FilterConfig filterConfig)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLIENT_INFO_KEY

public static final String CLIENT_INFO_KEY

See Also:

Constant Field Values

SERVLET_REMOTE_ADDR

public static final String SERVLET_REMOTE_ADDR

See Also:

Constant Field Values

SERVLET_REMOTE_HOST

public static final String SERVLET_REMOTE_HOST

See Also:

Constant Field Values

SERVLET_SCHEME

public static final String SERVLET_SCHEME

See Also:

Constant Field Values

SERVLET_CONTEXT_PATH

public static final String SERVLET_CONTEXT_PATH

See Also:

Constant Field Values

Constructor Detail

ClientInfoFilter

public ClientInfoFilter()

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

doFilter

public void doFilter(javax.servlet.ServletRequest servletRequest,
                     javax.servlet.ServletResponse servletResponse,
                     javax.servlet.FilterChain filterChain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException