TaskManagement MBean

Partial ObjectName:
WebSphere:*,type=TaskManagement


MBean TaskManagement

Management interface for the Task Management service.


Operation Summary
voidsubmit(java.util.List taskReports)
           Not for public use.
voidsubmit(com.ibm.ws.taskmanagement.task.TaskReport taskReport)
           Not for public use.
voidsubmit(com.ibm.ws.taskmanagement.task.TaskReport taskReport, long[] gids)
           Not for public use.
voidaccept(long taskId)
           Marks an approval task as accepted
voiddeny(long taskId)
           Marks an approval task as denied
voidpreview(long taskId)
           Marks an approval task as ready for preview
voidcommit(long taskId)
           Marks a preview task as committed
voidrollback(long taskId)
           Marks a preview task as rolled back
voidclose(long taskId)
           Marks a manual or non-planned task as closed
voidupdateActionPlanStatus(com.ibm.ws.taskmanagement.task.ActionPlanStatus actionPlanStatus)
           Not for public use.
com.ibm.ws.taskmanagement.task.DisplayTaskgetTask(long taskId)
           Not for public use.
java.util.SetgetTasks()
           Retrieves all active tasks from the TaskManagement service
java.util.SetgetTasksByComponent(java.lang.String componentId)
           Retrieves all active tasks from the TaskManagement service for a specific component
java.util.SetgetTasksByTargetObjectContext(java.lang.String targetObjectContext)
           Gets the set of tasks from the TaskManagement service for a specific targetObject configuration.
java.util.SetgetTasksBySeverity(byte severity)
           Retrieves all active tasks from the TaskManagement service with a particular severity
java.util.SetgetPlannedTasks()
           Retrieves all planned active tasks from the TaskManagement service
java.util.SetgetNonPlannedTasks()
           Retrieves all nonplanned active tasks from the TaskManagement service
java.util.SetgetTerminatedTasks()
           Retrieves all terminated tasks from the TaskManagement service
java.lang.IntegernumberofActiveTasks(java.lang.String targetObjectContext)
           Retrieves the number of active tasks for a specific target object context
com.ibm.ws.taskmanagement.task.TaskActionPlangetActionPlan(long taskId)
           Not for public use.
com.ibm.ws.taskmanagement.task.TaskStategetCurrentState(long taskId)
           Retrieves the current state of a specific task in the TaskManagement service
java.lang.BytegetGlobalSeverity(long taskId)
           Retrieves the current severity of a specific task in the TaskManagement service
voiddelete(long taskId)
           Deletes one task from the task collection
voiddelete(long[] taskIds)
           Deletes one or more tasks from the task collection
voidaddPolicy(com.ibm.ws.taskmanagement.task.TaskPolicy policy, long taskId)
           Not for public use.
voidremovePolicy(com.ibm.ws.taskmanagement.task.TaskPolicy policy, long taskId)
           Not for public use.
java.util.ListgetPolicies(long taskId)
           Gets all policies associated with a task

Notification Summary
websphere.taskmanagement.tasknew
           A Node Has Been Added To the NodeGroup.
websphere.taskmanagement.taskstatechange
           A Node Has Been Added To the NodeGroup.
websphere.taskmanagement.taskseveritychange
           A Node Has Been Removed From the NodeGroup.
websphere.taskmanagement.tasksstatus
           A Node Has Been Removed From the NodeGroup.

Operation Detail

submit

public void submit(java.util.List taskReports)
Not for public use. Submit new task reports to the Task Management service.
Parameters:
taskReports - A list of new TaskReport objects.
Security Roles:
administrator
operator

submit

public void submit(com.ibm.ws.taskmanagement.task.TaskReport taskReport)
Not for public use. Submit a new task report to the Task Management service.
Parameters:
taskReport - A TaskReport object.
Security Roles:
administrator
operator

submit

public void submit(com.ibm.ws.taskmanagement.task.TaskReport taskReport, long[] gids)
Not for public use. Submit a new task report to the Task Management service with the tasks global ids.
Parameters:
taskReport - A TaskReport object.
gids - Array of GIDs for the tasks in the TaskReport being submitted.
Security Roles:
administrator
operator

accept

public void accept(long taskId)
Marks an approval task as accepted
Parameters:
taskId - The ID of the accepted task
Security Roles:
administrator
operator

deny

public void deny(long taskId)
Marks an approval task as denied
Parameters:
taskId - The ID of the denied task
Security Roles:
administrator
operator

preview

public void preview(long taskId)
Marks an approval task as ready for preview
Parameters:
taskId - The ID of the task to be previewed
Security Roles:
administrator
operator

commit

public void commit(long taskId)
Marks a preview task as committed
Parameters:
taskId - The ID of the task to be committed
Security Roles:
administrator
operator

