org.apereo.cas.services

Interface ServiceRegistry

All Known Subinterfaces:

ImmutableServiceRegistry, ResourceBasedServiceRegistry

All Known Implementing Classes:

AbstractResourceBasedServiceRegistry, AbstractServiceRegistry, CasServiceRegistryInitializationConfiguration.EmbeddedResourceBasedServiceRegistry, ChainingServiceRegistry, ConsentServiceRegistry, CosmosDbServiceRegistry, CouchbaseServiceRegistry, CouchDbServiceRegistry, DynamoDbServiceRegistry, ImmutableInMemoryServiceRegistry, InMemoryServiceRegistry, JpaServiceRegistry, JsonServiceRegistry, LdapServiceRegistry, MongoDbServiceRegistry, OAuth20ServiceRegistry, RedisServiceRegistry, RestfulServiceRegistry, SamlIdPServiceRegistry, WSFederationServiceRegistry, YamlServiceRegistry

public interface ServiceRegistry

Registry of all RegisteredServices.

Since:

3.1

Method Summary

Modifier and Type	Method and Description
boolean	delete(RegisteredService registeredService) Remove the service from the data store.
default RegisteredService	findServiceByExactServiceId(java.lang.String id) Find a service by an exact match of the service id.
default RegisteredService	findServiceByExactServiceName(java.lang.String name) Find a service by an exact match of the service name.
RegisteredService	findServiceById(long id) Find service by the numeric id.
RegisteredService	findServiceById(java.lang.String id) Find service by the service id.
java.lang.String	getName() Returns the friendly name of this registry.
java.util.List<RegisteredService>	load() Retrieve the services from the data store.
RegisteredService	save(RegisteredService registeredService) Persist the service in the data store.
default long	size() Return number of records held in this service registry.

Method Detail

save

RegisteredService save(RegisteredService registeredService)

Persist the service in the data store.

Parameters:

registeredService - the service to persist.

Returns:

the updated RegisteredService.

delete

boolean delete(RegisteredService registeredService)

Remove the service from the data store.

Parameters:

registeredService - the service to remove.

Returns:

true if it was removed, false otherwise.

load

java.util.List<RegisteredService> load()

Retrieve the services from the data store.

Returns:

the collection of services.

findServiceById

RegisteredService findServiceById(long id)

Find service by the numeric id.

Parameters:

id - the id

Returns:

the registered service

findServiceById

RegisteredService findServiceById(java.lang.String id)

Find service by the service id.

Parameters:

id - the id

Returns:

the registered service

findServiceByExactServiceId

default RegisteredService findServiceByExactServiceId(java.lang.String id)

Find a service by an exact match of the service id.

Parameters:

id - the id

Returns:

the registered service

findServiceByExactServiceName

default RegisteredService findServiceByExactServiceName(java.lang.String name)

Find a service by an exact match of the service name.

Parameters:

name - the name

Returns:

the registered service

size

default long size()

Return number of records held in this service registry. Provides Java 8 supported default implementation so that implementations needed this new functionality could override it and other implementations not caring for it could be left alone.

Returns:

number of registered services held by any particular implementation

Since:

5.0.0

getName

java.lang.String getName()

Returns the friendly name of this registry.

Returns:

the name.

Since:

5.2.0