com.sapportals.wcm.crt

Class CrtSystem

java.lang.Object
  com.sapportals.wcm.crt.CrtSystem

public abstract class CrtSystem
extends Object

Provides access to the component runtime system.

Copyright (c) SAP AG 2001-2002

Constructor Summary

CrtSystem()

Method Summary

abstract void	createComponentManager(String clientID, IConfigurationProvider configProvider, IComponentListener listener, ClassLoader loader, Category category) Creates a component manager for a new CRT client.
abstract IComponentManager	getComponentManager(String clientID) Returns a reference to the component manager for the specified client identifier, or null if the client does not exist.
static CrtSystem	getInstance() Returns an instance of this class.
abstract IComponent	lookupComponentByUri(ComponentUri uri) Returns the component instance for the specified URI or null if the component does not exist.
abstract boolean	managerStartUpIsRunning(String clientID) Returns true if the manager startup is in progress, false otherwise.
abstract void	releaseComponent(IComponent component) Releases the component.
abstract void	shutDownComponentManager(String clientID) This method can optionally be called to shutdown all components of a CRT client.
abstract void	startUpComponentManager(String clientID) This method can optionally be called after the creation of a new component manager.

Methods inherited from class java.lang.Object

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

Constructor Detail

CrtSystem

public CrtSystem()

Method Detail

getComponentManager

public abstract IComponentManager getComponentManager(String clientID)

Returns a reference to the component manager for the specified client identifier, or null if the client does not exist.

Parameters:

clientID - The identifier of a CRT client.

Returns:

a reference to the component manager or null .

createComponentManager

public abstract void createComponentManager(String clientID,
                                            IConfigurationProvider configProvider,
                                            IComponentListener listener,
                                            ClassLoader loader,
                                            Category category)
                                     throws CascadingException

Creates a component manager for a new CRT client.

Parameters:

clientID - An identifier for the client.

configProvider - A configuration provider instance

listener - A component listener implementation, can be null .

loader - The class loader for the application.

category - The logger category to use for all components, can be null . The CRT will also use this logger to log all exceptions that occure during configration and initialization of components.

Throws:

CascadingException - If some arguments are invalid or the creation of the manager fails.

lookupComponentByUri

public abstract IComponent lookupComponentByUri(ComponentUri uri)
                                         throws ComponentException

Returns the component instance for the specified URI or null if the component does not exist.

Parameters:

uri - The component URI to look for.

The caller must subseqently call releaseComponent() when it is finished using the component. This is optional for thread-safe components.

Returns:

the component instance or null .

Throws:

ComponentException - If the component could not be instanciated.

releaseComponent

public abstract void releaseComponent(IComponent component)

Releases the component. This method should be called when the caller is finished using the component. It must be called for all components that do not implement the IThreadSafe interface - it is optional for thread-safe components.

Parameters:

component - A reference to the component to release.

startUpComponentManager

public abstract void startUpComponentManager(String clientID)

This method can optionally be called after the creation of a new component manager. If the initial configuration contains components that implement the IAutoStartable interface these components will be started. If no such components exist this method will do nothing.

This method must be called only once. It must be called before any lookup methods are called.

Parameters:

clientID - The client ID

shutDownComponentManager

public abstract void shutDownComponentManager(String clientID)

This method can optionally be called to shutdown all components of a CRT client. The method must be called only once. It is not possible to restart a component manager after shutdown.

Parameters:

clientID - The client ID

getInstance

public static CrtSystem getInstance()

Returns an instance of this class.

Returns:

instance

managerStartUpIsRunning

public abstract boolean managerStartUpIsRunning(String clientID)

Returns true if the manager startup is in progress, false otherwise.

Parameters:

clientID - The client ID.

Returns:

true if the manager startup is in progress, false otherwise.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM