public interface RegisteredService
extends java.lang.Cloneable, java.io.Serializable
| Modifier and Type | Field and Description |
|---|---|
static long |
INITIAL_IDENTIFIER_VALUE
Initial ID value of newly created (but not persisted) registered service.
|
| 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.
|
static final long INITIAL_IDENTIFIER_VALUE
RegisteredServiceProxyPolicy getProxyPolicy()
java.lang.String getServiceId()
long getId()
INITIAL_IDENTIFIER_VALUE.java.lang.String getName()
java.lang.String getTheme()
java.lang.String getDescription()
int getEvaluationOrder()
void setEvaluationOrder(int evaluationOrder)
evaluationOrder - the service evaluation orderRegisteredServiceUsernameAttributeProvider getUsernameAttributeProvider()
RegisteredServiceUsernameAttributeProviderjava.util.Set<java.lang.String> getRequiredHandlers()
RegisteredServiceAccessStrategy getAccessStrategy()
boolean matches(org.jasig.cas.authentication.principal.Service service)
Note, as of 3.1.2, matches are case insensitive.
service - the service to match.RegisteredService clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException - the clone not supported exceptionLogoutType getLogoutType()
RegisteredServiceAttributeReleasePolicy getAttributeReleasePolicy()
java.net.URL getLogo()
java.net.URL getLogoutUrl()
getServiceId() will be used
to handle logout invocations.RegisteredServicePublicKey getPublicKey()
java.util.Map<java.lang.String,RegisteredServiceProperty> getProperties()