com.sapportals.wcm.service

Class AbstractService

java.lang.Object
  com.sapportals.wcm.service.AbstractService

All Implemented Interfaces:

com.sap.netweaver.km.monitor.IMonitorInfoProvider, IComponent, IComponentInfo, IConfigurable, ILifecycleInfo, IStartable, IService

public abstract class AbstractService
extends Object
implements IService, IComponent, IConfigurable, IStartable, IComponentInfo, ILifecycleInfo, com.sap.netweaver.km.monitor.IMonitorInfoProvider

The abstract base class for global Services.

Copyright (c) SAP AG 2001 - 2002

Nested Class Summary

static interface

AbstractService.CONFIG_ATTRIBUTE_NAME TBD: Description of the class.

Field Summary

protected IConfiguration	config This service's configuration
protected Properties	properties This service's configuration converted to a Properties object.
protected ComponentStateHandler	stateHandler

Constructor Summary

AbstractService()
The default constructor

AbstractService(Properties properties)
Deprecated. As of EP 5.0 SP5, replaced by default (public, no arguments) constructor.

Method Summary

void	configure(IConfiguration config) Passes the configuration data to the configurable.
static com.sap.netweaver.km.monitor.data.ConfigData	convertConfigData(IConfiguration cfg) Convert a CRT configuration data object to the monitor format.
static Properties	convertConfigToProperties(IConfiguration config) Helper method for conversion of configuration data into properties.
protected static Properties	convertConfigToProperties(IConfiguration config, String prefix) Helper method for conversion of configuration data into properties.
static com.sap.netweaver.km.monitor.data.StatusInfo	convertStatus(ComponentStateHandler sh) Convert the CRT status information to the generic monitor status.
static com.sap.netweaver.km.monitor.data.StructuredData	createPropertyList(ComponentStateHandler sh) Create a list of properties for CRT lifecycle information.
Date	getCreationDate() Returns the date and time of the creation of the component instance.
String	getDescription() Get a description for this service.
String	getDescription(Locale locale) Get a description for this service.
String	getID() Get a service identifier, unique for this instance.
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.
String	getType() Deprecated. As of EP 5.0 SP5, The "service type" is the name of the configurable class.
protected void	postService()
protected void	preService()
com.sap.netweaver.km.monitor.data.MonitorData	retrieveMonitorData() Default implementation - should be overwritten by a service to manage the status during runtime.
protected void	shutDown() Deprecated. As of EP 5.0 SP5, replaced by startUpImpl().
protected void	shutDownImpl() The implementation must overwrite this method if it has to release resources acquired during shutdown.
void	start() A component must implement this method if it has initial startup handling to do before being accessible (acquire resources, open connections to remote systems, etc).
protected void	startUp() Deprecated. As of EP 5.0 SP5, replaced by shutDownImpl().
protected void	startUpImpl() The implementation must overwrite this method if it has initial startup handling to do (acquire resources, open connections to remote systems, etc).
void	stop() This method is only called once during the life-time of a component.

Methods inherited from class java.lang.Object

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

Field Detail

config

protected IConfiguration config

This service's configuration

properties

protected Properties properties

This service's configuration converted to a Properties object. This will be null unless the manager implementation calls the conversion method in startUp !!

stateHandler

protected final ComponentStateHandler stateHandler

Constructor Detail

AbstractService

public AbstractService()

The default constructor

AbstractService

public AbstractService(Properties properties)
                throws WcmException

Deprecated. As of EP 5.0 SP5, replaced by default (public, no arguments) constructor.

Parameters:

properties - TBD: Description of the incoming method parameter

Throws:

WcmException - Exception raised in failure situation

Method Detail

getID

public final String getID()

Description copied from interface: IService

Get a service identifier, unique for this instance.

Specified by:

getID in interface IService

Returns:

The unique ID of this service.

getDescription

public String getDescription()

Description copied from interface: IService

Get a description for this service.

Specified by:

getDescription in interface IService

Returns:

The discription of the service.

getType

public String getType()

Deprecated. As of EP 5.0 SP5, The "service type" is the name of the configurable class.

Returns:

type

configure

public final void configure(IConfiguration config)
                     throws ConfigurationException

Description copied from interface: IConfigurable

Passes the configuration data to the configurable. This method will by called by the CRT only once. It is called after construction and contextualization and before startup (if implemented).

