org.finra.herd.app.security

Class HttpHeaderApplicationUserBuilder

java.lang.Object

org.finra.herd.app.security.HttpHeaderApplicationUserBuilder

All Implemented Interfaces:

ApplicationUserBuilder

public class HttpHeaderApplicationUserBuilder
extends Object
implements ApplicationUserBuilder

Http headers based Application user builder.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CALENDAR_PATTERN_PWD
static String	CALENDAR_PATTERN_SESSION
static String	CALENDAR_PATTERN_SESSION_TZ
static String[]	CALENDAR_PATTERNS
static String	HTTP_HEADER_EMAIL
static String	HTTP_HEADER_FIRST_NAME
static String	HTTP_HEADER_LAST_NAME
static String	HTTP_HEADER_ROLES
static String	HTTP_HEADER_SESSION_ID
static String	HTTP_HEADER_SESSION_INIT_TIME
static String	HTTP_HEADER_USER_ID

Constructor Summary

Constructors

Constructor and Description
HttpHeaderApplicationUserBuilder()

Method Summary

Modifier and Type	Method and Description
ApplicationUser	build(javax.servlet.http.HttpServletRequest request) Builds an application user from the headers contained within the HTTP servlet request.
protected void	buildEmail(ApplicationUser applicationUser, Map<String,String> httpHeaders, String headerName)
protected void	buildFirstName(ApplicationUser applicationUser, Map<String,String> httpHeaders, String headerName)
protected void	buildLastName(ApplicationUser applicationUser, Map<String,String> httpHeaders, String headerName)
ApplicationUser	buildNoRoles(javax.servlet.http.HttpServletRequest request) Builds a user object without the roles from the headers contained within the HTTP servlet request.
protected void	buildRoles(ApplicationUser applicationUser, Map<String,String> httpHeaders, String headerName) Parses the header and assigns roles to the given user object.
protected void	buildSessionId(ApplicationUser applicationUser, Map<String,String> httpHeaders, String headerName)
protected void	buildSessionInitTime(ApplicationUser applicationUser, Map<String,String> httpHeaders, String headerName)
protected ApplicationUser	buildUser(Map<String,String> headerMap, boolean includeRoles) Builds the application user from the header map.
protected void	buildUserId(ApplicationUser applicationUser, Map<String,String> httpHeaders, String headerName) Builds a user Id.
protected ApplicationUser	createNewApplicationUser() A Factory Method for creating a new ApplicationUser.
Date	getHeaderValueDate(String headerName, Map<String,String> httpHeaders) Gets an HTTP header date value from the map of headers for the specified header name.
protected String	getHeaderValueString(String headerName, Map<String,String> httpHeaders) Gets an HTTP header string value from the map of headers for the specified header name.

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_HEADER_USER_ID

public static final String HTTP_HEADER_USER_ID

See Also:

Constant Field Values

HTTP_HEADER_FIRST_NAME

public static final String HTTP_HEADER_FIRST_NAME

See Also:

Constant Field Values

HTTP_HEADER_LAST_NAME

public static final String HTTP_HEADER_LAST_NAME

See Also:

Constant Field Values

HTTP_HEADER_EMAIL

public static final String HTTP_HEADER_EMAIL

See Also:

Constant Field Values

HTTP_HEADER_ROLES

public static final String HTTP_HEADER_ROLES

See Also:

Constant Field Values

HTTP_HEADER_SESSION_INIT_TIME

public static final String HTTP_HEADER_SESSION_INIT_TIME

See Also:

Constant Field Values

HTTP_HEADER_SESSION_ID

public static final String HTTP_HEADER_SESSION_ID

See Also:

Constant Field Values

CALENDAR_PATTERN_PWD

public static final String CALENDAR_PATTERN_PWD

See Also:

Constant Field Values

CALENDAR_PATTERN_SESSION

public static final String CALENDAR_PATTERN_SESSION

See Also:

Constant Field Values

CALENDAR_PATTERN_SESSION_TZ

