com.ibm.websphere.appprofile
Interface TaskNameManager


public interface TaskNameManager

The TaskNameManager is the programmatic interface to the AppProfile function. Via this interface, programmers may set the current task name on the thread of execution. The task name must have been configured in the deployment descriptors as a task reference with associated with a task. The set task name's scope will be the duration of the method invocation in the ejb and web components and for the duration of the client process, or until the resetTaskName method is invoked.


Method Summary
 void resetTaskName()
          Sets the thread's task name to the value that was set at or imported into the beginning of the method invocation (for ejb and web components) or process (for J2EE clients).
 void setTaskName(java.lang.String taskName)
          Set the thread's current task name to the specified parameter.
 

Method Detail

setTaskName

public void setTaskName(java.lang.String taskName)
                 throws IllegalTaskNameException
Set the thread's current task name to the specified parameter. The task name must have been configured as a task reference with a corresponding task or the IllegalTaskName exception will be thrown.

Parameters:
taskName - Not null String that must have been properly linked in the deployment descriptors.
Throws:
IllegalTaskNameException - Thrown if the task name is null or not declared properly in the deployment descriptor.

resetTaskName

public void resetTaskName()
Sets the thread's task name to the value that was set at or imported into the beginning of the method invocation (for ejb and web components) or process (for J2EE clients).