org.jasig.services.persondir.support.web

Class RequestAttributeSourceFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.jasig.services.persondir.support.web.RequestAttributeSourceFilter

All Implemented Interfaces:

javax.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.web.context.ServletContextAware

public class RequestAttributeSourceFilter
extends org.springframework.web.filter.GenericFilterBean

Filter that can provide HttpServletRequest headers and other properties on the request as person attributes. The filter sets attributes on a IAdditionalDescriptors which it is configured with. To work correctly the IAdditionalDescriptors object needs to be a session scoped Spring bean so that each user gets only their own attributes correctly.

Required Configuration:

• usernameAttribute
• additionalDescriptors

Version:

$Revision$

Author:

Eric Dalquist

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RequestAttributeSourceFilter.ProcessingPosition

Constructor Summary

Constructors

Constructor and Description
RequestAttributeSourceFilter()

Method Summary

Modifier and Type	Method and Description
protected void	addRequestAttributes(javax.servlet.http.HttpServletRequest httpServletRequest, Map<String,List<Object>> attributes) Add specified request parameters to the attributes map.
protected void	addRequestCookies(javax.servlet.http.HttpServletRequest httpServletRequest, Map<String,List<Object>> attributes) Add request cookies to the attributes map
protected void	addRequestHeaders(javax.servlet.http.HttpServletRequest httpServletRequest, Map<String,List<Object>> attributes) Add request headers to the attributes map
protected void	addRequestParameters(javax.servlet.http.HttpServletRequest httpServletRequest, Map<String,List<Object>> attributes) Add specified request parameters to the attributes map.
protected void	addRequestProperties(javax.servlet.http.HttpServletRequest httpServletRequest, Map<String,List<Object>> attributes) Add other properties from the request to the attributes map.
void	doFilter(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain chain)
IAdditionalDescriptors	getAdditionalDescriptors()
Map<String,Set<String>>	getCookieAttributeMapping()
Map<String,Set<String>>	getHeaderAttributeMapping()
Set<String>	getHeadersToIgnoreSemicolons()
Map<String,Set<String>>	getParameterAttributeMapping()
RequestAttributeSourceFilter.ProcessingPosition	getProcessingPosition()
String	getReferringParameterName()
String	getRemoteAddrAttribute()
String	getRemoteHostAttribute()
String	getRemoteUserAttribute()
Map<String,Set<String>>	getRequestAttributeMapping()
String	getServerNameAttribute()
String	getServerPortAttribute()
String	getUrlCharacterEncoding()
String	getUsernameAttribute()
boolean	isClearExistingAttributes()
void	setAdditionalDescriptors(IAdditionalDescriptors additionalDescriptors) The IAdditionalDescriptors instance to set request attributes on.
void	setClearExistingAttributes(boolean clearExistingAttributes) If true when attributes are found on the request any existing attributes in the provided IAdditionalDescriptors object will cleared and replaced with the new attributes.
void	setCookieAttributeMapping(Map<String,?> cookieAttributeMapping) Set the Map to use for mapping from a cookie name to an attribute name or Set of attribute names.
void	setHeaderAttributeMapping(Map<String,?> headerAttributeMapping) Set the Map to use for mapping from a header name to an attribute name or Set of attribute names.
void	setHeadersToIgnoreSemicolons(Set<String> headersToIgnoreSemicolons) Set of header values to ignore splitting on semicolons.
void	setParameterAttributeMapping(Map<String,?> parameterAttributeMapping) Set the Map to use for mapping from a parameter name to an attribute name or Set of attribute names.
void	setProcessingPosition(RequestAttributeSourceFilter.ProcessingPosition processingPosition) Sets the pre/post/both position of the processing relative to the doFilter call.
void	setReferringParameterName(String referringParameterName) Name of a request parameter whose value is decoded and checked for parameterAttributeMapping matches.
void	setRemoteAddrAttribute(String remoteAddrAttribute) If specified ServletRequest.getRemoteAddr() is added as an attribute under the provided name
void	setRemoteHostAttribute(String remoteHostAttribute) If specified ServletRequest.getRemoteHost() is added as an attribute under the provided name
void	setRemoteUserAttribute(String remoteUserAttribute) If specified HttpServletRequest.getRemoteUser() is added as an attribute under the provided name
void	setRequestAttributeMapping(Map<String,?> requestAttributeMapping) Set the Map to use for mapping from a request attributes to an attribute name or Set of attribute names.
void	setServerNameAttribute(String serverNameAttribute) If specified ServletRequest.getServerName() is added as an attribute under the provided name
void	setServerPortAttribute(String serverPortAttribute) If specified ServletRequest.getServerPort() is added as an attribute under the provided name
void	setUrlCharacterEncoding(String urlCharacterEncoding) Sets the URL character encoding to use to decode the value of the referringParameterName if it was specified.
void	setUsernameAttribute(String usernameAttribute) The name of the attribute from the request (header or property) to use as the username.