Specified by:

configure in interface IConfigurable

Parameters:

config - the component's configuration data.

Throws:

ConfigurationException - Exception raised in failure situation

start

public final void start()
                 throws StartupException

Description copied from interface: IStartable

A component must implement this method if it has initial startup handling to do before being accessible (acquire resources, open connections to remote systems, etc). This method is only called once during the life-time of a component except an AutoRestartException was thrown.

Specified by:

start in interface IStartable

Throws:

StartupException - If the initialization failed because neccessary resources could not be allocated.

stop

public final void stop()

Description copied from interface: IStartable

This method is only called once during the life-time of a component. It is called by the CRT when the component was removed from the configuration or the system shuts down. A stopped component can not be (re)started. After a shutdown the component instance will be finalized by the Java VM as soon as no other components in the system holds a reference to it.

Specified by:

stop in interface IStartable

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 .

getDescription

public String getDescription(Locale locale)

Description copied from interface: IService

Get a description for this service.

Specified by:

getDescription in interface IComponentInfo

Specified by:

getDescription in interface IService

Parameters:

locale - TBD: Description of the incoming method parameter

Returns:

The discription of the service.

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 .

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:

the last configuration exception. Can be null.

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:

the startup exception. Can be null.

getCreationDate

public final 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

preService

protected void preService()
                   throws WcmException

Throws:

WcmException

postService

protected void postService()

startUpImpl

protected void startUpImpl()
                    throws ConfigurationException,
                           StartupException

The implementation must overwrite this method if it has initial startup handling to do (acquire resources, open connections to remote systems, etc). Accoring to the contract of the IStartable interface of the CRT this method will be called only once. It will be called on systen start up or when a new instance of this component is added to the persistence configuration.

Throws:

ConfigurationException - Exception raised in failure situation

StartupException - Exception raised in failure situation

shutDownImpl

protected void shutDownImpl()

The implementation must overwrite this method if it has to release resources acquired during shutdown. Accoring to the contract of the IStartable interface of the CRT this method will be called only once. It will be called when the component is removed from the persistent configuration or when the system shuts down.

startUp

protected void startUp()
                throws WcmException

Deprecated. As of EP 5.0 SP5, replaced by shutDownImpl().

The implementation must overwrite this method if it has initial startup handling to do (acquire resources, open connections to remote systems, etc).

Throws:

WcmException - Exception raised in failure situation

shutDown

protected void shutDown()
                 throws WcmException

Deprecated. As of EP 5.0 SP5, replaced by startUpImpl().

The implementation must overwrite this method if it has to release resources acquired during shutdown.

Throws:

WcmException - Exception raised in failure situation

convertConfigToProperties

public static final Properties convertConfigToProperties(IConfiguration config)

Helper method for conversion of configuration data into properties.

Parameters:

config - which attributes should be converted to properties

Returns:

converted config as properties

convertConfigToProperties

protected static final Properties convertConfigToProperties(IConfiguration config,
                                                            String prefix)

Helper method for conversion of configuration data into properties.

Parameters:

config - which attributes should be converted to properties

prefix - to prepend to config attribute names

Returns:

converted config as properties

retrieveMonitorData

public com.sap.netweaver.km.monitor.data.MonitorData retrieveMonitorData()

Default implementation - should be overwritten by a service to manage the status during runtime.

Specified by:

retrieveMonitorData in interface com.sap.netweaver.km.monitor.IMonitorInfoProvider

convertConfigData

public static com.sap.netweaver.km.monitor.data.ConfigData convertConfigData(IConfiguration cfg)

Convert a CRT configuration data object to the monitor format.

Parameters:

cfg - CRT configuration.

Returns:

configuration data object in the monitor format that is ConfigData.

convertStatus

public static com.sap.netweaver.km.monitor.data.StatusInfo convertStatus(ComponentStateHandler sh)

Convert the CRT status information to the generic monitor status.

Parameters:

sh - component state handler

Returns:

component status information with textual explanation.

createPropertyList

public static com.sap.netweaver.km.monitor.data.StructuredData createPropertyList(ComponentStateHandler sh)

Create a list of properties for CRT lifecycle information.

Parameters:

sh - component state handler

Returns:

StructuredData that keep a list of properties for CRT lifecycle information.

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