org.osivia.portal.identity.sso.cas

Class CASAuthenticationValve

java.lang.Object

org.apache.catalina.valves.ValveBase

org.osivia.portal.identity.sso.cas.CASAuthenticationValve

All Implemented Interfaces:

MBeanRegistration, org.apache.catalina.Contained, org.apache.catalina.Valve

public class CASAuthenticationValve
extends org.apache.catalina.valves.ValveBase

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHORIZED_PROXY_INIT_PARAM The name of the filter initialization parameter the value of which must be a whitespace delimited list of services (ProxyTicketReceptors) authorized to proxy authentication to the service filtered by this Filter.
static String	CAS_FILTER_RECEIPT Session attribute in which the CASReceipt is stored.
static String	CAS_FILTER_USER Session attribute in which the username is stored.
static String	GATEWAY_INIT_PARAM The name of the filter initialization parameter the value of which is the value the Filter should send for the gateway parameter on the CAS login request.
static String	LOGIN_INIT_PARAM The name of the filter initialization parameter the value of which should be the https: address of the CAS Login servlet.
static String	PROXY_CALLBACK_INIT_PARAM The name of the filter initialization parameter the value of which must be the https: URL to which CAS should send Proxy Granting Tickets when this filter validates tickets.
static String	RENEW_INIT_PARAM The name of the filter initialization parameter the value of which must be the String that should be sent as the "renew" parameter on the request for login and validation.
static String	SERVERNAME_INIT_PARAM The name of the filter initialization parameter the vlaue of which must be the server name, e.g. www.yale.edu , of the service this filter is filtering.
static String	SERVICE_INIT_PARAM The name of the filter initialization parameter the value of which must be the address of the service this filter is filtering.
static String	VALIDATE_INIT_PARAM The name of the filter initialization parameter the value of which must be the https: address of the CAS Validate servlet.
static String	VIRTUAL_HOST_REQUEST_HEADER request header defined on a web server in front of the portal
static String	WRAP_REQUESTS_INIT_PARAM The name of the filter initialization parameter the value of which indicates whether this filter should wrap requests to expose the authenticated username.

Fields inherited from class org.apache.catalina.valves.ValveBase

container, containerLog, controller, domain, info, mserver, next, oname, sm

Constructor Summary

Constructors

Constructor and Description
CASAuthenticationValve()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAuthType()
String	getCasLogin()
String	getCasLogout()
String	getCasServerName()
String	getCasServiceUrl()
String	getCasValidate()
Set	getSecuredUrlPatterns()
void	invoke(org.apache.catalina.connector.Request request, org.apache.catalina.connector.Response response)
void	setAuthType(String authType)
void	setCasLogin(String casLogin)
void	setCasLogout(String casLogout)
void	setCasServerName(String casServerName)
void	setCasServiceUrl(String casServiceUrl)
void	setCasValidate(String casValidate)

Methods inherited from class org.apache.catalina.valves.ValveBase

backgroundProcess, createObjectName, event, getContainer, getContainerName, getController, getDomain, getInfo, getNext, getObjectName, getParentName, postDeregister, postRegister, preDeregister, preRegister, setContainer, setController, setNext, setObjectName, toString

Methods inherited from class java.lang.Object

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

Field Detail

VIRTUAL_HOST_REQUEST_HEADER

public static final String VIRTUAL_HOST_REQUEST_HEADER

request header defined on a web server in front of the portal

See Also:

Constant Field Values

LOGIN_INIT_PARAM

public static final String LOGIN_INIT_PARAM

The name of the filter initialization parameter the value of which should be the https: address of the CAS Login servlet. Optional parameter, but required for successful redirection of unauthenticated requests to authentication.

See Also:

Constant Field Values

VALIDATE_INIT_PARAM

public static final String VALIDATE_INIT_PARAM

