org.jasig.cas.services

Interface RegisteredService

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

AbstractRegisteredService, RegexRegisteredService, RegisteredServiceImpl

public interface RegisteredService
extends Cloneable, Serializable

Interface for a service that can be registered by the Services Management interface.

Since:

3.1

Author:

Scott Battaglia

Field Summary

Fields

Modifier and Type	Field and Description
static long	INITIAL_IDENTIFIER_VALUE Initial ID value of newly created (but not persisted) registered service.

Method Summary

Methods

Modifier and Type	Method and Description
RegisteredService	clone()
List<String>	getAllowedAttributes() Returns the list of allowed attributes.
RegisteredServiceAttributeFilter	getAttributeFilter() An instance of the attribute filter that imposes validation rules over the attribute release policy.
String	getDescription() Returns the description of the service.
int	getEvaluationOrder() Gets the relative evaluation order of this service when determining matches.
long	getId() The numeric identifier for this service.
LogoutType	getLogoutType() Returns the logout type of the service.
String	getName() Returns the name of the service.
Set<String>	getRequiredHandlers() Gets the set of handler names that must successfully authenticate credentials in order to access the service.
String	getServiceId() The unique identifier for this service.
String	getTheme() Returns a short theme name.
String	getUsernameAttribute() Get the name of the attribute this service prefers to consume as username.
boolean	isAllowedToProxy() Is this application allowed to take part in the proxying capabilities of CAS?
boolean	isAnonymousAccess() Determines whether the service is allowed anonymous or privileged access to user information.
boolean	isEnabled() Is this application currently allowed to use CAS?
boolean	isIgnoreAttributes() Sets whether we should bother to read the attribute list or not.
boolean	isSsoEnabled() Does this application participate in the SSO session?
boolean	matches(Service service) Returns whether the service matches the registered service.
void	setEvaluationOrder(int evaluationOrder) Sets the relative evaluation order of this service when determining matches.

Field Detail

INITIAL_IDENTIFIER_VALUE

static final long INITIAL_IDENTIFIER_VALUE

Initial ID value of newly created (but not persisted) registered service.

See Also:

Constant Field Values

Method Detail

isEnabled

boolean isEnabled()

Is this application currently allowed to use CAS?

Returns:

true if it can use CAS, false otherwise.

isAnonymousAccess

boolean isAnonymousAccess()

Determines whether the service is allowed anonymous or privileged access to user information. Anonymous access should not return any identifying information such as user id.

Returns:

if we should use a pseudo random identifier instead of their real id

isIgnoreAttributes

boolean isIgnoreAttributes()

Sets whether we should bother to read the attribute list or not.

Returns:

true if we should read it, false otherwise.

getAllowedAttributes

List<String> getAllowedAttributes()

Returns the list of allowed attributes.

Returns:

the list of attributes

isAllowedToProxy

boolean isAllowedToProxy()

Is this application allowed to take part in the proxying capabilities of CAS?

Returns:

true if it can, false otherwise.

getServiceId

String getServiceId()

The unique identifier for this service.

Returns:

the unique identifier for this service.

getId

long getId()

The numeric identifier for this service. Implementations are expected to initialize the id with the value of INITIAL_IDENTIFIER_VALUE.

Returns:

the numeric identifier for this service.

getName

String getName()

Returns the name of the service.

Returns:

the name of the service.

getTheme

String getTheme()

Returns a short theme name. Services do not need to have unique theme names.

Returns:

the theme name associated with this service.

isSsoEnabled

boolean isSsoEnabled()

Does this application participate in the SSO session?

Returns:

true if it does, false otherwise.

getDescription

String getDescription()

Returns the description of the service.

Returns:

the description of the service.

getEvaluationOrder

int getEvaluationOrder()

Gets the relative evaluation order of this service when determining matches.

Returns:

Evaluation order relative to other registered services. Services with lower values will be evaluated for a match before others.

setEvaluationOrder

void setEvaluationOrder(int evaluationOrder)

Sets the relative evaluation order of this service when determining matches.

Parameters:

evaluationOrder - the service evaluation order

getUsernameAttribute

String getUsernameAttribute()

Get the name of the attribute this service prefers to consume as username.

Returns:

Either of the following values:

• String representing the name of the attribute to consume as username
• null indicating the default username

getRequiredHandlers

Set<String> getRequiredHandlers()

Gets the set of handler names that must successfully authenticate credentials in order to access the service. An empty set indicates that there are no requirements on particular authentication handlers; any will suffice.

Returns:

Non-null set of required handler names.

matches

boolean matches(Service service)

Returns whether the service matches the registered service.

Note, as of 3.1.2, matches are case insensitive.

Parameters:

service - the service to match.

Returns:

true if they match, false otherwise.

clone

RegisteredService clone()
                        throws CloneNotSupportedException

Throws:

CloneNotSupportedException

getAttributeFilter

RegisteredServiceAttributeFilter getAttributeFilter()

An instance of the attribute filter that imposes validation rules over the attribute release policy.

Returns:

An instance of an attribute filter for this service

getLogoutType

LogoutType getLogoutType()

Returns the logout type of the service.

Returns:

the logout type of the service.