Methods inherited from class org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, destroy, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestAttributeSourceFilter

public RequestAttributeSourceFilter()

Method Detail

getUsernameAttribute

public String getUsernameAttribute()

setUsernameAttribute

public void setUsernameAttribute(String usernameAttribute)

The name of the attribute from the request (header or property) to use as the username. Required so that Person Directory can later associate these attributes with the user correctly during queries.

Parameters:

usernameAttribute - Name of the attribute from the request (header or property) to use as the username

getRemoteUserAttribute

public String getRemoteUserAttribute()

setRemoteUserAttribute

public void setRemoteUserAttribute(String remoteUserAttribute)

If specified HttpServletRequest.getRemoteUser() is added as an attribute under the provided name

Parameters:

remoteUserAttribute - Name of the attribute to add when HttpServletRequest.getRemoteUser() is invoked

getRemoteAddrAttribute

public String getRemoteAddrAttribute()

setRemoteAddrAttribute

public void setRemoteAddrAttribute(String remoteAddrAttribute)

If specified ServletRequest.getRemoteAddr() is added as an attribute under the provided name

Parameters:

remoteAddrAttribute - Name of the attribute to add when ServletRequest.getRemoteAddr() is invoked

getRemoteHostAttribute

public String getRemoteHostAttribute()

setRemoteHostAttribute

public void setRemoteHostAttribute(String remoteHostAttribute)

If specified ServletRequest.getRemoteHost() is added as an attribute under the provided name

Parameters:

remoteHostAttribute - Name of the attribute to add when ServletRequest.getRemoteHost() is invoked

getServerNameAttribute

public String getServerNameAttribute()

setServerNameAttribute

public void setServerNameAttribute(String serverNameAttribute)

If specified ServletRequest.getServerName() is added as an attribute under the provided name

Parameters:

serverNameAttribute - Name of the attribute to add when ServletRequest.getServerName() is invoked

getServerPortAttribute

public String getServerPortAttribute()

setServerPortAttribute

public void setServerPortAttribute(String serverPortAttribute)

If specified ServletRequest.getServerPort() is added as an attribute under the provided name

Parameters:

serverPortAttribute - Name of the attribute to add when ServletRequest.getServerPort() is invoked

getAdditionalDescriptors

public IAdditionalDescriptors getAdditionalDescriptors()

setAdditionalDescriptors

public void setAdditionalDescriptors(IAdditionalDescriptors additionalDescriptors)

The IAdditionalDescriptors instance to set request attributes on. This should be a Spring session-scoped proxy to allow each session to have its own set of request-populated attributes.

Parameters:

additionalDescriptors - IAdditionalDescriptors instance to set request attributes on

isClearExistingAttributes

public boolean isClearExistingAttributes()

setClearExistingAttributes

public void setClearExistingAttributes(boolean clearExistingAttributes)

