com.sapportals.wcm.protocol.webdav.repository.monitor

Class ServerCollection

java.lang.Object
  com.sapportals.wcm.protocol.webdav.repository.monitor.ServerCollection

All Implemented Interfaces:

IComponent, IComponentInfo, IContainer, IContextualizable, ILifecycleInfo, IThreadSafe, IServerRegistry

public final class ServerCollection
extends Object
implements IComponent, IContainer, IContextualizable, IThreadSafe, ILifecycleInfo, IComponentInfo, IServerRegistry

Holds runtime (crt) objects for each registered IServerComponent.

Copyright (c) SAP AG 2002-2004

Field Summary

static String

NAME

Constructor Summary

ServerCollection()

Method Summary

void	contextualize(IContext context) Pass the context to the component.
IComponentManager	getComponentManager() Returns the component manager for accessing this container's child components.
Date	getCreationDate() Returns the date and time of the creation of the component instance.
String	getDescription(Locale locale) Returns a description of the components purpose or null .
ConfigurationException	getLastConfigurationException() Returns the exception thrown in the last call to IConfigurable.configure(IConfiguration), or IReconfigurable.reconfigure(IConfiguration).
Date	getLastReconfigurationDate() Returns the date and time of the last reconfiguration of this component.
String	getName() Returns the component's human-readable name or null .
Date	getNextAutoRestartDate() Returns the date and time of the next automatic restart of the component.
Properties	getProperties() Returns some arbitrary properties with information about the component or null .
StartupException	getStartupException() Returns the exception thrown in the last call to IStartable.start(), Can be null .
ComponentState	getState() Returns the current life-cycle state of the component.
void	register(IServerComponent server)
void	unregister(IServerComponent server)

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

ServerCollection

public ServerCollection()

Method Detail

register

public void register(IServerComponent server)
              throws Exception

Specified by:

register in interface IServerRegistry

Throws:

Exception

unregister

public void unregister(IServerComponent server)

Specified by:

unregister in interface IServerRegistry

getComponentManager

public IComponentManager getComponentManager()

Description copied from interface: IContainer

Returns the component manager for accessing this container's child components.

Specified by:

getComponentManager in interface IContainer

Returns:

the component manager for accessing this container's child components.

contextualize

public void contextualize(IContext context)
                   throws ContextException

Description copied from interface: IContextualizable

Pass the context to the component.

Specified by:

contextualize in interface IContextualizable

Parameters:

context - The context objects

Throws:

ContextException - if the context is invalid

getCreationDate

public Date getCreationDate()

Description copied from interface: ILifecycleInfo

Returns the date and time of the creation of the component instance. Can be null . This property usually makes sense only for components that implement the IThreadSafe interface.

Specified by:

getCreationDate in interface ILifecycleInfo

Returns:

the date and time of the creation of the component instance. Can be null .

getLastReconfigurationDate

public Date getLastReconfigurationDate()

Description copied from interface: ILifecycleInfo

Returns the date and time of the last reconfiguration of this component. Can be null .

Specified by:

getLastReconfigurationDate in interface ILifecycleInfo

Returns:

the date and time of the last reconfiguration of this component. Can be null .

getNextAutoRestartDate

public Date getNextAutoRestartDate()

Description copied from interface: ILifecycleInfo

Returns the date and time of the next automatic restart of the component. Can be null .

Specified by:

getNextAutoRestartDate in interface ILifecycleInfo

Returns:

the date and time of the next automatic restart of the component. Can be null .

See Also:

AutoRestartException

getStartupException

public StartupException getStartupException()

Description copied from interface: ILifecycleInfo

Returns the exception thrown in the last call to IStartable.start(), Can be null .

Specified by:

getStartupException in interface ILifecycleInfo

Returns:

startupException

getState

public ComponentState getState()

Description copied from interface: ILifecycleInfo

Returns the current life-cycle state of the component. Can be null .

Specified by:

getState in interface ILifecycleInfo

Returns:

the current life-cycle state of the component. Can be null .

getLastConfigurationException

public ConfigurationException getLastConfigurationException()

Description copied from interface: ILifecycleInfo

Returns the exception thrown in the last call to IConfigurable.configure(IConfiguration), or IReconfigurable.reconfigure(IConfiguration). Can be null .

Specified by:

getLastConfigurationException in interface ILifecycleInfo

Returns:

lastConfigurationException

getDescription

public String getDescription(Locale locale)

Description copied from interface: IComponentInfo

Returns a description of the components purpose or null .

Specified by:

getDescription in interface IComponentInfo

Parameters:

locale - Selects the language of the description text - can be null .

Returns:

a description of the components purpose or null .

getName

public String getName()

Description copied from interface: IComponentInfo

Returns the component's human-readable name or null .

Specified by:

getName in interface IComponentInfo

Returns:

the component's human-readable name or null .

getProperties

public Properties getProperties()

Description copied from interface: IComponentInfo

Returns some arbitrary properties with information about the component or null .

Specified by:

getProperties in interface IComponentInfo

Returns:

some arbitrary properties with information about the component or null .

Access Rights

This class can be accessed from:

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