Package org.apereo.cas.services

This package is contains classes related to the restriction of CAS usage to a particular set of services.

See: Description

Interface Summary

Interface	Description
ImmutableServiceRegistry	This is ImmutableServiceRegistry.
MultifactorAuthenticationProvider	This is MultifactorAuthenticationProvider that describes an external authentication entity/provider matched against a registered service.
MultifactorAuthenticationProviderFactory<T extends MultifactorAuthenticationProvider,P extends BaseMultifactorProviderProperties>	Interface for provider a factory that can create a MultifactorAuthenticationProvider.
MultifactorAuthenticationProviderResolver	This is MultifactorAuthenticationProviderResolver.
MultifactorAuthenticationProviderSelector	This is MultifactorAuthenticationProviderSelector that decides how to resolve a single provider from a collection available to a registered service.
RegisteredService	Interface for a service that can be registered by the Services Management interface.
RegisteredServiceAccessStrategy	This is RegisteredServiceAccessStrategy that can decide if a service is recognized and authorized to participate in the CAS protocol flow during authentication/validation events.
RegisteredServiceAttributeFilter	Defines the general contract of the attribute release policy for a registered service.
RegisteredServiceAttributeReleasePolicy	The release policy that decides how attributes are to be released for a given service.
RegisteredServiceCipherExecutor	Defines how to encrypt data based on registered service's public key, etc.
RegisteredServiceConsentPolicy	This is RegisteredServiceConsentPolicy.
RegisteredServiceContact	The interface Registered service contact.
RegisteredServiceDelegatedAuthenticationPolicy	This is RegisteredServiceDelegatedAuthenticationPolicy.
RegisteredServiceExpirationPolicy	Expiration policy that dictates how long should this service be kept alive.
RegisteredServiceMultifactorPolicy	This is RegisteredServiceMultifactorPolicy that describes how a service should handle authentication requests.
RegisteredServiceProperty	The RegisteredServiceProperty defines a single custom property that is associated with a service.
RegisteredServiceProxyPolicy	Defines the proxying policy for a registered service.
RegisteredServicePublicKey	Represents a public key for a CAS registered service.
RegisteredServiceUsernameAttributeProvider	Strategy interface to define what username attribute should be returned for a given registered service.
ResourceBasedServiceRegistry	This is ResourceBasedServiceRegistry, which describes operations relevant to a service registry that is backed by file-system resources.
ServiceRegistry	Registry of all RegisteredServices.
ServiceRegistryExecutionPlan	This is ServiceRegistryExecutionPlan.
ServiceRegistryExecutionPlanConfigurer	This is ServiceRegistryExecutionPlanConfigurer.
ServicesManager	Manages the storage, retrieval, and matching of Services wishing to use CAS and services that have been registered with CAS.
VariegatedMultifactorAuthenticationProvider	Deprecated as of 5.3.4, use MultifactorAuthenticationProviderFactory to provide multiple instances of multifactor authentication providers.

Class Summary

