com.ibm.ws.javax.activity
Class Signal

java.lang.Object
  |
  +--com.ibm.ws.javax.activity.Signal
public class Signal
extends java.lang.Object

Signals are events that are broadcast to interested parties as part of a coordinated SignalSet. Each Signal is uniquely identified by a combination of its SignalName and the name of the containing SignalSet.

Constructor Summary
Signal(java.lang.String signalName, java.lang.String ssName, org.omg.CORBA.Any extData)
          Constructor used by the Activity service or HLS to create a Signal object.
Signal(java.lang.String signalName, java.lang.String ssName, java.rmi.MarshalledObject propagatedExtData)
          Constructor used by the Activity service to create a Signal object.
Signal(java.lang.String signalName, java.lang.String ssName, java.io.Serializable extData)
          Constructor used by a HLS to create a Signal object.
 
Method Summary
 org.omg.CORBA.Any getExtendedAny()
          Returns a CORBA Any that contains information specific to the Signal.
 java.io.Serializable getExtendedValue()
          Returns a java.io.Serializable that contains information specific to the Signal.
 java.lang.String getName()
          Returns a String that identifies the Signal name.
 java.lang.String getSignalSetName()
          Returns a String that identifies the name of the SignalSet that produced the Signal.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Signal

public Signal(java.lang.String signalName,
              java.lang.String ssName,
              java.io.Serializable extData)
Constructor used by a HLS to create a Signal object. The Activity service encapsulates the Serializable extData in a java.rmi.MarshalledObject to avoid class-loading problems when propagating CosActivity.Signal structures containing this object.

Parameters:
signalName - The name of the Signal.
ssName - The name of the SignalSet that produces the Signal.
extData - Data that is specific to a particular SignalSet implementation.

Signal

public Signal(java.lang.String signalName,
              java.lang.String ssName,
              java.rmi.MarshalledObject propagatedExtData)
Constructor used by the Activity service to create a Signal object. It is used by the Activity service when processing a received CosActivity.Signal if the CosActivity.Signal.application_specific_data field of that Signal contains a MarshalledObject.

Parameters:
signalName - The name of the Signal.
ssName - The name of the SignalSet that produces the Signal.

Signal

public Signal(java.lang.String signalName,
              java.lang.String ssName,
              org.omg.CORBA.Any extData)
Constructor used by the Activity service or HLS to create a Signal object.
It is used by the Activity service when processing a received CosActivity.Signal if the CosActivity.Signal.application_specific_data field of that Signal does not contain a MarshalledObject.
It may also used by a HLS to create a Signal.

Parameters:
signalName - The name of the Signal.
ssName - The name of the SignalSet that produces the Signal.
extData - Data that is specific to a particular SignalSet implementation.
Method Detail

getName

public java.lang.String getName()
Returns a String that identifies the Signal name.

Returns:
The Signal name.

getSignalSetName

public java.lang.String getSignalSetName()
Returns a String that identifies the name of the SignalSet that produced the Signal.

Returns:
The SignalSet name.

getExtendedValue

public java.io.Serializable getExtendedValue()
Returns a java.io.Serializable that contains information specific to the Signal. If this extended data is not a Serializable object then this method returns null and getExtendedAny should be called instead.

Returns:
A java.io.Serializable that contains information specific to the Signal. Returns null if the extended data is not a Serializable object.

getExtendedAny

public org.omg.CORBA.Any getExtendedAny()
Returns a CORBA Any that contains information specific to the Signal.

Returns:
A CORBA Any that contains information specific to the Signal.

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.