org.jasig.cas.authentication.principal

Class AbstractWebApplicationService

java.lang.Object

org.jasig.cas.authentication.principal.AbstractWebApplicationService

All Implemented Interfaces:

Serializable, Principal, Service, SingleLogoutService, WebApplicationService

Direct Known Subclasses:

SimpleWebApplicationServiceImpl

public abstract class AbstractWebApplicationService
extends Object
implements SingleLogoutService

Abstract implementation of a WebApplicationService.

Since:

3.1

Author:

Scott Battaglia

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOGGER Logger instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWebApplicationService(String id, String originalUrl, String artifactId)

Method Summary

Methods

Modifier and Type	Method and Description
protected static String	cleanupUrl(String url)
boolean	equals(Object object)
String	getArtifactId() Retrieves the artifact supplied with the service.
Map<String,Object>	getAttributes()
String	getId()
String	getOriginalUrl() Return the original url provided (as service or targetService request parameter).
protected Principal	getPrincipal()
int	hashCode()
boolean	isLoggedOutAlready() Return if the service is already logged out.
boolean	matches(Service service)
void	setLoggedOutAlready(boolean loggedOutAlready) Set if the service is already logged out.
void	setPrincipal(Principal principal)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jasig.cas.authentication.principal.WebApplicationService

getResponse

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

Logger instance.

Constructor Detail

AbstractWebApplicationService

protected AbstractWebApplicationService(String id,
                             String originalUrl,
                             String artifactId)

Method Detail

toString

public final String toString()

Overrides:

toString in class Object

getId

public final String getId()

Specified by:

getId in interface Principal

Returns:

the unique id for the Principal

getArtifactId

public final String getArtifactId()

Description copied from interface: WebApplicationService

Retrieves the artifact supplied with the service. May be null.

Specified by:

getArtifactId in interface WebApplicationService

Returns:

the artifact if it exists, null otherwise.

getAttributes

public final Map<String,Object> getAttributes()

Specified by:

getAttributes in interface Principal

Returns:

the map of configured attributes for this principal

cleanupUrl

protected static String cleanupUrl(String url)

getOriginalUrl

public final String getOriginalUrl()

Return the original url provided (as service or targetService request parameter). Used to reconstruct the redirect url.

Specified by:

getOriginalUrl in interface WebApplicationService

Returns:

the original url provided.

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getPrincipal

protected Principal getPrincipal()

setPrincipal

public void setPrincipal(Principal principal)

Specified by:

setPrincipal in interface Service

matches

public boolean matches(Service service)

Specified by:

matches in interface Service

isLoggedOutAlready

public boolean isLoggedOutAlready()

Return if the service is already logged out.

Specified by:

isLoggedOutAlready in interface SingleLogoutService

Returns:

if the service is already logged out.

setLoggedOutAlready

public final void setLoggedOutAlready(boolean loggedOutAlready)

Set if the service is already logged out.

Specified by:

setLoggedOutAlready in interface SingleLogoutService

Parameters:

loggedOutAlready - if the service is already logged out.