rollback

public void rollback(long taskId)
Marks a preview task as rolled back
Parameters:
taskId - The ID of the task to be rolled back
Security Roles:
administrator
operator

close

public void close(long taskId)
Marks a manual or non-planned task as closed
Parameters:
taskId - The ID of the closed task
Security Roles:
administrator
operator

updateActionPlanStatus

public void updateActionPlanStatus(com.ibm.ws.taskmanagement.task.ActionPlanStatus actionPlanStatus)
Not for public use. Update the status of an executing action plan.
Parameters:
actionPlanStatus - The updated action plan status.
Security Roles:
administrator
operator

getTask

public com.ibm.ws.taskmanagement.task.DisplayTask getTask(long taskId)
Not for public use. Retrieve a task by ID from the TaskManagement service
Parameters:
taskId - The ID of the task to get
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getTasks

public java.util.Set getTasks()
Retrieves all active tasks from the TaskManagement service
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getTasksByComponent

public java.util.Set getTasksByComponent(java.lang.String componentId)
Retrieves all active tasks from the TaskManagement service for a specific component
Parameters:
componentId - The ID of the task submitting component
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getTasksByTargetObjectContext

public java.util.Set getTasksByTargetObjectContext(java.lang.String targetObjectContext)
Gets the set of tasks from the TaskManagement service for a specific targetObject configuration.
Parameters:
targetObjectContext - The config context of the target object
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getTasksBySeverity

public java.util.Set getTasksBySeverity(byte severity)
Retrieves all active tasks from the TaskManagement service with a particular severity
Parameters:
severity - The severity of the task to retrieve
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getPlannedTasks

public java.util.Set getPlannedTasks()
Retrieves all planned active tasks from the TaskManagement service
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getNonPlannedTasks

public java.util.Set getNonPlannedTasks()
Retrieves all nonplanned active tasks from the TaskManagement service
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getTerminatedTasks

public java.util.Set getTerminatedTasks()
Retrieves all terminated tasks from the TaskManagement service
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

numberofActiveTasks

public java.lang.Integer numberofActiveTasks(java.lang.String targetObjectContext)
Retrieves the number of active tasks for a specific target object context
Parameters:
targetObjectContext - The config context of the target object
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getActionPlan

public com.ibm.ws.taskmanagement.task.TaskActionPlan getActionPlan(long taskId)
Not for public use. Retrieves the action plan for a specific Planned task in the TaskManagement service
Parameters:
taskId - The id of the task to retrieve the actionplan for
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getCurrentState

public com.ibm.ws.taskmanagement.task.TaskState getCurrentState(long taskId)
Retrieves the current state of a specific task in the TaskManagement service
Parameters:
taskId - The id of the task
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getGlobalSeverity

public java.lang.Byte getGlobalSeverity(long taskId)
Retrieves the current severity of a specific task in the TaskManagement service
Parameters:
taskId - The id of the task
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

delete

public void delete(long taskId)
Deletes one task from the task collection
Parameters:
taskId - A task ID that identifies one task to be deleted
Security Roles:
administrator
operator

delete

public void delete(long[] taskIds)
Deletes one or more tasks from the task collection
Parameters:
taskIds - An array of task IDs that identifies tasks to be deleted
Security Roles:
administrator
operator

addPolicy

public void addPolicy(com.ibm.ws.taskmanagement.task.TaskPolicy policy, long taskId)
Not for public use. Adds a policy to a task
Parameters:
policy - A policy that is to be added to a task
taskId - A task ID that identifies one task to which a policy is to be added
Security Roles:
administrator
operator

removePolicy

public void removePolicy(com.ibm.ws.taskmanagement.task.TaskPolicy policy, long taskId)
Not for public use. Removes a policy from a task
Parameters:
policy - A policy that is to be removed from a task
taskId - A task ID that identifies one task from which a policy is to be removed
Security Roles:
administrator
operator

getPolicies

public java.util.List getPolicies(long taskId)
Gets all policies associated with a task
Parameters:
taskId - A task ID that identifies one task for which all policies should be listed
Security Roles:
administrator
operator

Notification Detail

websphere.taskmanagement.tasknew

A Node Has Been Added To the NodeGroup.
Severity:
5  (Warning)

websphere.taskmanagement.taskstatechange

A Node Has Been Added To the NodeGroup.
Severity:
5  (Warning)

websphere.taskmanagement.taskseveritychange

A Node Has Been Removed From the NodeGroup.
Severity:
5  (Warning)

websphere.taskmanagement.tasksstatus

A Node Has Been Removed From the NodeGroup.
Severity:
5  (Warning)

Copyright IBM Corp. 1996-2005