com.sapportals.wcm.rendering.base

Class StatusFactory

java.lang.Object
  com.sapportals.wcm.rendering.base.StatusFactory

All Implemented Interfaces:

com.sap.netweaver.km.monitor.IMonitorInfoProvider, IFactoryInfoProvider

public final class StatusFactory
extends Object
implements IFactoryInfoProvider, com.sap.netweaver.km.monitor.IMonitorInfoProvider

Nested Class Summary

Nested classes/interfaces inherited from interface com.sapportals.wcm.rendering.base.IFactoryInfoProvider

IFactoryInfoProvider.MappingInformation

Method Summary

String	getFactoryName()
static StatusFactory	getInstance()
long	getLastReloadTime()
Properties	getMapping()
List	getMappings(Locale locale)
Status	getStatus()
IConfigurableRendererStatus	getStatusInstance(ICollection resource, IDebugContainer container) Returns a new instance of a ILayoutController If no configuration for the set of parameters can be retrieved or the mapping entry is faulty, the default LayoutController of the factory is returned.
IConfigurableRendererStatus	getStatusInstance(ITypedResourceList list, IDebugContainer container)
com.sap.netweaver.km.monitor.data.MonitorData	retrieveMonitorData() Method that returns a MonitorData object with object infos to be displayed in KM Monitor

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static StatusFactory getInstance()

Returns:

the singleton instance of the LayoutControllerFactory. When this method is first called, the singleton instance reads out the configuration and fills its internal hashtable of LayoutControllers

getStatusInstance

public IConfigurableRendererStatus getStatusInstance(ICollection resource,
                                                     IDebugContainer container)
                                              throws com.sapportals.wcm.WcmException

Returns a new instance of a ILayoutController If no configuration for the set of parameters can be retrieved or the mapping entry is faulty, the default LayoutController of the factory is returned. The method uses the CustomizingControllerFactory to retrieve the mapped name for the given set of parameters.

Parameters:

proxy - the IProxy that called this method. It is set as parameter for the retrieved instance. The proxy's hashtable, that holds the iView/ URL-Parameter is used by the CustomizingControllerFactory to retrieve the matching mapping name.

resource - the resource that acts as the "root"-resource in the given IProxy

Returns:

an instance of ILayoutController that was configured for the given combination of input parameters. Does not return null. The instance is ready-to-use (no set-methods have to be called afterwards)

Throws:

com.sapportals.wcm.WcmException

getStatusInstance

public IConfigurableRendererStatus getStatusInstance(ITypedResourceList list,
                                                     IDebugContainer container)
                                              throws com.sapportals.wcm.WcmException

Throws:

com.sapportals.wcm.WcmException

getMappings

public List getMappings(Locale locale)

Specified by:

getMappings in interface IFactoryInfoProvider

Parameters:

locale - defines the language to use, if the factory offers translated information, must not be null

Returns:

a list that must only contain IFactoryInfoProvider.MappingInformation, must not be null

getMapping

public Properties getMapping()

getStatus

public Status getStatus()

Specified by:

getStatus in interface IFactoryInfoProvider

Returns:

the aggregated status of the factory. If, e.g., there have been errors creating a class defined in the config, the factory should return Status.ERROR

getFactoryName

public String getFactoryName()

Specified by:

getFactoryName in interface IFactoryInfoProvider

Returns:

a human-readable name of the factory, must not be null

getLastReloadTime

public long getLastReloadTime()

Specified by:

getLastReloadTime in interface IFactoryInfoProvider

Returns:

the time of the last reload of the config by this factory. Expects a format such as returned by System.currentTimeMillis(). An implementing class might also return -1 to indicate, that no information is available.

retrieveMonitorData

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

Method that returns a MonitorData object with object infos to be displayed in KM Monitor

Specified by:

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

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/nonwduideprecated	api	EP-KM-CM