org.objectweb.dsrg.sofa.deployment
Class ComponentHandle

java.lang.Object
  extended by org.objectweb.dsrg.sofa.deployment.ComponentHandle
All Implemented Interfaces:
java.io.Serializable

public class ComponentHandle
extends java.lang.Object
implements java.io.Serializable

Remote reference to component instance. Consists of two parts - deployment dock reference and component instance unique ID per dock.

See Also:
Serialized Form

Constructor Summary
ComponentHandle(DeploymentDock dock, java.lang.String id, java.lang.String hName, java.lang.String dpName, java.lang.String dpVersion)
          Creates new component instance reference.
 
Method Summary
 java.lang.String getComponentHierarchicalName()
          Get component hierarchical name.
 java.lang.String getComponentId()
          Get component instance unique ID.
 java.lang.String getDeploymentPlanName()
          Get the name of deployment plan by using which the component was deployed.
 java.lang.String getDeploymentPlanVersion()
          Get the name of deployment version by using which the component was deployed.
 DeploymentDock getDock()
          Get remote reference to deployment dock where component instance lives.
 void start()
          Start the component.
 void stop()
          Stops the component.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ComponentHandle

public ComponentHandle(DeploymentDock dock,
                       java.lang.String id,
                       java.lang.String hName,
                       java.lang.String dpName,
                       java.lang.String dpVersion)
Creates new component instance reference.

Parameters:
dock - Dock where component instance lives.
id - ID of the component instance.
hName - Hierarchical name of the component in the application.
Method Detail

getDock

public DeploymentDock getDock()
Get remote reference to deployment dock where component instance lives.

Returns:
Dock reference.

getComponentId

public java.lang.String getComponentId()
Get component instance unique ID.

Returns:
Returns ID.

getComponentHierarchicalName

public java.lang.String getComponentHierarchicalName()
Get component hierarchical name.

Returns:
Returns ID.

getDeploymentPlanName

public java.lang.String getDeploymentPlanName()
Get the name of deployment plan by using which the component was deployed.

Returns:
deployment plan name

getDeploymentPlanVersion

public java.lang.String getDeploymentPlanVersion()
Get the name of deployment version by using which the component was deployed.

Returns:
deployment plan version

start

public void start()
           throws java.rmi.RemoteException,
                  DeploymentErrorException
Start the component. (Only glue to DeploymentDock.startComponent()).

Throws:
java.rmi.RemoteException
DeploymentErrorException

stop

public void stop()
          throws java.rmi.RemoteException,
                 DeploymentErrorException
Stops the component. (Only glue to Deploymentdock.stopComponent()).

Throws:
java.rmi.RemoteException
DeploymentErrorException