org.apereo.cas.services.resource

Class AbstractResourceBasedServiceRegistry

java.lang.Object

org.apereo.cas.services.AbstractServiceRegistry

org.apereo.cas.services.resource.AbstractResourceBasedServiceRegistry

All Implemented Interfaces:

ResourceBasedServiceRegistry, ServiceRegistry

Direct Known Subclasses:

CasServiceRegistryInitializationConfiguration.EmbeddedResourceBasedServiceRegistry, JsonServiceRegistry, YamlServiceRegistry

public abstract class AbstractResourceBasedServiceRegistry
extends AbstractServiceRegistry
implements ResourceBasedServiceRegistry

This is AbstractResourceBasedServiceRegistry.

Since:

5.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.file.Path	serviceRegistryDirectory The Service registry directory.

Constructor Summary

Constructors

Constructor and Description
AbstractResourceBasedServiceRegistry(java.nio.file.Path configDirectory, java.util.Collection<StringSerializer<RegisteredService>> serializers, boolean enableWatcher, org.springframework.context.ApplicationEventPublisher eventPublisher, RegisteredServiceReplicationStrategy registeredServiceReplicationStrategy, RegisteredServiceResourceNamingStrategy resourceNamingStrategy) Instantiates a new Abstract resource based service registry dao.
AbstractResourceBasedServiceRegistry(java.nio.file.Path configDirectory, StringSerializer<RegisteredService> serializer, boolean enableWatcher, org.springframework.context.ApplicationEventPublisher eventPublisher, RegisteredServiceReplicationStrategy registeredServiceReplicationStrategy, RegisteredServiceResourceNamingStrategy resourceNamingStrategy) Instantiates a new service registry dao.
AbstractResourceBasedServiceRegistry(org.springframework.core.io.Resource configDirectory, java.util.Collection<StringSerializer<RegisteredService>> serializers, org.springframework.context.ApplicationEventPublisher eventPublisher)
AbstractResourceBasedServiceRegistry(org.springframework.core.io.Resource configDirectory, java.util.Collection<StringSerializer<RegisteredService>> serializers, boolean enableWatcher, org.springframework.context.ApplicationEventPublisher eventPublisher, RegisteredServiceReplicationStrategy registeredServiceReplicationStrategy, RegisteredServiceResourceNamingStrategy resourceNamingStrategy) Instantiates a new Abstract resource based service registry dao.

Method Summary

Modifier and Type	Method and Description
boolean	delete(RegisteredService service) Remove the service from the data store.
void	destroy() Destroy the watch service thread.
RegisteredService	findServiceById(long id) Find service by the numeric id.
RegisteredService	findServiceById(java.lang.String id) Find service by the service id.
protected abstract java.lang.String	getExtension() Gets extension associated with files in the given resource directory.
protected java.io.File	getRegisteredServiceFileName(RegisteredService service) Creates a file for a registered service.
protected RegisteredService	getRegisteredServiceFromFile(java.io.File file) Gets registered service from file.
java.util.List<RegisteredService>	load() Retrieve the services from the data store.
java.util.Collection<RegisteredService>	load(java.io.File file) Load registered service from file.
protected void	removeRegisteredService(RegisteredService service) Remove registered service.
RegisteredService	save(RegisteredService service) Persist the service in the data store.
long	size() Return number of records held in this service registry.
void	update(RegisteredService service) Update a single service instance.

Methods inherited from class org.apereo.cas.services.AbstractServiceRegistry

getName, publishEvent

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

findServiceByExactServiceId, findServiceByExactServiceName, getName

Field Detail

serviceRegistryDirectory

protected java.nio.file.Path serviceRegistryDirectory

The Service registry directory.

Constructor Detail

AbstractResourceBasedServiceRegistry

public AbstractResourceBasedServiceRegistry(org.springframework.core.io.Resource configDirectory,
                                            java.util.Collection<StringSerializer<RegisteredService>> serializers,
                                            org.springframework.context.ApplicationEventPublisher eventPublisher)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

AbstractResourceBasedServiceRegistry

public AbstractResourceBasedServiceRegistry(java.nio.file.Path configDirectory,
                                            StringSerializer<RegisteredService> serializer,
                                            boolean enableWatcher,
                                            org.springframework.context.ApplicationEventPublisher eventPublisher,
                                            RegisteredServiceReplicationStrategy registeredServiceReplicationStrategy,
                                            RegisteredServiceResourceNamingStrategy resourceNamingStrategy)

Instantiates a new service registry dao.

Parameters:

configDirectory - the config directory

serializer - the registered service json serializer

