com.ibm.ws.javax.activity
Class PropertyGroupContext

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

The PropertyGroupContext utility object is provided by the Activity service to assist a PropertyGroupManager read and write org.omg.CosActivity.PropertyGroupIdentity context data during marshalling and unmarshalling of the org.omg.CosActivity.ActivityContext that incorporates it.

Constructor Summary
PropertyGroupContext(java.lang.String propertyGroupName, org.omg.CORBA.Any contextData)
          Constructor used by the Activity service or a PropertyGroupManager to hold the contents of the org.omg.CosActivity.PropertyGroupIdentity structure.
PropertyGroupContext(java.lang.String propertyGroupName, java.rmi.MarshalledObject contextData)
          Constructor used by the Activity service to hold the contents of a org.omg.CosActivity.PropertyGroupIdentity structure.
PropertyGroupContext(java.lang.String propertyGroupName, java.io.Serializable contextData)
          Constructor used by a PropertyGroupManager to hold the contents of the org.omg.CosActivity.PropertyGroupIdentity structure.
 
Method Summary
 org.omg.CORBA.Any getContextDataAny()
          Returns a CORBA Any that contains context data specific to the implementation of the PropertyGroupManager.
 java.io.Serializable getContextDataValue()
          Returns a java.io.Serializable that contains context data specific to the implementation of the PropertyGroupManager.
 java.lang.String getPropertyGroupName()
          Returns a String that identifies the PropertyGroup name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropertyGroupContext

public PropertyGroupContext(java.lang.String propertyGroupName,
                            java.io.Serializable contextData)
Constructor used by a PropertyGroupManager to hold the contents of the org.omg.CosActivity.PropertyGroupIdentity structure.
It is used by a PropertyGroupManager when it is marshaling an outbound request or response context in the case where the contextData is a java.io.Serializable object. The Activity service encapsulate the Serializable contextData in a java.rmi.MarshalledObject to avoid class-loading problems when propagating PropertyGroupIdentity structures containing this object.

Parameters:
propertyGroupName - The name of the PropertyGroup.
contextData - Data that is specific to a particular PropertyGroupManager implementation.

PropertyGroupContext

public PropertyGroupContext(java.lang.String propertyGroupName,
                            java.rmi.MarshalledObject contextData)
Constructor used by the Activity service to hold the contents of a org.omg.CosActivity.PropertyGroupIdentity structure.
It is used by the Activity service when importing an Activity service context if the PropertyGroupIdentity.context_data of that context contains a MarshalledObject.

Parameters:
propertyGroupName - The name of the PropertyGroup.
contextData - Data that is specific to a particular PropertyGroupManager implementation.

PropertyGroupContext

public PropertyGroupContext(java.lang.String propertyGroupName,
                            org.omg.CORBA.Any contextData)
Constructor used by the Activity service or a PropertyGroupManager to hold the contents of the org.omg.CosActivity.PropertyGroupIdentity structure.
It is used by the Activity service when importing an Activity service context if the PropertyGroupIdentity.context_data of that context does not contain a MarshalledObject.
It may also be used by a PropertyGroupManager when it is marshaling an outbound request or response context in the case where the contextData is not a java.io.Serializable object.

Parameters:
propertyGroupName - The name of the PropertyGroup.
contextData - Data that is specific to a particular PropertyGroupManager implementation.
Method Detail

getPropertyGroupName

public java.lang.String getPropertyGroupName()
Returns a String that identifies the PropertyGroup name.

Returns:
The name of the PropertyGroup that has been received from or is to be inserted into the CosActivity.PropertyGroupIdentity.property_group_name field of the Activity context.

getContextDataAny

public org.omg.CORBA.Any getContextDataAny()
Returns a CORBA Any that contains context data specific to the implementation of the PropertyGroupManager.

Returns:
A CORBA Any that contains the context data that has been received from or is to be inserted into the org.omg.CosActivity.PropertyGroupIdentity.context_data field of the Activity context. Only the PropertyGroupManager has the knowledge required to understand the structure of the context data.

getContextDataValue

public java.io.Serializable getContextDataValue()
Returns a java.io.Serializable that contains context data specific to the implementation of the PropertyGroupManager. If the context data is not a Serializable object then this method returns null and getContextDataAny should be called instead.

Returns:
A java.io.Serializable object that represents the context data that has been that has been received from or is to be inserted into the org.omg.CosActivity.PropertyGroupIdentity.context_data field of the Activity context. Only the PropertyGroupManager has the knowledge required to understand the structure of the contextData.
Returns null if the context data is not a Serializable object.

 

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.