org.onehippo.cms7.services

Class HippoServiceRegistry

java.lang.Object

org.onehippo.cms7.services.HippoServiceRegistry

public final class HippoServiceRegistry
extends Object

The singleton Hippo service registry. Serves as a service locator across applications running in the same JVM.

Method Summary

Modifier and Type	Method and Description
static List<HippoServiceRegistration>	getRegistrations(Class ifaceClass) Retrieve a list of whiteboard services by it's default (class) name.
static <T> T	getService(Class<T> ifaceClass) Retrieve a service by it's default (class) name.
static <T> T	getService(Class<T> ifaceClass, String name)
static int	getVersion()
static void	registerService(Object service, Class[] ifaceClasses) Register a service under a SingletonService annotated interface.
static void	registerService(Object service, Class<?> ifaceClass) Register a service under a SingletonService annotated interface.
static void	registerService(Object service, Class<?>[] ifaceClasses, String name)
static void	registerService(Object service, Class<?> ifaceClass, String name)
static void	unregisterService(Object service, Class<?> ifaceClass)
static void	unregisterService(Object service, Class<?> ifaceClass, String name)

Methods inherited from class java.lang.Object

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

Method Detail

registerService

public static void registerService(Object service,
                                   Class<?> ifaceClass)

Register a service under a SingletonService annotated interface.

If the service is an instance of the interface, it will be registered as the singleton.

If the interface has an WhiteboardService annotation, it is still possible to register the service.

The service will be proxied to enforce the Thread ContextClassLoader during invocation to be set to the Thread ContextClassLoader during registration.

Parameters:

service - service object to register

ifaceClass - interface to register the service upon for service lookup

registerService

public static void registerService(Object service,
                                   Class[] ifaceClasses)

Register a service under a SingletonService annotated interface.

If the service is an instance of the interface, it will be registered as the singleton.

If the interface has an WhiteboardService annotation, it is still possible to register the service.

The service will be proxied to enforce the Thread ContextClassLoader during invocation to be set to the Thread ContextClassLoader during registration.

Additional interfaces can be specified by the ifaceClasses parameter to be also exposed through the proxy. This allows for example (web application) internal interfaces to be used to access additional methods, not to be shared across web applications.

Parameters:

service - service object to register

ifaceClasses - array of interfaces to proxy for the service, the first interface is used to register the service upon for service lookup

unregisterService

public static void unregisterService(Object service,
                                     Class<?> ifaceClass)

getService

public static <T> T getService(Class<T> ifaceClass)

Retrieve a service by it's default (class) name. This provides a mechanism for services that used to be singletons to be upgraded to non-singleton situations.

Parameters:

ifaceClass -

getRegistrations

public static List<HippoServiceRegistration> getRegistrations(Class ifaceClass)

Retrieve a list of whiteboard services by it's default (class) name.

Parameters:

ifaceClass -

registerService

public static void registerService(Object service,
                                   Class<?> ifaceClass,
                                   String name)

registerService

public static void registerService(Object service,
                                   Class<?>[] ifaceClasses,
                                   String name)

unregisterService

public static void unregisterService(Object service,
                                     Class<?> ifaceClass,
                                     String name)

getService

public static <T> T getService(Class<T> ifaceClass,
                               String name)

getVersion

public static int getVersion()

Returns:

the version of this HippoServiceRegistry : Every time the registry gets a service added or removed the version is incremented. This is for classes using the HippoServiceRegistry that they can easily check whether they need to register or unregister new HippoServiceRegistrations