com.webmethods.portal.system.osgi

Class OsgiServiceComponentData

java.lang.Object

com.webmethods.portal.system.osgi.OsgiServiceComponentData

All Implemented Interfaces:

IComponentData

public class OsgiServiceComponentData
extends Object
implements IComponentData

IComponentData for components implemented as OSGi declaritive services

Field Summary

Fields

Modifier and Type	Field and Description
protected IComponent	m_component
protected IComponentProvider	m_componentProvider
protected Element	m_configElement
protected String	m_configStream
protected Map<String,Object>	m_properties
protected IURI	m_uri

Constructor Summary

Constructors

Constructor and Description
OsgiServiceComponentData(Map<String,? extends Object> properties)
OsgiServiceComponentData(Map<String,? extends Object> properties, IComponentProvider componentProvider)
OsgiServiceComponentData(Map<String,? extends Object> properties, IComponentProvider componentProvider, IComponent component)
OsgiServiceComponentData(Map<String,? extends Object> properties, IInitializable service)

Method Summary

Modifier and Type	Method and Description
IComponent	getComponent() A factory method to create the component from this IComponentData.
String	getComponentClassName() Gets the classname for the IComponent which can be used in calls to ObjectUtil.createObject(java.lang.String).
Element	getConfig() Gets the config element for this IComponent.
String	getConfigFile() Get configFile attribute value.
String	getConfigStream() Gets config data as raw String stream
boolean	getEnabled() Gets whether this IComponent is enabled or not.
IInitializable	getInitializable()
Map<String,Object>	getProperties() Gets the properties for this IComponent.
String	getServiceID() Return the OSGi service ID for the component, if available.
IURI	getURI()
void	setComponent(IComponent component) If for some reason you want to create and initialize an IComponent externally Use only with caution, or not at all.
void	setComponentClassName(String className) Sets the implementation class name for the IComponent.
void	setConfig(Element configElement) Sets the config element for this IComponent.
void	setConfigFile(String configFile) Set the value of configFile
void	setConfigStream(String config) Sets component data as raw String stream
void	setEnabled(boolean enabled) Sets whether this IComponent is enabled
DifferenceMap	setProperties(Map<String,? extends Object> properties) Sets the properties for this IComponent.

Methods inherited from class java.lang.Object

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

Field Detail

m_properties

protected Map<String,Object> m_properties

m_configElement

protected Element m_configElement

m_componentProvider

protected IComponentProvider m_componentProvider

m_uri

protected IURI m_uri

m_configStream

protected String m_configStream

m_component

protected transient IComponent m_component

Constructor Detail

OsgiServiceComponentData

public OsgiServiceComponentData(Map<String,? extends Object> properties)

Parameters:

properties -

componentProvider -

OsgiServiceComponentData

public OsgiServiceComponentData(Map<String,? extends Object> properties,
                                IInitializable service)

Parameters:

properties -

componentProvider -

OsgiServiceComponentData

public OsgiServiceComponentData(Map<String,? extends Object> properties,
                                IComponentProvider componentProvider)

Parameters:

properties -

componentProvider -

OsgiServiceComponentData

public OsgiServiceComponentData(Map<String,? extends Object> properties,
                                IComponentProvider componentProvider,
                                IComponent component)

Parameters:

properties -

componentProvider -

Method Detail

getEnabled

public boolean getEnabled()
                   throws PortalException

Description copied from interface: IComponentData

Gets whether this IComponent is enabled or not.

Specified by:

getEnabled in interface IComponentData

Returns:

true if enabled, false otherwise

Throws:

PortalException

setEnabled

public void setEnabled(boolean enabled)
                throws PortalException

Description copied from interface: IComponentData

Sets whether this IComponent is enabled

Specified by:

setEnabled in interface IComponentData

Throws:

PortalException

getServiceID

public String getServiceID()

Return the OSGi service ID for the component, if available.

Returns:

the component id or "unknown" if it can not be determined.

getInitializable

public IInitializable getInitializable()
                                throws PortalException

Returns:

the service

Throws:

PortalException

getComponent

public IComponent getComponent()
                        throws PortalException

Description copied from interface: IComponentData

A factory method to create the component from this IComponentData. This will also initialize the IComponent if it hasn't already been initialized

Specified by:

getComponent in interface IComponentData

Returns:

an initialized IComponent

Throws:

PortalException

getURI

public IURI getURI()
            throws PortalException

Specified by:

getURI in interface IComponentData

Returns:

a unique URI which describes this IComponentData

Throws:

PortalException

getComponentClassName

public String getComponentClassName()
                             throws PortalException

Description copied from interface: IComponentData

Gets the classname for the IComponent which can be used in calls to ObjectUtil.createObject(java.lang.String).

Specified by:

getComponentClassName in interface IComponentData

Returns:

a valid string for calls to ObjectUtil.createObject(java.lang.String).

Throws:

PortalException

setComponentClassName

public void setComponentClassName(String className)
                           throws PortalException

Description copied from interface: IComponentData

Sets the implementation class name for the IComponent.

Specified by:

setComponentClassName in interface IComponentData

Parameters:

className - a valid string for calls to ObjectUtil.createObject(java.lang.String).

Throws:

PortalException

getConfig

public Element getConfig()
                  throws PortalException

Description copied from interface: IComponentData

Gets the config element for this IComponent.

Specified by:

getConfig in interface IComponentData

Returns:

Either the config element, or NULL if it is properties based

Throws:

PortalException

setConfig

public void setConfig(Element configElement)
               throws PortalException

Description copied from interface: IComponentData

Sets the config element for this IComponent.

Specified by:

setConfig in interface IComponentData

Throws:

PortalException

getConfigStream

public String getConfigStream()
                       throws PortalException

Description copied from interface: IComponentData

Gets config data as raw String stream

Specified by:

getConfigStream in interface IComponentData

Returns:

Throws:

PortalException

setConfigStream

public void setConfigStream(String config)
                     throws PortalException

Description copied from interface: IComponentData

Sets component data as raw String stream

Specified by:

setConfigStream in interface IComponentData

Throws:

PortalException

getProperties

public Map<String,Object> getProperties()
                                 throws PortalException

Description copied from interface: IComponentData

Gets the properties for this IComponent.

Specified by:

getProperties in interface IComponentData

Returns:

properties, or simple Element attributes if this is element based

Throws:

PortalException

setProperties

public DifferenceMap setProperties(Map<String,? extends Object> properties)
                            throws PortalException

Description copied from interface: IComponentData

Sets the properties for this IComponent.

Specified by:

setProperties in interface IComponentData

Throws:

PortalException

setComponent

public void setComponent(IComponent component)

Description copied from interface: IComponentData

If for some reason you want to create and initialize an IComponent externally Use only with caution, or not at all.

Specified by:

setComponent in interface IComponentData

Parameters:

component - a valid IComponent.

getConfigFile

public String getConfigFile()
                     throws PortalException

Description copied from interface: IComponentData

Get configFile attribute value.

Specified by:

getConfigFile in interface IComponentData

Throws:

PortalException

See Also:

IComponentData.getConfig()

setConfigFile

public void setConfigFile(String configFile)
                   throws PortalException

Description copied from interface: IComponentData

Set the value of configFile

Specified by:

setConfigFile in interface IComponentData

Throws:

PortalException