org.apereo.cas.adaptors.ldap.services

Class LdapServiceRegistry

java.lang.Object

org.apereo.cas.services.AbstractServiceRegistry

org.apereo.cas.adaptors.ldap.services.LdapServiceRegistry

All Implemented Interfaces:

ServiceRegistry

public class LdapServiceRegistry
extends AbstractServiceRegistry

Implementation of the ServiceRegistry interface which stores the services in a LDAP Directory.

Since:

4.0.0

Constructor Summary

Constructors

Constructor and Description
LdapServiceRegistry(org.ldaptive.ConnectionFactory connectionFactory, java.lang.String baseDn, LdapRegisteredServiceMapper ldapServiceMapper, LdapServiceRegistryProperties ldapProperties)

Method Summary

Modifier and Type	Method and Description
boolean	delete(RegisteredService registeredService) Remove the service from the data store.
RegisteredService	findServiceById(long id) Find service by the numeric id.
RegisteredService	findServiceById(java.lang.String id) Find service by the service id.
java.util.List<RegisteredService>	load() Retrieve the services from the data store.
RegisteredService	save(RegisteredService rs) Persist the service in the data store.
long	size() Return number of records held in this service registry.

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

Constructor Detail

LdapServiceRegistry

public LdapServiceRegistry(org.ldaptive.ConnectionFactory connectionFactory,
                           java.lang.String baseDn,
                           LdapRegisteredServiceMapper ldapServiceMapper,
                           LdapServiceRegistryProperties ldapProperties)

Method Detail

save

public RegisteredService save(RegisteredService rs)

Description copied from interface: ServiceRegistry

Persist the service in the data store.

Parameters:

rs - the service to persist.

Returns:

the updated RegisteredService.

delete

public boolean delete(RegisteredService registeredService)

Description copied from interface: ServiceRegistry

Remove the service from the data store.

Parameters:

registeredService - the service to remove.

Returns:

true if it was removed, false otherwise.

size

public 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. This may be an expensive operation. In order to count the number of available definitions in LDAP, this call will attempt to execute a search query to load services and the results will be counted. Do NOT attempt to call this operation in a loop.

Returns:

number of entries in the service registry

load

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

Description copied from interface: ServiceRegistry

Retrieve the services from the data store.

Returns:

the collection of services.

findServiceById

public RegisteredService findServiceById(long id)

Description copied from interface: ServiceRegistry

Find service by the numeric id.

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.

Parameters:

id - the id

Returns:

the registered service