Class	Description
AbstractRegisteredService	Base class for mutable, persistable registered services.
AbstractRegisteredServiceAttributeReleasePolicy	Abstract release policy for attributes, provides common shared settings such as loggers and attribute filter config.
AbstractServiceRegistry	This is AbstractServiceRegistry, that acts as the base parent class for all registry implementations, capturing common ops.
AbstractServicesManager	This is AbstractServicesManager.
AnonymousRegisteredServiceUsernameAttributeProvider	Generates a persistent id as username for anonymous service access.
BaseDistributedCacheManager<K extends java.io.Serializable,V extends DistributedCacheObject>	This is BaseDistributedCacheManager.
BaseRegisteredServiceUsernameAttributeProvider	This is BaseRegisteredServiceUsernameAttributeProvider.
BaseSurrogateRegisteredServiceAccessStrategy	This is BaseSurrogateRegisteredServiceAccessStrategy.
CasServiceRegistryInitializerConfigurationEventListener	This is CasServiceRegistryInitializerConfigurationEventListener.
CasServicesRegistryStreamingEventListener	This is CasServicesRegistryStreamingEventListener.
ChainingAttributeReleasePolicy	This is ChainingAttributeReleasePolicy.
ChainingServiceRegistry	This is ChainingServiceRegistry.
CosmosDbServiceRegistry	This is CosmosDbServiceRegistry.
CouchbaseServiceRegistry	This is CouchbaseServiceRegistry.
CouchDbServiceRegistry	This is CouchDbServiceRegistry.
DefaultRegisteredServiceAccessStrategy	This is DefaultRegisteredServiceAccessStrategy that allows the following rules: A service may be disallowed to use CAS for authentication A service may be disallowed to take part in CAS single sign-on such that presentation of credentials would always be required. A service may be prohibited from receiving a service ticket if the existing principal attributes don't contain the required attributes that otherwise grant access to the service.
DefaultRegisteredServiceContact
DefaultRegisteredServiceDelegatedAuthenticationPolicy	This is DefaultRegisteredServiceDelegatedAuthenticationPolicy.
DefaultRegisteredServiceExpirationPolicy	This is DefaultRegisteredServiceExpirationPolicy.
DefaultRegisteredServiceMultifactorPolicy	This is DefaultRegisteredServiceMultifactorPolicy.
DefaultRegisteredServiceProperty	The DefaultRegisteredServiceProperty represents a single property associated with a registered service.
DefaultRegisteredServiceUsernameProvider	Resolves the username for the service to be the default principal id.
DefaultServiceRegistryExecutionPlan	This is DefaultServiceRegistryExecutionPlan.
DefaultServicesManager	Default implementation of the ServicesManager interface.
DenyAllAttributeReleasePolicy	A deny rule to refuse all service from receiving attributes, whether default or not.
DomainServicesManager	Implementation of the ServicesManager interface that organizes services by domain into a hash for quicker lookup.
DynamoDbServiceRegistry	This is DynamoDbServiceRegistry.
DynamoDbServiceRegistryFacilitator	This is DynamoDbServiceRegistryFacilitator.
GroovyRegisteredServiceAccessStrategy	This is GroovyRegisteredServiceAccessStrategy.
GroovyRegisteredServiceMultifactorPolicy	This is GroovyRegisteredServiceMultifactorPolicy.
GroovyRegisteredServiceUsernameProvider	Resolves the username for the service to be the default principal id.
GroovyScriptAttributeReleasePolicy	This is GroovyScriptAttributeReleasePolicy that attempts to release attributes based on the execution result of an external groovy script.
GroovySurrogateRegisteredServiceAccessStrategy	This is GroovySurrogateRegisteredServiceAccessStrategy.
ImmutableInMemoryServiceRegistry	This is ImmutableInMemoryServiceRegistry.
InMemoryServiceRegistry	Default In Memory Service Registry Dao for test/demonstration purposes.
JpaServiceRegistry	Implementation of the ServiceRegistry based on JPA.
JsonServiceRegistry	Implementation of ServiceRegistry that reads services definition from JSON configuration file at the Spring Application Context initialization time.
MongoDbServiceRegistry	Implementation of ServiceRegistry that uses a MongoDb repository as the backend persistence mechanism.
NoOpDistributedCacheManager	This is NoOpDistributedCacheManager.
OidcRegisteredService	This is OidcRegisteredService.
PairwiseOidcRegisteredServiceUsernameAttributeProvider	This is PairwiseOidcRegisteredServiceUsernameAttributeProvider.
PrincipalAttributeRegisteredServiceUsernameProvider	Determines the username for this registered service based on a principal attribute.
RefuseRegisteredServiceProxyPolicy	A proxy policy that disallows proxying.
RegexMatchingRegisteredServiceProxyPolicy	A proxy policy that only allows proxying to pgt urls that match the specified regex pattern.
RegexRegisteredService	Mutable registered service that uses Java regular expressions for service matching.
RegisteredServiceAccessStrategyAuditableEnforcer	This is RegisteredServiceAccessStrategyAuditableEnforcer.
RegisteredServiceAccessStrategyUtils	This is RegisteredServiceAccessStrategyUtils that encapsulates common operations relevant to registered service access strategy and authorizations.
RegisteredServiceHazelcastDistributedCacheManager	This is RegisteredServiceHazelcastDistributedCacheManager.
RegisteredServicePublicKeyImpl	Represents a public key for a CAS registered service.
RegisteredServicesEventListener	This is RegisteredServicesEventListener.
RemoteEndpointServiceAccessStrategy	This is RemoteEndpointServiceAccessStrategy that reaches out to a remote endpoint, passing the CAS principal id to determine if access is allowed.
RestfulServiceRegistry	This is RestfulServiceRegistry.
ReturnAllAttributeReleasePolicy	Return all attributes for the service, regardless of service settings.
ReturnAllowedAttributeReleasePolicy	Return only the collection of allowed attributes out of what's resolved for the principal.
ReturnMappedAttributeReleasePolicy	Return a collection of allowed attributes for the principal, but additionally, offers the ability to rename attributes on a per-service level.
ReturnRestfulAttributeReleasePolicy	Return a collection of allowed attributes for the principal based on an external REST endpoint.
ScriptedRegisteredServiceAttributeReleasePolicy	This is ScriptedRegisteredServiceAttributeReleasePolicy.
ScriptedRegisteredServiceUsernameProvider	This is ScriptedRegisteredServiceUsernameProvider.
ServiceContext	Simple container for holding a service principal and its corresponding registered service.
ServiceRegistryInitializer	Initializes a given service registry data store with available JSON service definitions if necessary (based on configuration flag).
SurrogateRegisteredServiceAccessStrategy	This is SurrogateRegisteredServiceAccessStrategy.
TimeBasedRegisteredServiceAccessStrategy	The TimeBasedRegisteredServiceAccessStrategy is responsible for enforcing CAS authorization strategy based on a configured start/end time.
YamlServiceRegistry	Implementation of ServiceRegistry that reads services definition from YAML configuration file at the Spring Application Context initialization time.

Enum Summary

Enum	Description
OidcSubjectTypes	This is OidcSubjectTypes.
RegisteredService.LogoutType	The logout type.
RegisteredServiceMultifactorPolicy.FailureModes	The enum Failure modes.
RegisteredServiceProperty.RegisteredServiceProperties	Collection of supported properties that control various functionality in CAS.

Exception Summary

Exception	Description
UnauthorizedProxyingException	Exception thrown when a service attempts to proxy when it is not allowed to.
UnauthorizedServiceException	Exception that is thrown when an Unauthorized Service attempts to use CAS.
UnauthorizedServiceForPrincipalException	This is UnauthorizedServiceForPrincipalException thrown when an attribute is missing from principal attribute release policy that would otherwise grant access to the service that is requesting authentication.
UnauthorizedSsoServiceException	Exception thrown when a service attempts to use SSO when it should not be allowed to.

Package org.apereo.cas.services Description

This package is contains classes related to the restriction of CAS usage to a particular set of services. This is accomplished via a combination of registries and interceptors.

The ServiceRegistry, with its default implementation of DefaultServiceRegistry contains the list of RegisteredServices allowed to access CAS. This list is periodically refreshed via the ServiceRegistryReloader.

CAS itself is protected by a group of interceptors found in the subpackage advice.

Since:

3.0