public static final String CALENDAR_PATTERN_SESSION_TZ

See Also:

Constant Field Values

CALENDAR_PATTERNS

public static final String[] CALENDAR_PATTERNS

Constructor Detail

HttpHeaderApplicationUserBuilder

public HttpHeaderApplicationUserBuilder()

Method Detail

build

public ApplicationUser build(javax.servlet.http.HttpServletRequest request)

Description copied from interface: ApplicationUserBuilder

Builds an application user from the headers contained within the HTTP servlet request.

Specified by:

build in interface ApplicationUserBuilder

Parameters:

request - the HTTP servlet request.

Returns:

the application user.

buildNoRoles

public ApplicationUser buildNoRoles(javax.servlet.http.HttpServletRequest request)

Description copied from interface: ApplicationUserBuilder

Builds a user object without the roles from the headers contained within the HTTP servlet request. This method provides a security filter the ability to compare the current header's username or session Id and session init time with the previous requests version to see if a different user is logged in. Building the entire user would also work, but that could be expensive (e.g. role lookups could come from LDAP).

Specified by:

buildNoRoles in interface ApplicationUserBuilder

Parameters:

request - the HTTP servlet request.

Returns:

the application user without roles present.

buildUser

protected ApplicationUser buildUser(Map<String,String> headerMap,
                                    boolean includeRoles)

Builds the application user from the header map.

Parameters:

headerMap - the map of headers.

includeRoles - If true, the user's roles will be included. Otherwise, not.

Returns:

the application user.

createNewApplicationUser

protected ApplicationUser createNewApplicationUser()

A Factory Method for creating a new ApplicationUser. Provide ability for subclasses to override this if a custom user class is required. The custom user class must extend ApplicationUser.

Returns:

ApplicationUser (or a subtype)

buildUserId

protected void buildUserId(ApplicationUser applicationUser,
                           Map<String,String> httpHeaders,
                           String headerName)

Builds a user Id.

Parameters:

applicationUser - the application user.

httpHeaders - the HTTP headers.

headerName - the header name for the user Id.

buildFirstName

protected void buildFirstName(ApplicationUser applicationUser,
                              Map<String,String> httpHeaders,
                              String headerName)

buildLastName

protected void buildLastName(ApplicationUser applicationUser,
                             Map<String,String> httpHeaders,
                             String headerName)

buildEmail

protected void buildEmail(ApplicationUser applicationUser,
                          Map<String,String> httpHeaders,
                          String headerName)

buildSessionId

protected void buildSessionId(ApplicationUser applicationUser,
                              Map<String,String> httpHeaders,
                              String headerName)

buildSessionInitTime

protected void buildSessionInitTime(ApplicationUser applicationUser,
                                    Map<String,String> httpHeaders,
                                    String headerName)

buildRoles

protected void buildRoles(ApplicationUser applicationUser,
                          Map<String,String> httpHeaders,
                          String headerName)

Parses the header and assigns roles to the given user object. The header value of the given header name will be parsed for roles. See parseRoles(String, Set) method for details on the parsing process.

Parameters:

applicationUser - - the user object to populate the roles to

httpHeaders - - the HTTP headers given in the current request

headerName - - the name of the header containing the roles

getHeaderValueString

protected String getHeaderValueString(String headerName,
                                      Map<String,String> httpHeaders)

Gets an HTTP header string value from the map of headers for the specified header name. If the header value is blank, null will be returned in its place. The header name is case-insensitive, but will be converted to lower-case before retrieving the header value. The returned header value is trimmed.

Parameters:

headerName - the HTTP header name to get.

httpHeaders - the HTTP headers.

Returns:

the HTTP header value.

getHeaderValueDate

public Date getHeaderValueDate(String headerName,
                               Map<String,String> httpHeaders)

Gets an HTTP header date value from the map of headers for the specified header name. If the header value is blank or can't be converted to a Date, null will be returned in its place.

Parameters:

headerName - the HTTP header name to get.

httpHeaders - the HTTP headers.

Returns:

the HTTP header value.