@Entity public abstract class AbstractRegisteredService extends Object implements RegisteredService, Comparable<RegisteredService>, Serializable
| Modifier and Type | Field and Description |
|---|---|
protected String |
serviceId
The unique identifier for this service.
|
INITIAL_IDENTIFIER_VALUE| Constructor and Description |
|---|
AbstractRegisteredService() |
| Modifier and Type | Method and Description |
|---|---|
RegisteredService |
clone() |
int |
compareTo(RegisteredService other)
Compares this instance with the
other registered service based on
evaluation order, name. |
void |
copyFrom(RegisteredService source)
Copies the properties of the source service into this instance.
|
boolean |
equals(Object o) |
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.
|
int |
hashCode() |
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?
|
protected abstract AbstractRegisteredService |
newInstance() |
void |
setAllowedAttributes(List<String> allowedAttributes) |
void |
setAllowedToProxy(boolean allowedToProxy) |
void |
setAnonymousAccess(boolean anonymousAccess) |
void |
setAttributeFilter(RegisteredServiceAttributeFilter filter) |
void |
setDescription(String description) |
void |
setEnabled(boolean enabled) |
void |
setEvaluationOrder(int evaluationOrder)
Sets the relative evaluation order of this service when determining
matches.
|
void |
setId(long id) |
void |
setIgnoreAttributes(boolean ignoreAttributes) |
void |
setLogoutType(LogoutType logoutType)
Set the logout type of the service.
|
void |
setName(String name) |
void |
setRequiredHandlers(Set<String> handlers) |
abstract void |
setServiceId(String id) |
void |
setSsoEnabled(boolean ssoEnabled) |
void |
setTheme(String theme) |
void |
setUsernameAttribute(String username)
Sets the name of the user attribute to use as the username when providing usernames to this registered service.
|
String |
toString() |
finalize, getClass, notify, notifyAll, wait, wait, waitmatchesprotected String serviceId
public boolean isAnonymousAccess()
RegisteredServiceisAnonymousAccess in interface RegisteredServicepublic void setAnonymousAccess(boolean anonymousAccess)
public List<String> getAllowedAttributes()
RegisteredServicegetAllowedAttributes in interface RegisteredServicepublic long getId()
RegisteredServiceRegisteredService.INITIAL_IDENTIFIER_VALUE.getId in interface RegisteredServicepublic String getDescription()
RegisteredServicegetDescription in interface RegisteredServicepublic String getServiceId()
RegisteredServicegetServiceId in interface RegisteredServicepublic String getName()
RegisteredServicegetName in interface RegisteredServicepublic String getTheme()
RegisteredServicegetTheme in interface RegisteredServicepublic boolean isAllowedToProxy()
RegisteredServiceisAllowedToProxy in interface RegisteredServicepublic boolean isEnabled()
RegisteredServiceisEnabled in interface RegisteredServicepublic boolean isSsoEnabled()
RegisteredServiceisSsoEnabled in interface RegisteredServicepublic void setAllowedToProxy(boolean allowedToProxy)
public void setDescription(String description)
public void setEnabled(boolean enabled)
public abstract void setServiceId(String id)
public void setId(long id)
public void setName(String name)
public void setSsoEnabled(boolean ssoEnabled)
public void setTheme(String theme)
public boolean isIgnoreAttributes()
RegisteredServiceisIgnoreAttributes in interface RegisteredServicepublic void setIgnoreAttributes(boolean ignoreAttributes)
public void setEvaluationOrder(int evaluationOrder)
RegisteredServicesetEvaluationOrder in interface RegisteredServiceevaluationOrder - the service evaluation orderpublic int getEvaluationOrder()
RegisteredServicegetEvaluationOrder in interface RegisteredServicepublic String getUsernameAttribute()
RegisteredServicegetUsernameAttribute in interface RegisteredServiceString representing the name of the attribute to consume as usernamenull indicating the default usernamepublic void setUsernameAttribute(String username)
Note: The username attribute will have no affect on services that are marked for anonymous access.
username - attribute to release for this service that may be one of the following values:
null to enforce default CAS behaviorisAnonymousAccess()public final LogoutType getLogoutType()
getLogoutType in interface RegisteredServicepublic final void setLogoutType(LogoutType logoutType)
logoutType - the logout type of the service.public RegisteredService clone() throws CloneNotSupportedException
clone in interface RegisteredServiceclone in class ObjectCloneNotSupportedExceptionpublic void copyFrom(RegisteredService source)
source - Source service from which to copy properties.public int compareTo(RegisteredService other)
other registered service based on
evaluation order, name. The name comparison is case insensitive.compareTo in interface Comparable<RegisteredService>getEvaluationOrder()protected abstract AbstractRegisteredService newInstance()
public final void setAttributeFilter(RegisteredServiceAttributeFilter filter)
public RegisteredServiceAttributeFilter getAttributeFilter()
RegisteredServicegetAttributeFilter in interface RegisteredServicepublic Set<String> getRequiredHandlers()
RegisteredServicegetRequiredHandlers in interface RegisteredServiceCopyright © 2004-2014 Jasig. All Rights Reserved.