org.sakaiproject.component.cover

Class ComponentManager

java.lang.Object

org.sakaiproject.component.cover.ComponentManager

public class ComponentManager
extends Object

ComponentManager is a static Cover for the Component Manager; see that interface for usage details.

This cover is special. As a cover for the component manager, it cannot use the component manager to find the instance. Instead, this is where a static single-instance singleton ComponentManger of a particular type is created.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CACHE_COMPONENTS If true, covers will cache the components they find once - good for production, bad for some unit testing.
protected static ComponentManager	m_componentManager A component manager - use the Spring based one.
static String	SAKAI_COMPONENTS_ROOT_SYS_PROP
static boolean	testingMode Setup the CM in testingMode if this is true (this is to be used for unit tests only), has no effect if the CM is already initialized

Constructor Summary

Constructors

Constructor and Description
ComponentManager()

Method Summary

Methods

Modifier and Type	Method and Description
static void	close()
static boolean	contains(Class iface)
static boolean	contains(String ifaceName)
static Object	get(Class iface)
static Object	get(String ifaceName)
static Properties	getConfig() Deprecated. This method is redundant, not used by any known client, would expose implementation details, and will be removed in a future release. Use the ServerConfigurationService instead.
static ComponentManager	getInstance() Access the component manager of the single instance.
static Set	getRegisteredInterfaces()
static boolean	hasBeenClosed()
static boolean	isTestingMode()
static void	loadComponent(Class iface, Object component)
static void	loadComponent(String ifaceName, Object component)
static void	setLateRefresh(boolean b)
static void	shutdown() TESTING ONLY closes and then destroys the component manager WARNING: this is NOT safe to do in a production system
static void	waitTillConfigured() When the component manager this can be called by a background thread to wait until the component manager has been configured.

Methods inherited from class java.lang.Object

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

Field Detail

m_componentManager

protected static ComponentManager m_componentManager

A component manager - use the Spring based one.

CACHE_COMPONENTS

public static final boolean CACHE_COMPONENTS

If true, covers will cache the components they find once - good for production, bad for some unit testing.

See Also:

Constant Field Values

SAKAI_COMPONENTS_ROOT_SYS_PROP

public static String SAKAI_COMPONENTS_ROOT_SYS_PROP

testingMode

public static boolean testingMode

Setup the CM in testingMode if this is true (this is to be used for unit tests only), has no effect if the CM is already initialized

Constructor Detail

ComponentManager

public ComponentManager()

Method Detail

isTestingMode

public static boolean isTestingMode()

Returns:

true if this CM is in testing mode

shutdown

public static void shutdown()

TESTING ONLY
closes and then destroys the component manager
WARNING: this is NOT safe to do in a production system

getInstance

public static ComponentManager getInstance()

Access the component manager of the single instance.

Returns:

The ComponentManager.

get

public static Object get(Class iface)

get

public static Object get(String ifaceName)

contains

public static boolean contains(Class iface)

contains

public static boolean contains(String ifaceName)

getRegisteredInterfaces

public static Set getRegisteredInterfaces()

loadComponent

public static void loadComponent(Class iface,
                 Object component)

loadComponent

public static void loadComponent(String ifaceName,
                 Object component)

close

public static void close()

getConfig

@Deprecated
public static Properties getConfig()

Deprecated. This method is redundant, not used by any known client, would expose implementation details, and will be removed in a future release. Use the ServerConfigurationService instead.

waitTillConfigured

public static void waitTillConfigured()

When the component manager this can be called by a background thread to wait until the component manager has been configured. If the component manager hasn't yet started it will return straight away. If the component manager fails to start it will return. This is to prevent a deadlock between shutdown and startup.

hasBeenClosed

public static boolean hasBeenClosed()

setLateRefresh

public static void setLateRefresh(boolean b)