enableWatcher - enable watcher thread

eventPublisher - the event publisher

registeredServiceReplicationStrategy - the registered service replication strategy

resourceNamingStrategy - the registered service naming strategy

AbstractResourceBasedServiceRegistry

public AbstractResourceBasedServiceRegistry(java.nio.file.Path configDirectory,
                                            java.util.Collection<StringSerializer<RegisteredService>> serializers,
                                            boolean enableWatcher,
                                            org.springframework.context.ApplicationEventPublisher eventPublisher,
                                            RegisteredServiceReplicationStrategy registeredServiceReplicationStrategy,
                                            RegisteredServiceResourceNamingStrategy resourceNamingStrategy)

Instantiates a new Abstract resource based service registry dao.

Parameters:

configDirectory - the config directory

serializers - the serializers

enableWatcher - the enable watcher

eventPublisher - the event publisher

registeredServiceReplicationStrategy - the registered service replication strategy

resourceNamingStrategy - the registered service naming strategy

AbstractResourceBasedServiceRegistry

public AbstractResourceBasedServiceRegistry(org.springframework.core.io.Resource configDirectory,
                                            java.util.Collection<StringSerializer<RegisteredService>> serializers,
                                            boolean enableWatcher,
                                            org.springframework.context.ApplicationEventPublisher eventPublisher,
                                            RegisteredServiceReplicationStrategy registeredServiceReplicationStrategy,
                                            RegisteredServiceResourceNamingStrategy resourceNamingStrategy)
                                     throws java.lang.Exception

Instantiates a new Abstract resource based service registry dao.

Parameters:

configDirectory - the config directory

serializers - the serializers

enableWatcher - the enable watcher

eventPublisher - the event publisher

registeredServiceReplicationStrategy - the registered service replication strategy

resourceNamingStrategy - the registered service naming strategy

Throws:

java.lang.Exception - the exception

Method Detail

destroy

@PreDestroy
public void destroy()

Destroy the watch service thread.

size

public long size()

Description copied from interface: ServiceRegistry

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.

Specified by:

size in interface ServiceRegistry

Returns:

number of registered services held by any particular implementation

findServiceById

public RegisteredService findServiceById(long id)

Description copied from interface: ServiceRegistry

Find service by the numeric id.

Specified by:

findServiceById in interface ServiceRegistry

Parameters:

id - the id

Returns:

the registered service

findServiceById

public RegisteredService findServiceById(java.lang.String id)

Description copied from interface: ServiceRegistry

Find service by the service id.

Specified by:

findServiceById in interface ServiceRegistry

Parameters:

id - the id

Returns:

the registered service

delete

public boolean delete(RegisteredService service)

Description copied from interface: ServiceRegistry

Remove the service from the data store.

Specified by:

delete in interface ServiceRegistry

Parameters:

service - the service to remove.

Returns:

true if it was removed, false otherwise.

removeRegisteredService

protected void removeRegisteredService(RegisteredService service)

Remove registered service.

Parameters:

service - the service

load

public java.util.List<RegisteredService> load()

Description copied from interface: ServiceRegistry

Retrieve the services from the data store.

Specified by:

load in interface ServiceRegistry

Returns:

the collection of services.

load

public java.util.Collection<RegisteredService> load(java.io.File file)

Load registered service from file.

Specified by:

load in interface ResourceBasedServiceRegistry

Parameters:

file - the file

Returns:

the registered service, or null if file cannot be read, is not found, is empty or parsing error occurs.

save

public RegisteredService save(RegisteredService service)

Description copied from interface: ServiceRegistry

Persist the service in the data store.

Specified by:

save in interface ServiceRegistry

Parameters:

service - the service to persist.

Returns:

the updated RegisteredService.

update

public void update(RegisteredService service)

Description copied from interface: ResourceBasedServiceRegistry

Update a single service instance.

Specified by:

update in interface ResourceBasedServiceRegistry

Parameters:

service - the service

getRegisteredServiceFromFile

protected RegisteredService getRegisteredServiceFromFile(java.io.File file)

Gets registered service from file.

Parameters:

file - the file

Returns:

the registered service from file

getRegisteredServiceFileName

protected java.io.File getRegisteredServiceFileName(RegisteredService service)

Creates a file for a registered service. The file is named as [SERVICE-NAME]-[SERVICE-ID]-.{@value #getExtension()}

Parameters:

service - Registered service.

Returns:

file in service registry directory.

Throws:

java.lang.IllegalArgumentException - if file name is invalid

getExtension

protected abstract java.lang.String getExtension()

Gets extension associated with files in the given resource directory.

Returns:

the extension