com.communote.server.api

Class ServiceLocator

java.lang.Object

com.communote.server.api.ServiceLocator

public class ServiceLocator
extends Object

Locator for Spring services of the core ApplicationContext. This is especially useful for situations where autowiring is not possible.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static <T> T	findService(Class<T> serviceClass) Get the service with the given type.
<T> T	getService(Class<T> serviceClass) Get the service of the given type.
Object	getService(String serviceName) Deprecated. Use getService(Class) or getService(String, Class) instead.
<T> T	getService(String serviceName, Class<T> serviceClass) Get a service by name that has the given type.
VirusScanner	getVirusScanner()
static ServiceLocator	instance() Get the singleton instance.
static boolean	isApplicationContextAvailable()

Methods inherited from class java.lang.Object

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

Method Detail

findService

public static final <T> T findService(Class<T> serviceClass)

Get the service with the given type. Using this method is equivalent to instance(). getService(Class). If the service does not exist or the application context was not initialized a runtime exception will be thrown.

Type Parameters:

T - Type of the service

Parameters:

serviceClass - Class of the service

Returns:

The service.

instance

public static final ServiceLocator instance()

Get the singleton instance.

Returns:

the service locator or null if the application context was not yet initialized

isApplicationContextAvailable

public static boolean isApplicationContextAvailable()

Returns:

whether the application context is available and instance() will return not null

getService

public <T> T getService(Class<T> serviceClass)

Get the service of the given type. The simple name of the class, with the first letter converted to lower case, will be used as name of the service. If there is no matching service a runtime exception will be thrown.

Type Parameters:

T - Type of the service

Parameters:

serviceClass - Class of the service

Returns:

the service

getService

@Deprecated
public Object getService(String serviceName)

Deprecated. Use getService(Class) or getService(String, Class) instead.

Get a service by name. If there is no matching service a runtime exception will be thrown.

Parameters:

serviceName - The name of the service

Returns:

the service

getService

public <T> T getService(String serviceName,
                        Class<T> serviceClass)

Get a service by name that has the given type. If there is no such service a runtime exception will be thrown.

Type Parameters:

T - Type of the service

Parameters:

serviceName - The name of the service

serviceClass - Class of the service

Returns:

the service

getVirusScanner

public VirusScanner getVirusScanner()
                             throws InitializeException

Returns:

the virus scanner or null if virus scanning is disabled

Throws:

InitializeException - if virus scanning is enabled but the selected scanner was not correctly initialized