org.jasig.cas.services

Interface RegisteredService

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable

public interface RegisteredService
extends java.lang.Cloneable, java.io.Serializable

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

Since:

3.1

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() Clone this service.
RegisteredServiceAccessStrategy	getAccessStrategy() Gets the access strategy that decides whether this registered service is able to proceed with authentication requests.
RegisteredServiceAttributeReleasePolicy	getAttributeReleasePolicy() Gets the attribute filtering policy to determine how attributes are to be filtered and released for this service.
java.lang.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.
java.net.URL	getLogo() Gets the logo image associated with this service.
LogoutType	getLogoutType() Returns the logout type of the service.
java.net.URL	getLogoutUrl() Identifies the logout url that that will be invoked upon sending single-logout callback notifications.
java.lang.String	getName() Returns the name of the service.
java.util.Map<java.lang.String,RegisteredServiceProperty>	getProperties() Describes extra metadata about the service; custom fields that could be used by submodules implementing additional behavior on a per-service basis.
RegisteredServiceProxyPolicy	getProxyPolicy() Get the proxy policy rules for this service.
RegisteredServicePublicKey	getPublicKey() Gets the public key associated with this service that is used to authorize the request by encrypting certain elements and attributes in the CAS validation protocol response, such as the PGT.
java.util.Set<java.lang.String>	getRequiredHandlers() Gets the set of handler names that must successfully authenticate credentials in order to access the service.
java.lang.String	getServiceId() The unique identifier for this service.
java.lang.String	getTheme() Returns a short theme name.
RegisteredServiceUsernameAttributeProvider	getUsernameAttributeProvider() Get the name of the attribute this service prefers to consume as username.
boolean	matches(org.jasig.cas.authentication.principal.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

getProxyPolicy

RegisteredServiceProxyPolicy getProxyPolicy()

Get the proxy policy rules for this service.

Returns:

the proxy policy

getServiceId

java.lang.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

java.lang.String getName()

Returns the name of the service.

Returns:

the name of the service.

getTheme

java.lang.String getTheme()

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

Returns:

the theme name associated with this service.

getDescription

java.lang.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

getUsernameAttributeProvider

RegisteredServiceUsernameAttributeProvider getUsernameAttributeProvider()

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

Returns:

an instance of RegisteredServiceUsernameAttributeProvider

getRequiredHandlers

java.util.Set<java.lang.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.

getAccessStrategy

RegisteredServiceAccessStrategy getAccessStrategy()

Gets the access strategy that decides whether this registered service is able to proceed with authentication requests.

Returns:

the access strategy

matches

boolean matches(org.jasig.cas.authentication.principal.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 java.lang.CloneNotSupportedException

Clone this service.

Returns:

the registered service

Throws:

java.lang.CloneNotSupportedException - the clone not supported exception

getLogoutType

LogoutType getLogoutType()

Returns the logout type of the service.

Returns:

the logout type of the service.

getAttributeReleasePolicy

RegisteredServiceAttributeReleasePolicy getAttributeReleasePolicy()

Gets the attribute filtering policy to determine how attributes are to be filtered and released for this service.

Returns:

the attribute release policy

getLogo

java.net.URL getLogo()

Gets the logo image associated with this service. The image mostly is served on the user interface to identify this requesting service during authentication.

Returns:

URL of the image

Since:

4.1

getLogoutUrl

java.net.URL getLogoutUrl()

Identifies the logout url that that will be invoked upon sending single-logout callback notifications. This is an optional setting. When undefined, the service url as is defined by getServiceId() will be used to handle logout invocations.

Returns:

the logout url for this service

Since:

4.1

getPublicKey

RegisteredServicePublicKey getPublicKey()

Gets the public key associated with this service that is used to authorize the request by encrypting certain elements and attributes in the CAS validation protocol response, such as the PGT.

Returns:

the public key instance used to authorize the request

Since:

4.1

getProperties

java.util.Map<java.lang.String,RegisteredServiceProperty> getProperties()

Describes extra metadata about the service; custom fields that could be used by submodules implementing additional behavior on a per-service basis.

Returns:

map of custom metadata.

Since:

4.2