org.jasig.cas.services

Interface ServicesManager

All Known Subinterfaces:

ReloadableServicesManager

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

Methods

Modifier and Type	Method and Description
RegisteredService	delete(long id) Delete the entry for this RegisteredService.
RegisteredService	findServiceBy(long id) Find a RegisteredService by matching with the supplied id.
RegisteredService	findServiceBy(org.jasig.cas.authentication.principal.Service service) Find a RegisteredService by matching with the supplied service.
java.util.Collection<RegisteredService>	getAllServices() Retrieve the collection of all registered services.
boolean	matchesExistingService(org.jasig.cas.authentication.principal.Service 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(org.jasig.cas.authentication.principal.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

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(org.jasig.cas.authentication.principal.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.