org.finra.herd.app.security

Class TrustedApplicationUserBuilder

java.lang.Object

org.finra.herd.app.security.TrustedApplicationUserBuilder

All Implemented Interfaces:

ApplicationUserBuilder

public class TrustedApplicationUserBuilder
extends Object
implements ApplicationUserBuilder

Application user builder that builds a trusted user with trusted role.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TRUSTED_USER_EMAIL
static String	TRUSTED_USER_FIRST_NAME
static String	TRUSTED_USER_ID
static String	TRUSTED_USER_LAST_NAME
static String	TRUSTED_USER_ROLE

Constructor Summary

Constructors

Constructor and Description
TrustedApplicationUserBuilder()

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.
ApplicationUser	buildNoRoles(javax.servlet.http.HttpServletRequest request) Builds a user object without the roles from the headers contained within the HTTP servlet request.
protected ApplicationUser	buildUser(javax.servlet.http.HttpServletRequest request, boolean includeRoles) Builds the application user.

Methods inherited from class java.lang.Object

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

Field Detail

TRUSTED_USER_ID

public static final String TRUSTED_USER_ID

See Also:

Constant Field Values

TRUSTED_USER_FIRST_NAME

public static final String TRUSTED_USER_FIRST_NAME

See Also:

Constant Field Values

TRUSTED_USER_LAST_NAME

public static final String TRUSTED_USER_LAST_NAME

See Also:

Constant Field Values

TRUSTED_USER_EMAIL

public static final String TRUSTED_USER_EMAIL

See Also:

Constant Field Values

TRUSTED_USER_ROLE

public static final String TRUSTED_USER_ROLE

See Also:

Constant Field Values

Constructor Detail

TrustedApplicationUserBuilder

public TrustedApplicationUserBuilder()

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(javax.servlet.http.HttpServletRequest request,
                                    boolean includeRoles)

Builds the application user.

Parameters:

request - the HTTP servlet request.

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

Returns:

the application user.