org.springframework.security.cas.web.authentication

Class ServiceAuthenticationDetailsSource

java.lang.Object

org.springframework.security.cas.web.authentication.ServiceAuthenticationDetailsSource

All Implemented Interfaces:

Aware, ApplicationContextAware, AuthenticationDetailsSource<javax.servlet.http.HttpServletRequest,ServiceAuthenticationDetails>

public class ServiceAuthenticationDetailsSource
extends Object
implements AuthenticationDetailsSource<javax.servlet.http.HttpServletRequest,ServiceAuthenticationDetails>, ApplicationContextAware

The AuthenticationDetailsSource that is set on the CasAuthenticationFilter should return a value that implements ServiceAuthenticationDetails if the application needs to authenticate dynamic service urls. The ServiceAuthenticationDetailsSource#buildDetails(HttpServletRequest) creates a default ServiceAuthenticationDetails.

Constructor Summary

Constructors

Constructor and Description
ServiceAuthenticationDetailsSource() Deprecated. Use ServiceAuthenticationDetailsSource(ServiceProperties)
ServiceAuthenticationDetailsSource(ServiceProperties serviceProperties) Creates an implementation that uses the specified ServiceProperites and the default CAS artifactParameterName.
ServiceAuthenticationDetailsSource(ServiceProperties serviceProperties, String artifactParameterName) Creates an implementation that uses the specified artifactParameterName
ServiceAuthenticationDetailsSource(String artifactParameterName) Deprecated. Use ServiceAuthenticationDetailsSource(ServiceProperties,String)

Method Summary

Methods

Modifier and Type	Method and Description
ServiceAuthenticationDetails	buildDetails(javax.servlet.http.HttpServletRequest context) Called by a class when it wishes a new authentication details instance to be created.
void	setApplicationContext(ApplicationContext applicationContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceAuthenticationDetailsSource

@Deprecated
public ServiceAuthenticationDetailsSource()

Deprecated. Use ServiceAuthenticationDetailsSource(ServiceProperties)

Creates an implementation that uses the default CAS artifactParameterName.

ServiceAuthenticationDetailsSource

public ServiceAuthenticationDetailsSource(ServiceProperties serviceProperties)

Creates an implementation that uses the specified ServiceProperites and the default CAS artifactParameterName.

Parameters:

serviceProperties - The ServiceProperties to use to construct the serviceUrl.

ServiceAuthenticationDetailsSource

public ServiceAuthenticationDetailsSource(String artifactParameterName)

Deprecated. Use ServiceAuthenticationDetailsSource(ServiceProperties,String)

Creates an implementation that uses the specified artifactParameterName

Parameters:

artifactParameterName - the artifactParameterName that is removed from the current URL. The result becomes the service url. Cannot be null and cannot be an empty String.

ServiceAuthenticationDetailsSource

public ServiceAuthenticationDetailsSource(ServiceProperties serviceProperties,
                                  String artifactParameterName)

Creates an implementation that uses the specified artifactParameterName

Parameters:

serviceProperties - The ServiceProperties to use to construct the serviceUrl.

artifactParameterName - the artifactParameterName that is removed from the current URL. The result becomes the service url. Cannot be null and cannot be an empty String.

Method Detail

buildDetails

public ServiceAuthenticationDetails buildDetails(javax.servlet.http.HttpServletRequest context)

Description copied from interface: AuthenticationDetailsSource

Called by a class when it wishes a new authentication details instance to be created.

Specified by:

buildDetails in interface AuthenticationDetailsSource<javax.servlet.http.HttpServletRequest,ServiceAuthenticationDetails>

Parameters:

context - the HttpServletRequest object.

Returns:

the ServiceAuthenticationDetails containing information about the current request

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException