Skip navigation links

oracle.soa.management.facade
Interface CompositeInstance

All Superinterfaces:

java.io.Serializable

public interface CompositeInstance

extends java.io.Serializable

SCA composite instance facade, contains child component instances, sensor data and other useful information.

  // for each of the returned composite instances..
  for (CompositeInstance instance : obInstances) 
  {
      System.out.println(" DN: " + instance.getCompositeDN() +
                         " > Instance: " + instance.getId() + 
                         " creation-date: " + instance.getCreationDate() +
                         " state (" + instance.getState() + "): " +
                         getStateAsString(instance.getState()));
      
      // setup a component filter    
      ComponentInstanceFilter cInstanceFilter =
          new ComponentInstanceFilter ();

      // get child component instances ..
      List <ComponentInstance> childComponentInstances = 
          instance.getChildComponentInstances(cInstanceFilter);
      for (ComponentInstance cInstance : childComponentInstances) 
      {
          System.out.println("  -> componentinstance: " + 
                             cInstance.getComponentName() + " type: " + 
                             cInstance.getServiceEngine().getEngineType()+
                             " state: " + 
                             getStateAsString(cInstance.getState()));
      }
      // retrieve composite sensors
      List <SensorData> sensorData = instance.getSensorData();
      for (SensorData data : sensorData) 
      {
          System.out.println(" -> Sensor: " + 
                             data.getSensor().getName() + 
                             " data: " + data.getData() + 
                             " type: " +data.getSensor() +
                             " on component: " + data.getComponentName());
      }
  }
 

Field Summary

static int	STATE_COMPLETED Deprecated.
static int	STATE_COMPLETED_SUCCESSFULLY
static int	STATE_FAULTED
static int	STATE_IN_FLIGHT Deprecated.
static int	STATE_RECOVERY_REQUIRED
static int	STATE_RUNNING
static int	STATE_STALE
static int	STATE_SUSPENDED
static int	STATE_TERMINATED_BY_USER
static int	STATE_UNKNOWN

Method Summary

void	abort() Abort the composite instance.
void	delete() Delete this instance.
java.lang.String	getActionName()
java.lang.String	getActionType()
java.lang.String	getAuditTrail() Returns the audit trail of this composite instance.
java.util.List<ComponentInstance>	getChildComponentInstances(ComponentInstanceFilter filter) Returns a list of the child component instances that matches the conditions specified by the given filter.
CompositeDN	getCompositeDN() Returns the DN of the composite.
java.lang.String	getConversationId() Returns the conversationId of this instance.
java.util.Date	getCreationDate() Returns the creation date of this instance.
java.lang.String	getCreator() Returns the creator date of this instance.
java.lang.String	getECID() Returns the ECID of this instance.
int	getFaultCount() Returns the no.
long	getId()
java.util.Date	getModifyDate() Returns the date this instance was last modified on.
java.lang.String	getParentId() Returns the parentId of this instance.
java.lang.String	getRootId() Returns the rootId of this instance.
java.util.List<SensorData>	getSensorData()
java.lang.String	getServiceName() Deprecated. Replaced by getSourceName()
java.lang.String	getSourceName()
java.lang.String	getSourceType()
int	getState() Returns the current state of this instance.
java.lang.String	getStatus() Retrieves the current status of this instance.
java.lang.String	getTestCase() Returns the test case name associated with this instance.
java.lang.String	getTestRunId() Returns the test run id associated with this instance.
java.lang.String	getTestRunName() Returns the test run name associated with this instance.
java.lang.String	getTestSuite() Returns the test suite name of the test associated with this instance.
java.lang.String	getTitle() Returns the title set for this composite instance
boolean	isTestCase() Is this composite instance a test case

Field Detail

STATE_IN_FLIGHT

@Deprecated
static final int STATE_IN_FLIGHT

Deprecated.

See Also:

Constant Field Values

STATE_COMPLETED

@Deprecated
static final int STATE_COMPLETED

Deprecated.

See Also:

Constant Field Values

STATE_UNKNOWN

static final int STATE_UNKNOWN

See Also:

Constant Field Values

STATE_RUNNING

static final int STATE_RUNNING

See Also:

Constant Field Values

