|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.wsspi.runtime.component.WsComponentImpl
com.ibm.wsspi.runtime.component.WsContainer
public class WsContainer
The base class for runtime framework containers.
A container (in the runtime framework sense), is a logical collection of components. This container implementation provides support for a plugin mechanism, by which components can associate themselves with a container and order their startup (and shutdown) relative to other components.
Field Summary |
---|
Fields inherited from class com.ibm.wsspi.runtime.component.WsComponentImpl |
---|
name, state |
Fields inherited from interface com.ibm.wsspi.runtime.component.WsComponent |
---|
DESTROYED, DESTROYING, ERROR, INITIALIZED, INITIALIZING, STARTED, STARTING, STATE, STOPPED, STOPPING |
Constructor Summary | |
---|---|
protected |
WsContainer(java.lang.String pluginId)
Constructs an instance of a WsContainer. |
Method Summary | |
---|---|
protected boolean |
add(WsComponent o)
Adds the component to the list of components managed by this container. |
void |
destroy()
Destroys all components owned by this container. |
protected void |
destroyComponents()
Destroys all components currently managed by this container. |
void |
initialize(java.lang.Object config)
Initializes this container. |
protected void |
initializeComponents(org.eclipse.emf.ecore.EObject rootConfig,
com.ibm.ws.runtime.config.ConfigLocator[] locators)
Initializes all components that have plugged into this container. |
protected java.util.List |
loadComponents(java.lang.String extensionPointId)
Constructs a sorted list of all components identified by the specified plugin file. |
protected boolean |
remove(WsComponent o)
Removes the component from the list of components managed by this container. |
void |
start()
Starts all components managed by this container. |
protected void |
startComponents()
Starts all components current managed by this container. |
void |
stop()
Stops all compoennts managed by this container. |
protected void |
stopComponents()
Stops all components currently managed by this container. |
Methods inherited from class com.ibm.wsspi.runtime.component.WsComponentImpl |
---|
_setStartupThreadPool, addPropertyChangeListener, deregisterMBean, deregisterMBean, deregisterMBeanViaQuery, expandVariable, firePropertyChange, getConfigId, getName, getPropertyChangeSupport, getState, inhibitAsynchBehavior, join, lookupMBeans, registerMBean, removePropertyChangeListener, runAsynchronousInitializer, runAsynchronousInitializer, setGlobalAsynchBehaviorInhibited, setName, setState |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected WsContainer(java.lang.String pluginId)
Method Detail |
---|
public void destroy()
destroy
in interface WsComponent
destroy
in class WsComponentImpl
WsComponent.destroy()
public void initialize(java.lang.Object config) throws ComponentDisabledException, ConfigurationWarning, ConfigurationError
initialize
in interface WsComponent
initialize
in class WsComponentImpl
config
- The configuration data for the component. The value may
be null or some other object if no configuration data is present. Note that
this argument may be removed.
ComponentDisabledException
- Thrown if the component considers itself to
be disabled. No further lifecycle methods will be called by the framework.
ConfigurationWarning
- Thrown if the component has encountered some
non-fatal configuration problem. Server startup will generally continue.
ConfigurationError
- The component has severe configuration
problem and cannot allow the server startup to proceed. Note that this
exception will halt server startup.WsComponent.initialize(Object)
public void start() throws RuntimeError, RuntimeWarning
start
in interface WsComponent
start
in class WsComponentImpl
RuntimeError
RuntimeWarning
WsComponent.start()
public void stop()
stop
in interface WsComponent
stop
in class WsComponentImpl
WsComponent.stop()
protected java.util.List loadComponents(java.lang.String extensionPointId) throws ConfigurationError
Example:
loadComponents("com.ibm.ws.runtime.MyExtensionPointId");
extensionPointId
- specifies the name of the extension point that controls this
container.
ConfigurationError
protected void startComponents() throws RuntimeWarning, RuntimeError
RuntimeWarning
RuntimeError
protected void stopComponents()
protected void destroyComponents()
protected void initializeComponents(org.eclipse.emf.ecore.EObject rootConfig, com.ibm.ws.runtime.config.ConfigLocator[] locators) throws ConfigurationWarning, ConfigurationError
rootConfig
- locators
-
ConfigurationWarning
ConfigurationError
- TODO: EMF (EObject) bleeds through this interface which is unintentional.
Should this simply be Object?protected boolean add(WsComponent o)
o
-
protected boolean remove(WsComponent o)
o
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |