org.codice.ddf.security.handler.cas

Class CasHandler

java.lang.Object

org.codice.ddf.security.handler.cas.CasHandler

All Implemented Interfaces:

AuthenticationHandler

public class CasHandler
extends Object
implements AuthenticationHandler

Authentication Handler for CAS. Runs through CAS filter chain if no CAS ticket is present.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_TYPE CAS type to use when configuring context policy.
protected String	realm
static String	SOURCE

Constructor Summary

Constructors

Constructor and Description
CasHandler()

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.
STSClientConfiguration	getClientConfiguration()
HandlerResult	getNormalizedToken(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain, boolean resolve) Determine if all the required information exists in the request to generate a token and move on to perform authentication and/or authorization for the requested context.
ProxyFilter	getProxyFilter()
String	getRealm()
HandlerResult	handleError(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain chain) Called when downstream authentication fails.
void	setClientConfiguration(STSClientConfiguration clientConfiguration)
void	setProxyFilter(ProxyFilter proxyFilter)
void	setRealm(String realm)

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

CAS type to use when configuring context policy.

See Also:

Constant Field Values

SOURCE

public static final String SOURCE

See Also:

Constant Field Values

realm

protected String realm

Constructor Detail

CasHandler

public CasHandler()

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)
                                 throws javax.servlet.ServletException

Description copied from interface: AuthenticationHandler

Determine if all the required information exists in the request to generate a token and move on to perform authentication and/or authorization for the requested context. If 'resolve' is set to false and the required information is missing, do not attempt to obtain it and return a status of NO_ACTION. If 'resolve' is set to true and the required information is missing, do whatever it takes to obtain it (redirects, apply your own filters, etc.) and return a status of REDIRECTED. In any case, if the required credentials are present (including the successful conclusion of any redirects, etc.) place the credentials into the HandlerResult and return a status of COMPLETED.

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:

result containing a status and the credentials to be placed into the http request

Throws:

javax.servlet.ServletException

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

getClientConfiguration

public STSClientConfiguration getClientConfiguration()

setClientConfiguration

public void setClientConfiguration(STSClientConfiguration clientConfiguration)

getProxyFilter

public ProxyFilter getProxyFilter()

setProxyFilter

public void setProxyFilter(ProxyFilter proxyFilter)

getRealm

public String getRealm()

setRealm

public void setRealm(String realm)