org.jasig.cas.services
Interface ServicesManager

All Known Subinterfaces:

ReloadableServicesManager

All Known Implementing Classes:

DefaultServicesManagerImpl

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

Version:

$Revision: 42053 $ $Date: 2007-06-10 09:17:55 -0400 (Sun, 10 Jun 2007) $

Author:

Scott Battaglia

Method Summary

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(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(Service service) Convenience method to let one know if a service exists in the data store.
void	save(RegisteredService registeredService) Register a service with CAS, or update an existing an entry.

Method Detail

save

void save(RegisteredService registeredService)

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

Parameters:

registeredService - the RegisteredService to update or add.

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(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(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.