If true when attributes are found on the request any existing attributes in the provided IAdditionalDescriptors object will cleared and replaced with the new attributes. If false (default) the new attributes overwrite existing attributes of the same name but attributes in IAdditionalDescriptors not found on the current request are not touched.

Parameters:

clearExistingAttributes - If existing all attributes should be cleared when any new attributes are found.

getProcessingPosition

public RequestAttributeSourceFilter.ProcessingPosition getProcessingPosition()

setProcessingPosition

public void setProcessingPosition(RequestAttributeSourceFilter.ProcessingPosition processingPosition)

Sets the pre/post/both position of the processing relative to the doFilter call. PRE means the attribute processing happens before the doFilter call POST means the attribute processing happens after the doFilter call BOTH means the attribute processing happens before and after the doFilter call

Parameters:

processingPosition - Processing position

setCookieAttributeMapping

public void setCookieAttributeMapping(Map<String,?> cookieAttributeMapping)

Set the Map to use for mapping from a cookie name to an attribute name or Set of attribute names. Cookie names that are not specified as keys in this Map will be ignored.
The passed Map must have keys of type String and values of type String or a Set of String.

Parameters:

cookieAttributeMapping - Map from cookie names to attribute names, may not be null.

Throws:

IllegalArgumentException - If the Map doesn't follow the rules stated above.

See Also:

MultivaluedPersonAttributeUtils.parseAttributeToAttributeMapping(Map)

getCookieAttributeMapping

public Map<String,Set<String>> getCookieAttributeMapping()

getHeaderAttributeMapping

public Map<String,Set<String>> getHeaderAttributeMapping()

setHeaderAttributeMapping

public void setHeaderAttributeMapping(Map<String,?> headerAttributeMapping)

Set the Map to use for mapping from a header name to an attribute name or Set of attribute names. Header names that are not specified as keys in this Map will be ignored.
The passed Map must have keys of type String and values of type String or a Set of String.

Parameters:

headerAttributeMapping - Map from header names to attribute names, may not be null.

Throws:

IllegalArgumentException - If the Map doesn't follow the rules stated above.

See Also:

MultivaluedPersonAttributeUtils.parseAttributeToAttributeMapping(Map)

getRequestAttributeMapping

public Map<String,Set<String>> getRequestAttributeMapping()

setRequestAttributeMapping

public void setRequestAttributeMapping(Map<String,?> requestAttributeMapping)

Set the Map to use for mapping from a request attributes to an attribute name or Set of attribute names. Request attributes that are not specified as keys in this Map will be ignored.
The passed Map must have keys of type String and values of type String or a Set of String.

Parameters:

requestAttributeMapping - Map from request attributes to attribute names, may not be null.

Throws:

IllegalArgumentException - If the Map doesn't follow the rules stated above.

See Also:

MultivaluedPersonAttributeUtils.parseAttributeToAttributeMapping(Map)

getParameterAttributeMapping

public Map<String,Set<String>> getParameterAttributeMapping()

setParameterAttributeMapping

public void setParameterAttributeMapping(Map<String,?> parameterAttributeMapping)

Set the Map to use for mapping from a parameter name to an attribute name or Set of attribute names. Parameter names that are not specified as keys in this Map will be ignored.
The passed Map must have keys of type String and values of type String or a Set of String.

Parameters:

parameterAttributeMapping - Map from parameter names to attribute names, may not be null.

Throws:

IllegalArgumentException - If the Map doesn't follow the rules stated above.

Since:

1.7.1

See Also:

MultivaluedPersonAttributeUtils.parseAttributeToAttributeMapping(Map)

getReferringParameterName

public String getReferringParameterName()

setReferringParameterName

public void setReferringParameterName(String referringParameterName)

