org.springframework.security.cas
Class ServiceProperties

java.lang.Object
  org.springframework.security.cas.ServiceProperties

All Implemented Interfaces:

InitializingBean

Direct Known Subclasses:

SamlServiceProperties

public class ServiceProperties
extends Object
implements InitializingBean

Stores properties related to this CAS service.

Each web application capable of processing CAS tickets is known as a service. This class stores the properties that are relevant to the local CAS service, being the application that is being secured by Spring Security.

Version:

$Id: ServiceProperties.java 3856 2009-09-01 19:53:19Z battags $

Author:

Ben Alex

Field Summary

static String	DEFAULT_CAS_ARTIFACT_PARAMETER
static String	DEFAULT_CAS_SERVICE_PARAMETER

Constructor Summary

ServiceProperties()

Method Summary

void	afterPropertiesSet()
String	getArtifactParameter()
String	getService() Represents the service the user is authenticating to.
String	getServiceParameter() Configures the Request parameter to look for when attempting to send a request to CAS.
boolean	isSendRenew() Indicates whether the renew parameter should be sent to the CAS login URL and CAS validation URL.
void	setArtifactParameter(String artifactParameter) Configures the Request Parameter to look for when attempting to see if a CAS ticket was sent from the server.
void	setSendRenew(boolean sendRenew)
void	setService(String service)
void	setServiceParameter(String serviceParameter)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CAS_ARTIFACT_PARAMETER

public static final String DEFAULT_CAS_ARTIFACT_PARAMETER

See Also:

Constant Field Values

DEFAULT_CAS_SERVICE_PARAMETER

public static final String DEFAULT_CAS_SERVICE_PARAMETER

See Also:

Constant Field Values

Constructor Detail

ServiceProperties

public ServiceProperties()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

getService

public final String getService()

Represents the service the user is authenticating to.

This service is the callback URL belonging to the local Spring Security System for Spring secured application. For example,

 https://www.mycompany.com/application/j_spring_cas_security_check
 

Returns:

the URL of the service the user is authenticating to

isSendRenew

public final boolean isSendRenew()

Indicates whether the renew parameter should be sent to the CAS login URL and CAS validation URL.

If true, it will force CAS to authenticate the user again (even if the user has previously authenticated). During ticket validation it will require the ticket was generated as a consequence of an explicit login. High security applications would probably set this to true. Defaults to false, providing automated single sign on.

Returns:

whether to send the renew parameter to CAS

setSendRenew

public final void setSendRenew(boolean sendRenew)

setService

public final void setService(String service)

getArtifactParameter

public final String getArtifactParameter()

setArtifactParameter

public final void setArtifactParameter(String artifactParameter)

Configures the Request Parameter to look for when attempting to see if a CAS ticket was sent from the server.

Parameters:

artifactParameter - the id to use. Default is "ticket".

getServiceParameter

public final String getServiceParameter()

Configures the Request parameter to look for when attempting to send a request to CAS.

Returns:

the service parameter to use. Default is "service".

setServiceParameter

public final void setServiceParameter(String serviceParameter)