org.apereo.cas.services

Interface ServicesManager

All Known Implementing Classes:

DefaultServicesManager

public interface ServicesManager

Manages the storage, retrieval, and matching of Services wishing to use CAS and services that have been registered with CAS.

Since:

3.1

Method Summary

Modifier and Type	Method and Description
default int	count() Return a count of loaded services by this manager.
RegisteredService	delete(long id) Delete the entry for this RegisteredService.
RegisteredService	findServiceBy(long id) Find a RegisteredService by matching with the supplied id.
java.util.Collection<RegisteredService>	findServiceBy(java.util.function.Predicate<RegisteredService> clazz) Find a collection of services by type.
RegisteredService	findServiceBy(Service service) Find a RegisteredService by matching with the supplied service.
<T extends RegisteredService> T	findServiceBy(Service serviceId, java.lang.Class<T> clazz) Find service by type.
RegisteredService	findServiceBy(java.lang.String serviceId) Find a RegisteredService by matching with the supplied service.
<T extends RegisteredService> T	findServiceBy(java.lang.String serviceId, java.lang.Class<T> clazz) Find service by type.
java.util.Collection<RegisteredService>	getAllServices() Retrieve the collection of all registered services.
void	load() Inform the ServicesManager to reload its list of services if its cached them.
boolean	matchesExistingService(Service service) Convenience method to let one know if a service exists in the data store.
boolean	matchesExistingService(java.lang.String service) Convenience method to let one know if a service exists in the data store.
RegisteredService	save(RegisteredService registeredService) Register a service with CAS, or update an existing an entry.

Method Detail

save

RegisteredService save(RegisteredService registeredService)

Register a service with CAS, or update an existing an entry.

Parameters:

registeredService - the RegisteredService to update or add.

Returns:

newly persisted RegisteredService instance

delete

RegisteredService delete(long id)

Delete the entry for this RegisteredService.

Parameters:

id - the id of the registeredService to delete.

Returns:

the registered service that was deleted, null if there was none.

findServiceBy

RegisteredService findServiceBy(java.lang.String serviceId)

Find a RegisteredService by matching with the supplied service.

Parameters:

serviceId - the service to match with.

Returns:

the RegisteredService that matches the supplied service.

findServiceBy

RegisteredService findServiceBy(Service service)

Find a RegisteredService by matching with the supplied service.

Parameters:

service - the service to match with.

Returns:

the RegisteredService that matches the supplied service.

findServiceBy

java.util.Collection<RegisteredService> findServiceBy(java.util.function.Predicate<RegisteredService> clazz)

Find a collection of services by type.

Parameters:

clazz - the clazz

Returns:

the collection of services that matches the supplied type

findServiceBy

<T extends RegisteredService> T findServiceBy(Service serviceId,
                                              java.lang.Class<T> clazz)

Find service by type.

Type Parameters:

T - the type parameter

Parameters:

serviceId - the service id

clazz - the clazz

Returns:

the t

findServiceBy

<T extends RegisteredService> T findServiceBy(java.lang.String serviceId,
                                              java.lang.Class<T> clazz)

Find service by type.

Type Parameters:

T - the type parameter

Parameters:

serviceId - the service id

clazz - the clazz

Returns:

the t

findServiceBy

RegisteredService findServiceBy(long id)

Find a RegisteredService by matching with the supplied id.

Parameters:

id - the id to match with.

Returns:

the RegisteredService that matches the supplied service.

getAllServices

java.util.Collection<RegisteredService> getAllServices()

Retrieve the collection of all registered services.

Returns:

the collection of all services.

matchesExistingService

boolean matchesExistingService(Service service)

Convenience method to let one know if a service exists in the data store.

Parameters:

service - the service to check.

Returns:

true if it exists, false otherwise.

matchesExistingService

boolean matchesExistingService(java.lang.String service)

Convenience method to let one know if a service exists in the data store.

Parameters:

service - the service to check.

Returns:

true if it exists, false otherwise.

load

void load()

Inform the ServicesManager to reload its list of services if its cached them. Note that this is a suggestion and that ServicesManagers are free to reload whenever they want.

count

default int count()

Return a count of loaded services by this manager.

Returns:

the count/size of registry.