org.objectweb.proactive.core.component
Class ControllerDescription

java.lang.Object
  extended byorg.objectweb.proactive.core.component.ControllerDescription
All Implemented Interfaces:
java.io.Serializable

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

Fractal implementation-specific description of the controllers of components. It is currently used to specify the hierarchical type and the name of the components.

It is also a place to specify custom controllers for a given component ; the configuration of the controllers is described in a properties file whose location can be given as a parameter.
The controllers configuration file is simple : it associates the signature of a controller interface with the implementation that has to be used.
During the construction of the component, the membrane is automatically constructed with these controllers. The controllers are linked together, and requests targetting a control interface visit the different controllers until they find the suitable controller, and then the request is executed on this controller.

Author:
Matthieu Morel
See Also:
Serialized Form

Field Summary
static java.lang.String DEFAULT_COMPONENT_CONFIG_FILE_LOCATION
           
 
Constructor Summary
ControllerDescription()
          a no-arg constructor (used in the ProActive parser)
ControllerDescription(ControllerDescription controllerDesc)
          copy constructor (clones the object)
ControllerDescription(java.lang.String name, java.lang.String hierarchicalType)
          constructor
ControllerDescription(java.lang.String name, java.lang.String hierarchicalType, boolean synchronous)
          Constructor for ControllerDescription.
ControllerDescription(java.lang.String name, java.lang.String hierarchicalType, java.lang.String controllersConfigFileLocation)
          Constructor for ControllerDescription.
ControllerDescription(java.lang.String name, java.lang.String hierarchicalType, java.lang.String controllersConfigFileLocation, boolean synchronous)
          Constructor for ControllerDescription.
ControllerDescription(java.lang.String name, java.lang.String hierarchicalType, java.lang.String controllersConfigFileLocation, java.lang.String interceptorsConfigFileLocation)
          Constructor for ControllerDescription.
 
Method Summary
 java.lang.String getControllersConfigFileLocation()
          Method getControllersConfigFileLocation.
 java.lang.String getHierarchicalType()
          Returns the hierarchicalType.
 java.lang.String getName()
          getter for the name
 boolean isSynchronous()
          Method isSynchronous.
 void setHierarchicalType(java.lang.String string)
          setter for hierarchical type
 void setName(java.lang.String name)
          setter for the name
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_COMPONENT_CONFIG_FILE_LOCATION

public static final java.lang.String DEFAULT_COMPONENT_CONFIG_FILE_LOCATION
See Also:
Constant Field Values
Constructor Detail

ControllerDescription

public ControllerDescription()
a no-arg constructor (used in the ProActive parser)


ControllerDescription

public ControllerDescription(java.lang.String name,
                             java.lang.String hierarchicalType)
constructor

Parameters:
name - the name of the component
hierarchicalType - the hierachical type of the component. See Constants

ControllerDescription

public ControllerDescription(java.lang.String name,
                             java.lang.String hierarchicalType,
                             boolean synchronous)
Constructor for ControllerDescription.

Parameters:
name - String
hierarchicalType - String
synchronous - boolean

ControllerDescription

public ControllerDescription(java.lang.String name,
                             java.lang.String hierarchicalType,
                             java.lang.String controllersConfigFileLocation)
Constructor for ControllerDescription.

Parameters:
name - String
hierarchicalType - String
controllersConfigFileLocation - String

ControllerDescription

public ControllerDescription(java.lang.String name,
                             java.lang.String hierarchicalType,
                             java.lang.String controllersConfigFileLocation,
                             java.lang.String interceptorsConfigFileLocation)
Constructor for ControllerDescription.

Parameters:
name - String
hierarchicalType - String
controllersConfigFileLocation - String
interceptorsConfigFileLocation - String

ControllerDescription

public ControllerDescription(java.lang.String name,
                             java.lang.String hierarchicalType,
                             java.lang.String controllersConfigFileLocation,
                             boolean synchronous)
Constructor for ControllerDescription.

Parameters:
name - String
hierarchicalType - String
controllersConfigFileLocation - String
synchronous - boolean

ControllerDescription

public ControllerDescription(ControllerDescription controllerDesc)
copy constructor (clones the object)

Parameters:
controllerDesc - the ControllerDescription to copy.
Method Detail

getHierarchicalType

public java.lang.String getHierarchicalType()
Returns the hierarchicalType.

Returns:
String

setHierarchicalType

public void setHierarchicalType(java.lang.String string)
setter for hierarchical type

Parameters:
string - hierarchical type. See Constants

getName

public java.lang.String getName()
getter for the name

Returns:
the name of the component

setName

public void setName(java.lang.String name)
setter for the name

Parameters:
name - name of the component

isSynchronous

public boolean isSynchronous()
Method isSynchronous.

Returns:
boolean

getControllersConfigFileLocation

public java.lang.String getControllersConfigFileLocation()
Method getControllersConfigFileLocation.

Returns:
String


Copyright 2001-2005 INRIA All Rights Reserved.