Class
Tree
          
SUMMARY: INNER | FIELD | CONSTR | METHODDETAIL: FIELD | CONSTR | METHOD
  
com.newstep.solid.management.runtime.component
Class Component
com.newstep.solid.management.runtime.AsyncManagedExecutable
  |
  +--com.newstep.solid.management.runtime.component.Component
All Implemented Interfaces:
       ManagedExecutable
Direct Known Subclasses:
       DirComponent, SampleComponent
public abstract class Component      
A initializable and manageable component in the system.

Ability to start within a node (given its own classloader) or in a stand
alone mode. Each component has an environment ComponentEnvironment
that is available in containment or stand-alone mode
In Stand Alone
Mode: initStandAlone - provides all start-up necessary given a particular
managment configuration. It does the following:



In Containment Mode: Given an appropriate deployment descriptor the
component will run the same as it would if it were in its own vm. There
loading and environment is not the same but will be transparent to the
component as if it were running stand-alone. Since many of the services are
shared amongst components in this mode, including


The component makes an attempt at cleaning up ComponentStateListener,
when an appropriate end state is reached. A component becomes unmanageable
when clean up is called.
Version:
1.0
Author:
msimonsen
Abstract.
 
Links:
Kernel Association Association Link
to Class ComponentEnvironment
Associates type:
association
Client cardinality:
1
Client navigability:
NOT NAVIGABLE
Client visibility:
private
Supplier cardinality:
1
Supplier navigability:
NAVIGABLE
Supplier visibility:
private
 
Kernel Association Association Link
to Class ComponentManager
Associates type:
association
Client cardinality:
1
Client navigability:
NOT NAVIGABLE
Client visibility:
private
Supplier cardinality:
1
Supplier navigability:
NAVIGABLE
Supplier visibility:
private
 
Kernel Association Association Link
to Class ComponentLogger
Associates type:
association
Client cardinality:
1
Client navigability:
NOT NAVIGABLE
Client visibility:
private
Supplier cardinality:
1
Supplier navigability:
NAVIGABLE
Supplier visibility:
protected
 
Generalization Generalization Link
to Class AsyncManagedExecutable
A initializable and manageable component in the system.

Ability to start within a node (given its own classloader) or in a stand
alone mode. Each component has an environment ComponentEnvironment
that is available in containment or stand-alone mode
In Stand Alone
Mode: initStandAlone - provides all start-up necessary given a particular
managment configuration. It does the following:



In Containment Mode: Given an appropriate deployment descriptor the
component will run the same as it would if it were in its own vm. There
loading and environment is not the same but will be transparent to the
component as if it were running stand-alone. Since many of the services are
shared amongst components in this mode, including


The component makes an attempt at cleaning up ComponentStateListener,
when an appropriate end state is reached. A component becomes unmanageable
when clean up is called.
Author:
msimonsen
Custom properties
version:
1.0
 
 
Field Summary
private final static String
protected ComponentLogger
private static Logger
Constructor Summary
protected void
Method Summary
protected void
public String
protected void
init(String args)
public abstract void
init(Configuration configuration, String args)
protected abstract ComponentConfiguration
loadConfig(String args)
public void
Field Detail
className
private final static String className
Final.
Multiplicity:
1
Static.
 
compLogger
protected ComponentLogger compLogger
Multiplicity:
1
 
componentEnv
private ComponentEnvironment componentEnv
Multiplicity:
1
 
componentManager
private ComponentManager componentManager
Multiplicity:
1
 
logger
private static Logger logger
Multiplicity:
1
Static.
 
Constructor Detail
Component
protected void Component ()
 
Default constructor. Initiate a component Loggger.
Stereotype:
create
 
Method Detail
cleanUp
protected void cleanUp ()
 
Performs clean up on the component. This will most likely be called when
a end-state of the component is reached - ComponentStateListener
Throws:
IOException
 
getEnvironment
public ComponentEnvironment getEnvironment ()
 
 
Return:
ComponentEnvironment
 
getName
public String getName ()
 
Get the name of the component. This component's manager + subsystem are
registered under this domain name.
Return:
The name of the component - corresponds to its manageable domain.
 
init
protected void init (String args)
 
Initializes a component in stand-alone mode. Allows component to start
the managment framework. The component must write its own main method.
Parameters:
args -
the command line arguments
Throws:
ExecutableException,ConfigurationException
 
init
public abstract void init (Configuration configuration, String args)
 
A component implementation will be initialized by either the node in
which is sits resident or from the standAlone mode.
Parameters:
configuration
args
Abstract.
Throws:
ExecutableException
 
loadConfig
protected abstract ComponentConfiguration loadConfig (String args)
 
An implementation of Component must know how to load its own
configuration.
Parameters:
args
Return:
ComponentConfiguration - The components loaded configuration
Abstract.
Throws:
ConfigurationException
 
setEnvironment
public void setEnvironment (ComponentEnvironment env)
 
 
Class
Tree
          
SUMMARY: INNER | FIELD | CONSTR | METHODDETAIL: FIELD | CONSTR | METHOD