org.apereo.cas.services

Class AbstractServicesManager

java.lang.Object

org.apereo.cas.services.AbstractServicesManager

All Implemented Interfaces:

ServicesManager

Direct Known Subclasses:

DefaultServicesManager, DomainServicesManager

public abstract class AbstractServicesManager
extends java.lang.Object
implements ServicesManager

This is AbstractServicesManager.

Since:

5.2.0

Constructor Summary

Constructors

Constructor and Description
AbstractServicesManager(ServiceRegistry serviceRegistry, org.springframework.context.ApplicationEventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
int	count() Return a count of loaded services by this manager.
RegisteredService	delete(long id) Delete the entry for this RegisteredService.
RegisteredService	delete(RegisteredService service) Delete the entry for this RegisteredService.
void	deleteAll() Delete all entries in the underlying storage service.
protected void	deleteInternal(RegisteredService service) Delete internal.
RegisteredService	findServiceBy(long id) Find a RegisteredService by matching with the supplied id.
java.util.Collection<RegisteredService>	findServiceBy(java.util.function.Predicate<RegisteredService> predicate) 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.
protected abstract java.util.Collection<RegisteredService>	getCandidateServicesToMatch(java.lang.String serviceId) Gets candidate services to match the service id.
protected java.time.LocalDateTime	getCurrentSystemTime() Gets current system time.
java.util.Collection<RegisteredService>	load() Load services that are provided by the DAO.
protected void	loadInternal() Load internal.
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.
RegisteredService	save(RegisteredService registeredService, boolean publishEvent) Register a service with CAS, or update an existing an entry.
protected void	saveInternal(RegisteredService service) Save internal.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apereo.cas.services.ServicesManager

getDomains, getServicesForDomain

Constructor Detail

AbstractServicesManager

public AbstractServicesManager(ServiceRegistry serviceRegistry,
                               org.springframework.context.ApplicationEventPublisher eventPublisher)

Method Detail

getAllServices

public java.util.Collection<RegisteredService> getAllServices()

Description copied from interface: ServicesManager

Retrieve the collection of all registered services. Services that are returned are valid, non-expired, etc.

Specified by:

getAllServices in interface ServicesManager

Returns:

the collection of all services.

findServiceBy

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

Description copied from interface: ServicesManager

Find a collection of services by type.

Specified by:

findServiceBy in interface ServicesManager

Parameters:

predicate - the clazz

Returns:

the collection of services that matches the supplied type

findServiceBy

public RegisteredService findServiceBy(java.lang.String serviceId)

Description copied from interface: ServicesManager

Find a RegisteredService by matching with the supplied service.

Specified by:

findServiceBy in interface ServicesManager

Parameters:

serviceId - the service to match with.

Returns:

the RegisteredService that matches the supplied service.

findServiceBy

public RegisteredService findServiceBy(Service service)

Description copied from interface: ServicesManager

Find a RegisteredService by matching with the supplied service.

Specified by:

findServiceBy in interface ServicesManager

Parameters:

service - the service to match with.

Returns:

the RegisteredService that matches the supplied service.

findServiceBy

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

Description copied from interface: ServicesManager

Find service by type.

Specified by:

findServiceBy in interface ServicesManager

Type Parameters:

T - the type parameter

Parameters:

serviceId - the service id

clazz - the clazz

Returns:

the t

findServiceBy

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

Description copied from interface: ServicesManager

Find service by type.

Specified by:

findServiceBy in interface ServicesManager

Type Parameters:

T - the type parameter

Parameters:

serviceId - the service id

clazz - the clazz

Returns:

the t

findServiceBy

public RegisteredService findServiceBy(long id)

Description copied from interface: ServicesManager

Find a RegisteredService by matching with the supplied id.

Specified by:

findServiceBy in interface ServicesManager

Parameters:

id - the id to match with.

Returns:

the RegisteredService that matches the supplied service.

count

public int count()

Description copied from interface: ServicesManager

Return a count of loaded services by this manager.

Specified by:

count in interface ServicesManager

Returns:

the count/size of registry.

matchesExistingService

public boolean matchesExistingService(Service service)

Description copied from interface: ServicesManager

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

Specified by:

matchesExistingService in interface ServicesManager

Parameters:

service - the service to check.

Returns:

true if it exists, false otherwise.

matchesExistingService

public boolean matchesExistingService(java.lang.String service)

Description copied from interface: ServicesManager

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

Specified by:

matchesExistingService in interface ServicesManager

Parameters:

service - the service to check.

Returns:

true if it exists, false otherwise.

delete

public RegisteredService delete(long id)

Description copied from interface: ServicesManager

Delete the entry for this RegisteredService.

Specified by:

delete in interface ServicesManager

Parameters:

id - the id of the registeredService to delete.

Returns:

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

delete

public RegisteredService delete(RegisteredService service)

Description copied from interface: ServicesManager

Delete the entry for this RegisteredService.

Specified by:

delete in interface ServicesManager

Parameters:

service - the registered service to delete.

Returns:

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

save

public RegisteredService save(RegisteredService registeredService)

Description copied from interface: ServicesManager

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

Specified by:

save in interface ServicesManager

Parameters:

registeredService - the RegisteredService to update or add.

Returns:

newly persisted RegisteredService instance

save

public RegisteredService save(RegisteredService registeredService,
                              boolean publishEvent)

Description copied from interface: ServicesManager

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

Specified by:

save in interface ServicesManager

Parameters:

registeredService - the RegisteredService to update or add.

publishEvent - whether events should be published to indicate the save operation.

Returns:

newly persisted RegisteredService instance

load

@Scheduled(initialDelayString="${cas.serviceRegistry.schedule.startDelay:20000}",
           fixedDelayString="${cas.serviceRegistry.schedule.repeatInterval:60000}")
 @PostConstruct
public java.util.Collection<RegisteredService> load()

Load services that are provided by the DAO.

Specified by:

load in interface ServicesManager

Returns:

the collection

deleteAll

public void deleteAll()

Description copied from interface: ServicesManager

Delete all entries in the underlying storage service.

Specified by:

deleteAll in interface ServicesManager

getCurrentSystemTime

protected java.time.LocalDateTime getCurrentSystemTime()

Gets current system time.

Returns:

the current system time

getCandidateServicesToMatch

protected abstract java.util.Collection<RegisteredService> getCandidateServicesToMatch(java.lang.String serviceId)

Gets candidate services to match the service id.

Parameters:

serviceId - the service id

Returns:

the candidate services to match

deleteInternal

protected void deleteInternal(RegisteredService service)

Delete internal.

Parameters:

service - the service

saveInternal

protected void saveInternal(RegisteredService service)

Save internal.

Parameters:

service - the service

loadInternal

protected void loadInternal()

Load internal.