The name of the filter initialization parameter the value of which must be the https: address of the CAS Validate servlet. Must be a CAS 2.0 validate servlet (CAS 1.0 non-XML won't suffice). Required parameter.

See Also:

Constant Field Values

SERVICE_INIT_PARAM

public static final String SERVICE_INIT_PARAM

The name of the filter initialization parameter the value of which must be the address of the service this filter is filtering. The filter will use this as the service parameter for CAS login and validation. Either this parameter or SERVERNAME_INIT_PARAM must be set.

See Also:

Constant Field Values

SERVERNAME_INIT_PARAM

public static final String SERVERNAME_INIT_PARAM

The name of the filter initialization parameter the vlaue of which must be the server name, e.g. www.yale.edu , of the service this filter is filtering. The filter will construct from this name and the request the full service parameter for CAS login and validation.

See Also:

Constant Field Values

RENEW_INIT_PARAM

public static final String RENEW_INIT_PARAM

The name of the filter initialization parameter the value of which must be the String that should be sent as the "renew" parameter on the request for login and validation. This should either be "true" or not be set. It is mutually exclusive with GATEWAY.

See Also:

Constant Field Values

AUTHORIZED_PROXY_INIT_PARAM

public static final String AUTHORIZED_PROXY_INIT_PARAM

The name of the filter initialization parameter the value of which must be a whitespace delimited list of services (ProxyTicketReceptors) authorized to proxy authentication to the service filtered by this Filter. These must be https: URLs. This parameter is optional - not setting it results in no proxy tickets being acceptable.

See Also:

Constant Field Values

PROXY_CALLBACK_INIT_PARAM

public static final String PROXY_CALLBACK_INIT_PARAM

The name of the filter initialization parameter the value of which must be the https: URL to which CAS should send Proxy Granting Tickets when this filter validates tickets.

See Also:

Constant Field Values

WRAP_REQUESTS_INIT_PARAM

public static final String WRAP_REQUESTS_INIT_PARAM

The name of the filter initialization parameter the value of which indicates whether this filter should wrap requests to expose the authenticated username.

See Also:

Constant Field Values

GATEWAY_INIT_PARAM

public static final String GATEWAY_INIT_PARAM

The name of the filter initialization parameter the value of which is the value the Filter should send for the gateway parameter on the CAS login request.

See Also:

Constant Field Values

CAS_FILTER_USER

public static final String CAS_FILTER_USER

Session attribute in which the username is stored.

See Also:

Constant Field Values

CAS_FILTER_RECEIPT

public static final String CAS_FILTER_RECEIPT

Session attribute in which the CASReceipt is stored.

See Also:

Constant Field Values

Constructor Detail

CASAuthenticationValve

public CASAuthenticationValve()

Method Detail

getCasLogin

public String getCasLogin()

Returns:

setCasLogin

public void setCasLogin(String casLogin)

Parameters:

casLogin -

getCasLogout

public String getCasLogout()

Returns:

setCasLogout

public void setCasLogout(String casLogout)

Parameters:

casLogout -

getCasServerName

public String getCasServerName()

Returns:

setCasServerName

public void setCasServerName(String casServerName)

Parameters:

casServerName -

getCasValidate

public String getCasValidate()

Returns:

setCasValidate

public void setCasValidate(String casValidate)

Parameters:

casValidate -

getAuthType

public String getAuthType()

Returns:

setAuthType

public void setAuthType(String authType)

Parameters:

authType -

getCasServiceUrl

public String getCasServiceUrl()

Returns:

setCasServiceUrl

public void setCasServiceUrl(String casServiceUrl)

Parameters:

casServiceUrl -

invoke

public void invoke(org.apache.catalina.connector.Request request,
          org.apache.catalina.connector.Response response)
            throws IOException,
                   javax.servlet.ServletException

Specified by:

invoke in interface org.apache.catalina.Valve

Specified by:

invoke in class org.apache.catalina.valves.ValveBase

Throws:

IOException

javax.servlet.ServletException

getSecuredUrlPatterns

public Set getSecuredUrlPatterns()