STATE_RECOVERY_REQUIRED

static final int STATE_RECOVERY_REQUIRED

See Also:

Constant Field Values

STATE_COMPLETED_SUCCESSFULLY

static final int STATE_COMPLETED_SUCCESSFULLY

See Also:

Constant Field Values

STATE_FAULTED

static final int STATE_FAULTED

See Also:

Constant Field Values

STATE_TERMINATED_BY_USER

static final int STATE_TERMINATED_BY_USER

See Also:

Constant Field Values

STATE_SUSPENDED

static final int STATE_SUSPENDED

See Also:

Constant Field Values

STATE_STALE

static final int STATE_STALE

See Also:

Constant Field Values

Method Detail

getId

long getId()

getServiceName

@Deprecated
java.lang.String getServiceName()

Deprecated. Replaced by getSourceName()

getSourceName

java.lang.String getSourceName()

getSourceType

java.lang.String getSourceType()

getActionType

java.lang.String getActionType()

getActionName

java.lang.String getActionName()

getCompositeDN

CompositeDN getCompositeDN()

Returns the DN of the composite.

getTitle

java.lang.String getTitle()

Returns the title set for this composite instance

getChildComponentInstances

java.util.List<ComponentInstance> getChildComponentInstances(ComponentInstanceFilter filter)

Returns a list of the child component instances that matches the conditions specified by the given filter.

getCreationDate

java.util.Date getCreationDate()

Returns the creation date of this instance.

getECID

java.lang.String getECID()

Returns the ECID of this instance.

getCreator

java.lang.String getCreator()

Returns the creator date of this instance.

getModifyDate

java.util.Date getModifyDate()

Returns the date this instance was last modified on.

getState

int getState()

Returns the current state of this instance.

getStatus

java.lang.String getStatus()

Retrieves the current status of this instance. The status for the instance can be set via the setStatus() method from a BPELX java exec tag.

The semantics attached to the status value are the sole domain and responsibility of the developer.

getConversationId

java.lang.String getConversationId()

Returns the conversationId of this instance. When an instance is created the user may pass the process domain a user-specified key; this key has no system-specific meaning and is only available as a means for linking a Collaxa process instance with an external system.

The semantics attached to the status value are the sole domain and responsibility of the user.

getRootId

java.lang.String getRootId()

Returns the rootId of this instance. When an instance is created the user may pass the process domain a user-specified key. This key will then be passed as part of the requests to other processes being called. This key has no system-specific meaning and is only available as a means for identifying a set of related instances.

The semantics attached to the status value are the sole domain and responsibility of the user.

getParentId

java.lang.String getParentId()

Returns the parentId of this instance. When an instance is calling other instance, a system specified id is passed. This id is identified by the instance being called as the parentId. This id can be used to locate the caller of an instance.

The semantics attached to the status value are the sole domain and responsibility of the user.

isTestCase

boolean isTestCase()

Is this composite instance a test case

Returns:

true if the instance is a test case, false otherwise

getTestSuite

java.lang.String getTestSuite()

Returns the test suite name of the test associated with this instance.

Returns:

the test suite name if the instance is a test case, null otherwise.

getTestCase

java.lang.String getTestCase()

Returns the test case name associated with this instance.

Returns:

the test case name if the instance is a test case, null otherwise.

getTestRunId

java.lang.String getTestRunId()

Returns the test run id associated with this instance.

Returns:

the test run id if the instance is a test case, null otherwise.

getTestRunName

java.lang.String getTestRunName()

Returns the test run name associated with this instance.

Returns:

the test run name if the instance is a test case, null otherwise.

getAuditTrail

java.lang.String getAuditTrail()

Returns the audit trail of this composite instance.

abort

void abort()
           throws java.lang.Exception

Abort the composite instance. This will abort all the child component instances as well.

Throws:

java.lang.Exception

delete

void delete()
            throws java.lang.Exception

Delete this instance. All the child component instances will be deleted too.

Throws:

java.lang.Exception

getFaultCount

int getFaultCount()

Returns the no. of faultes occurred in the composite instance

getSensorData

java.util.List<SensorData> getSensorData()
                                         throws java.lang.Exception

Throws:

java.lang.Exception

Skip navigation links