com.tivoli.twg.engine
Class TWGRemoteTaskActivation

java.lang.Object
  extended bycom.tivoli.twg.engine.TWGRemoteTaskActivation

public class TWGRemoteTaskActivation
extends java.lang.Object

This class is a container for all the information about a remote task activation. This allows task servers running in a JVM other than the core server's JVM to obtain task activation information.


Method Summary
 void deactivate()
          Deactivate the subtask activation represented by this TWGRemoteTaskActivation object.
 void deactivate(int status)
          Deactivate the subtask activation represented by this TWGRemoteTaskActivation object
 void deactivate(long moid, int status)
          Deactivate specified client with specified status
 TWGRemoteTaskClients getClients()
          Get the collection of remote task clients for this activation.
 long getEngActID()
          Get the ID assigned to this activation by the core engine.
 LongValueSet getFoid()
          Get the set of filter IDs for this activaiton.
 TWGLog getLog()
          Get the log object to use for logging status messages during this task activation.
 java.lang.String getLogName()
          Get the name of the log to use for logging status messages during this task activation.
 LongValueSet getMoid()
          Get the set of managed object IDs for this activation.
 long getRmtActID()
          Get the ID assigned to this activation by TWGRemoteTaskManager.
 ServiceNode getServiceNode()
           
 java.lang.String getSubtaskID()
          Get the subtask identifier of the subtask being activated.
 byte[] getTaskActData()
          Get the taskActData for this activation
 java.lang.String getTaskID()
          Get the task identifier of the task being activated.
 long getToid()
          Get the object id of the task being activated.
static long getTotal()
          Get the total number of task activations that have occurred since the JVM has been started.
 void logMessage(java.lang.String message, int level)
          Log a non-translatable message to the log associeated with this activation.
 void logMessage(java.lang.String message, int level, int correlator)
          Log a non-translatable message to the log associeated with this activation.
 void logMessage(java.lang.String message, int level, TWGRemoteManagedObject rmo)
          Log a non-translatable message to the log associeated with this activation.
 void logMessage(java.lang.String bundleName, java.lang.String messageKey, int level)
          Log a message to the log associated with this activation.
 void logMessage(java.lang.String bundleName, java.lang.String messageKey, int level, int correlator)
          Log a message to the log associated with this activation.
 void logMessage(java.lang.String bundleName, java.lang.String messageKey, int level, TWGRemoteManagedObject rmo)
          Log a message to the log associated with this activation.
 void setLogName(java.lang.String logName)
          Set the name for the log for this activation if it's not already set.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getServiceNode

public ServiceNode getServiceNode()

getTotal

public static long getTotal()
Get the total number of task activations that have occurred since the JVM has been started.

Returns:
long total number of activations.

getRmtActID

public long getRmtActID()
Get the ID assigned to this activation by TWGRemoteTaskManager.

Returns:
long remote activation ID.

getEngActID

public long getEngActID()
Get the ID assigned to this activation by the core engine.

Returns:
long engine activation ID.

getToid

public long getToid()
Get the object id of the task being activated.

Returns:
long task object ID

getTaskID

public java.lang.String getTaskID()
Get the task identifier of the task being activated.

Returns:
String task identifier.

getSubtaskID

public java.lang.String getSubtaskID()
Get the subtask identifier of the subtask being activated.

Returns:
String subtask identifier.

getLogName

public java.lang.String getLogName()
Get the name of the log to use for logging status messages during this task activation.

Returns:
String log name.

getLog

public TWGLog getLog()
Get the log object to use for logging status messages during this task activation.

Returns:
TWGLog

getClients

public TWGRemoteTaskClients getClients()
Get the collection of remote task clients for this activation.

Returns:
TWGRemoteTaskClients

getMoid

public LongValueSet getMoid()
Get the set of managed object IDs for this activation.

Returns:
LongValueSet

getFoid

public LongValueSet getFoid()
Get the set of filter IDs for this activaiton.

Returns:
LongValueSet

getTaskActData

public byte[] getTaskActData()
Get the taskActData for this activation

Returns:
byte[]

