org.apereo.cas.services

Class MongoDbServiceRegistry

java.lang.Object

org.apereo.cas.services.AbstractServiceRegistry

org.apereo.cas.services.MongoDbServiceRegistry

All Implemented Interfaces:

ServiceRegistry

public class MongoDbServiceRegistry
extends AbstractServiceRegistry

Implementation of ServiceRegistry that uses a MongoDb repository as the backend persistence mechanism. The repository is configured by the Spring application context.

The class will automatically create a default collection to use with services. The name of the collection may be specified. It also presents the ability to drop an existing collection and start afresh.

Since:

4.1

Constructor Summary

Constructors

Constructor and Description
MongoDbServiceRegistry()

Method Summary

Modifier and Type	Method and Description
boolean	delete(RegisteredService svc) Remove the service from the data store.
RegisteredService	findServiceById(long svcId) 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 svc) 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

MongoDbServiceRegistry

public MongoDbServiceRegistry()

Method Detail

delete

public boolean delete(RegisteredService svc)

Description copied from interface: ServiceRegistry

Remove the service from the data store.

Parameters:

svc - the service to remove.

Returns:

true if it was removed, false otherwise.

findServiceById

public RegisteredService findServiceById(long svcId)

Description copied from interface: ServiceRegistry

Find service by the numeric id.

Parameters:

svcId - 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

load

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

Description copied from interface: ServiceRegistry

Retrieve the services from the data store.

Returns:

the collection of services.

save

public RegisteredService save(RegisteredService svc)

Description copied from interface: ServiceRegistry

Persist the service in the data store.

Parameters:

svc - the service to persist.

Returns:

the updated RegisteredService.

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.

Returns:

number of registered services held by any particular implementation