org.codice.ddf.security.handler.guest

Class GuestHandler

java.lang.Object

org.codice.ddf.security.handler.guest.GuestHandler

All Implemented Interfaces:

AuthenticationHandler

public class GuestHandler
extends Object
implements AuthenticationHandler

Handler that allows guest user access via a guest user account. The guest/guest account must be present in the user store for this handler to work correctly.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_TYPE Guest type to use when configuring context policy.
static String	INVALID_MESSAGE

Constructor Summary

Constructors

Constructor and Description
GuestHandler()

Method Summary

Modifier and Type	Method and Description
String	getAuthenticationType() Authentication type String used to match this handler with the auth types configured for a specific context.
HandlerResult	getNormalizedToken(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain, boolean resolve) This method takes a guest request and attaches a username token to the HTTP request to allow access.
PKIAuthenticationTokenFactory	getTokenFactory()
HandlerResult	handleError(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain chain) Called when downstream authentication fails.
void	setTokenFactory(PKIAuthenticationTokenFactory tokenFactory)

Methods inherited from class java.lang.Object

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

Field Detail

AUTH_TYPE

public static final String AUTH_TYPE

Guest type to use when configuring context policy.

See Also:

Constant Field Values

INVALID_MESSAGE

public static final String INVALID_MESSAGE

See Also:

Constant Field Values

Constructor Detail

GuestHandler

public GuestHandler()

Method Detail

getAuthenticationType

public String getAuthenticationType()

Description copied from interface: AuthenticationHandler

Authentication type String used to match this handler with the auth types configured for a specific context.

Specified by:

getAuthenticationType in interface AuthenticationHandler

Returns:

String representing the authentication type

getNormalizedToken

public HandlerResult getNormalizedToken(javax.servlet.ServletRequest request,
                                        javax.servlet.ServletResponse response,
                                        javax.servlet.FilterChain chain,
                                        boolean resolve)

This method takes a guest request and attaches a username token to the HTTP request to allow access. The method also allows the user to sign-in and authenticate.

Specified by:

getNormalizedToken in interface AuthenticationHandler

Parameters:

request - http request to obtain attributes from and to pass into any local filter chains required

response - http response to return http responses or redirects

chain - original filter chain (should not be called from your handler)

resolve - flag with true implying that credentials should be obtained, false implying return if no credentials are found.

Returns:

HandlerResult

handleError

public HandlerResult handleError(javax.servlet.ServletRequest servletRequest,
                                 javax.servlet.ServletResponse servletResponse,
                                 javax.servlet.FilterChain chain)
                          throws javax.servlet.ServletException

Description copied from interface: AuthenticationHandler

Called when downstream authentication fails. Should attempt to re-acquire credentials if appropriate. Returns a status indicating if appropriate action has been taken.

Specified by:

handleError in interface AuthenticationHandler

Parameters:

servletRequest - htt http response to return http responses or redirects

Returns:

result containing a status indicating if further action is necessary

Throws:

javax.servlet.ServletException

getTokenFactory

public PKIAuthenticationTokenFactory getTokenFactory()

setTokenFactory

public void setTokenFactory(PKIAuthenticationTokenFactory tokenFactory)