org.apereo.cas.services

Class CouchbaseServiceRegistryDao

java.lang.Object

org.apereo.cas.services.AbstractServiceRegistryDao

org.apereo.cas.services.CouchbaseServiceRegistryDao

All Implemented Interfaces:

ServiceRegistryDao

public class CouchbaseServiceRegistryDao
extends AbstractServiceRegistryDao

This is CouchbaseServiceRegistryDao. A Service Registry storage backend which uses the memcached protocol. This may seem like a weird idea until you realize that CouchBase is a multi host NoSQL database with a memcached interface to persistent storage which also is quite usable as a replicated ticket storage engine for multiple front end CAS servers.

Since:

4.2.0

Constructor Summary

Constructors

Constructor and Description
CouchbaseServiceRegistryDao(CouchbaseClientFactory couchbase, StringSerializer<RegisteredService> serviceJsonSerializer, boolean isQueryEnabled) Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	delete(RegisteredService service) Remove the service from the data store.
void	destroy() Stops the couchbase client and cancels the initialization task if uncompleted.
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 service) 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.AbstractServiceRegistryDao

findServiceByExactServiceId, publishEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

CouchbaseServiceRegistryDao

public CouchbaseServiceRegistryDao(CouchbaseClientFactory couchbase,
                                   StringSerializer<RegisteredService> serviceJsonSerializer,
                                   boolean isQueryEnabled)

Default constructor.

Parameters:

couchbase - couchbase instance

serviceJsonSerializer - the JSON serializer to use.

isQueryEnabled - the is query enabled

Method Detail

save

public RegisteredService save(RegisteredService service)

Description copied from interface: ServiceRegistryDao

Persist the service in the data store.

Parameters:

service - the service to persist.

Returns:

the updated RegisteredService.

delete

public boolean delete(RegisteredService service)

Description copied from interface: ServiceRegistryDao

Remove the service from the data store.

Parameters:

service - the service to remove.

Returns:

true if it was removed, false otherwise.

load

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

Description copied from interface: ServiceRegistryDao

Retrieve the services from the data store.

Returns:

the collection of services.

findServiceById

public RegisteredService findServiceById(long id)

Description copied from interface: ServiceRegistryDao

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: ServiceRegistryDao

Find service by the service id.

Parameters:

id - the id

Returns:

the registered service

destroy

@PreDestroy
public void destroy()

Stops the couchbase client and cancels the initialization task if uncompleted.

size

public long size()

Description copied from interface: ServiceRegistryDao

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