deactivate

public void deactivate(int status)
Deactivate the subtask activation represented by this TWGRemoteTaskActivation object

Parameters:
status - final status for this activation, see constants starting with TWGTaskConstants.ACT_STATUS_ for values.

deactivate

public void deactivate(long moid,
                       int status)
Deactivate specified client with specified status

Parameters:
moid - managed object ID
status - final status for specified MO, see constants starting with TWGTaskConstants.ACT_STATUS_ for values.

deactivate

public void deactivate()
Deactivate the subtask activation represented by this TWGRemoteTaskActivation object. The status will be set to TWGTaskConstants.ACT_STATUS_COMPLETE.


setLogName

public void setLogName(java.lang.String logName)
Set the name for the log for this activation if it's not already set. If the log name has already been set either by this method or by the scheduler then this method call is ignored.

Parameters:
logName - the name to assign the log

logMessage

public void logMessage(java.lang.String bundleName,
                       java.lang.String messageKey,
                       int level,
                       int correlator)
Log a message to the log associated with this activation. If there is no log, this method call is basically a no-op.

Parameters:
bundleName - the fully qualified name of the bundle to retrieve the locale specific version of the message text.
messageKey - the key to use to retrieve the message from the bundle Note: If your message has string substitutions (i.e. {0}, {1}, etc. that you need to use with MessageFormat, then the substitution values should be appended to the message key using the vertical bar ("|") as a delimiter.
level - the level of detail of the message for selective display; currently, 0-99=low, 100-199=medium, >200=high
correlator - If the message being logged pertains to a specific managed object, then this value should be the object's ID (moid) cast to an int; otherwise, this value should be 0.

logMessage

public void logMessage(java.lang.String bundleName,
                       java.lang.String messageKey,
                       int level,
                       TWGRemoteManagedObject rmo)
Log a message to the log associated with this activation. If there is no log, this method call is basically a no-op.

Parameters:
bundleName - the fully qualified name of the bundle to retrieve the locale specific version of the message text.
messageKey - the key to use to retrieve the message from the bundle Note: If your message has string substitutions (i.e. {0}, {1}, etc. that you need to use with MessageFormat, then the substitution values should be appended to the message key using the vertical bar ("|") as a delimiter.
level - the level of detail of the message for selective display; currently, 0-99=low, 100-199=medium, >200=high

logMessage

public void logMessage(java.lang.String bundleName,
                       java.lang.String messageKey,
                       int level)
Log a message to the log associated with this activation. If there is no log, this method call is basically a no-op.

Parameters:
bundleName - the fully qualified name of the bundle to retrieve the locale specific version of the message text.
messageKey - the key to use to retrieve the message from the bundle Note: If your message has string substitutions (i.e. {0}, {1}, etc. that you need to use with MessageFormat, then the substitution values should be appended to the message key using the vertical bar ("|") as a delimiter.
level - the level of detail of the message for selective display; currently, 0-99=low, 100-199=medium, >200=high

logMessage

public void logMessage(java.lang.String message,
                       int level)
Log a non-translatable message to the log associeated with this activation. If there is no log, this method call is basically a no-op.

Parameters:
message - the non-translatable message text to log
level - the level of detail of the message for selective display; currently, 0-99=low, 100-199=medium, >200=high

logMessage

public void logMessage(java.lang.String message,
                       int level,
                       TWGRemoteManagedObject rmo)
Log a non-translatable message to the log associeated with this activation. If there is no log, this method call is basically a no-op.

Parameters:
message - the non-translatable message text to log
level - the level of detail of the message for selective display; currently, 0-99=low, 100-199=medium, >200=high

logMessage

public void logMessage(java.lang.String message,
                       int level,
                       int correlator)
Log a non-translatable message to the log associeated with this activation. If there is no log, this method call is basically a no-op.

Parameters:
message - the non-translatable message text to log
level - the level of detail of the message for selective display; currently, 0-99=low, 100-199=medium, >200=high
correlator - If the message being logged pertains to a specific managed object, then this value should be the object's ID (moid) cast to an int; otherwise, this value should be 0.