Name of a request parameter whose value is decoded and checked for parameterAttributeMapping matches. This is useful when the user's browser follows a redirect path and the request parameters from the user's original request are encoded in a 'refUrl' or similar parameter. uPortal, for instance, does this. When a user accesses /uPortal?nativeClient=true, a redirect chain encodes this to '/uPortal/Login?refUrl=%2FuPortal%2F%3FnativeClient%3Dtrue'. Has no effect if not specified or if parameterAttributeMapping does not have matches to request parameters in the referringParameterName. If specified, parameterAttributeMapping matches in first the referringParameterName and then the request parameters (thus would overwrite).

Parameters:

referringParameterName - Name of a request parameter to decode and inspect for parameterAttributeMapping matches.

Since:

1.7.1

getUrlCharacterEncoding

public String getUrlCharacterEncoding()

setUrlCharacterEncoding

public void setUrlCharacterEncoding(String urlCharacterEncoding)

Sets the URL character encoding to use to decode the value of the referringParameterName if it was specified. Defaults to UTF-8.

Parameters:

urlCharacterEncoding - URL character encoding name

Since:

1.7.1

getHeadersToIgnoreSemicolons

public Set<String> getHeadersToIgnoreSemicolons()

setHeadersToIgnoreSemicolons

public void setHeadersToIgnoreSemicolons(Set<String> headersToIgnoreSemicolons)

Set of header values to ignore splitting on semicolons. Some HTTP Headers, such as the User-Agent string, should not be split on semicolons. Defaults to User-Agent

Parameters:

headersToIgnoreSemicolons - Set of HTTP Header names to not split its value on semicolons into multiple values

doFilter

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

Throws:

IOException

javax.servlet.ServletException

addRequestProperties

protected void addRequestProperties(javax.servlet.http.HttpServletRequest httpServletRequest,
                                    Map<String,List<Object>> attributes)

Add other properties from the request to the attributes map.

Parameters:

httpServletRequest - Http Servlet Request

attributes - Map of attributes to add additional attributes to from the Http Request

addRequestCookies

protected void addRequestCookies(javax.servlet.http.HttpServletRequest httpServletRequest,
                                 Map<String,List<Object>> attributes)

Add request cookies to the attributes map

Parameters:

httpServletRequest - Http Servlet Request

attributes - Map of attributes to add additional attributes to from the Http Request

addRequestHeaders

protected void addRequestHeaders(javax.servlet.http.HttpServletRequest httpServletRequest,
                                 Map<String,List<Object>> attributes)

Add request headers to the attributes map

Parameters:

httpServletRequest - Http Servlet Request

attributes - Map of attributes to add additional attributes to from the Http Request

addRequestAttributes

protected void addRequestAttributes(javax.servlet.http.HttpServletRequest httpServletRequest,
                                    Map<String,List<Object>> attributes)

Add specified request parameters to the attributes map. Some Shibboleth (Apache httpd mod-shib) configurations use environment variables which get passed by AJP as request attributes rather than HTTP Headers to pass attributes from the IDP to the application. Since the attributes are likely from Shib, we want to do the same semicolon splitting behavior as HTTP headers. Shib often passes multi-valued attributes, such as a list of user roles.

Parameters:

httpServletRequest - Servlet Request

attributes - Map of attributes to add additional attributes to from the Http Request

Since:

1.7.1

addRequestParameters

protected void addRequestParameters(javax.servlet.http.HttpServletRequest httpServletRequest,
                                    Map<String,List<Object>> attributes)

Add specified request parameters to the attributes map. The request parameters may be directly in the URL or in a referringUrl parameter (with uPortal accessing /uPortal?nativeClient=true will go through several redirects and get turned into /uPortal/Login?refUrl=%2FuPortal%2F%3FnativeClient%3Dtrue, which when fetched with request.getParameter(refurl) yields '/uPortal/?nativeClient=true').

Parameters:

httpServletRequest - Servlet Request

attributes - Map of attributes to add additional attributes to from the Http Request

Since:

1.7.1