com.ibm.ws.javax.activity.propertygroup
Interface PropertyGroup

public interface PropertyGroup

A PropertyGroup is used to provide distributed context, scoped to an Activity, that may be set by an application or a high-level service (HLS) built on top of the Activity service. The format of the distributed context is specific to the PropertyGroup implementation and is neither examined nor understood by the Activity service. The semantics of the behavioural relationship between PropertyGroups in nested Activities is defined by the specification of each type of PropertyGroup and not by the Activity service.
Any number of named PropertyGroup types may be registered with the Activity service. When an Activity is started, an instance of each type of PropertyGroup used by the Activity is created and associated with the Activity. The types of PropertyGroup used by an Activity may be specified through the ServiceManager object registered for a particular HLS.

Method Summary
 void completed()
          Called by the Activity service as part of its completion processing to give the PropertyGroup the opportunity to perform any necessary clean-up work.
 java.lang.String getPropertyGroupName()
          Returns the name of the target PropertyGroup.
 void resumed()
          Called to inform the PropertyGroup that the Activity it represents has been resumed.
 void suspended()
          Called to inform the PropertyGroup that the Activity it represents has been suspended.
 

Method Detail

getPropertyGroupName

public java.lang.String getPropertyGroupName()
Returns the name of the target PropertyGroup.

Returns:
the name of the target PropertyGroup.

completed

public void completed()
Called by the Activity service as part of its completion processing to give the PropertyGroup the opportunity to perform any necessary clean-up work. The Activity with which this PropertyGroup is associated is not active on the thread when this call is made. Any parent Activity will be active on the thread.

suspended

public void suspended()
Called to inform the PropertyGroup that the Activity it represents has been suspended. The Activity with which this PropertyGroup is associated is still active on the thread when this call is made, but will be removed immediately after all suspended methods of registered PropertyGroups have been called. Any parent Activity will then become active.

resumed

public void resumed()
Called to inform the PropertyGroup that the Activity it represents has been resumed. The Activity with which this PropertyGroup is associated is already resumed on the thread when this call is made.

 

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.