WASScheduler MBean

Partial ObjectName:
WebSphere:*,type=WASScheduler


MBean WASScheduler

Exposes Scheduler API through JMX and also provides statistic info.


Attribute Summary

java.lang.LongpollInterval
          
java.lang.IntegerdaemonThreads
          
java.lang.IntegerquerySize
          

Operation Summary

voidstartDaemon(java.lang.Integer delay)
           Starts all of the Scheduler Daemon threads
voidstopDaemon()
           Stops all of the Scheduler Daemon threads
TaskInfo[]findTasksByName(java.lang.String name, java.lang.Integer beginIndex, java.lang.Integer endIndex)
           Finds all TaskInfo objects with a specified name and index range.
TaskStatus[]findTaskStatusByName(java.lang.String name, java.lang.Integer beginIndex, java.lang.Integer endIndex)
           Finds all TaskStatus objects with a specified name that were created by the caller's application.
TaskStatuscreate(TaskInfo taskinfo)
           Creates a task in the persistent store based upon the data found in the TaskInfo object.
java.lang.ObjectcreateTaskInfo(java.lang.Class taskInfoInterface)
           Creates an instance of the specified TaskInfo interface class.
TaskStatuscancel(java.lang.String taskId, java.lang.Boolean purgeAlso)
           Cancels a task.
TaskStatusgetStatus(java.lang.String taskId)
           Retrieves the current status of a task.
TaskInfogetTask(java.lang.String taskId)
           Retrieves the current task.
TaskStatuspurge(java.lang.String taskId)
           Deletes a completed or cancelled task from the persistent store.
TaskStatusresume(java.lang.String taskId)
           Resumes a task which has been suspended.
TaskStatussuspend(java.lang.String taskId)
           Suspends a task.

Attribute Detail

pollInterval

public java.lang.Long pollInterval

     

     

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager

     Setter:
     administrator
     operator


daemonThreads

public java.lang.Integer daemonThreads

     

     

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager

     Setter:
     administrator
     operator


querySize

public java.lang.Integer querySize

     

     

Security Roles:

     Getter:
     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager

     Setter:
     administrator
     operator


Operation Detail

startDaemon

public void startDaemon(java.lang.Integer delay)

     Starts all of the Scheduler Daemon threads

Parameters:

     delay - The number of milliseconds to wait before each Scheduler daemon thread starts the first poll.

Security Roles:

     administrator
     operator


stopDaemon

public void stopDaemon()

     Stops all of the Scheduler Daemon threads

Security Roles:

     administrator
     operator


findTasksByName

public TaskInfo[] findTasksByName(java.lang.String name, java.lang.Integer beginIndex, java.lang.Integer endIndex)

     Finds all TaskInfo objects with a specified name and index range.

Parameters:

     name - The name of the task to be found.
     beginIndex - The beginning index of the tasks to retrieve (0 is the first element).
     endIndex - The end index of the tasks to retrieve. If endIndex is greater than the total number of tasks, then the endIndex is ignored.

Security Roles:

     administrator
     operator


findTaskStatusByName

public TaskStatus[] findTaskStatusByName(java.lang.String name, java.lang.Integer beginIndex, java.lang.Integer endIndex)

     Finds all TaskStatus objects with a specified name that were created by the caller's application.

Parameters:

     name - The name of the task to be found.
     beginIndex - The beginning index of the tasks to retrieve (0 is the first element).
     endIndex - The end index of the tasks to retrieve. If endIndex is greater than the total number of tasks, then the endIndex is ignored.

Security Roles:

     administrator
     operator


create

public TaskStatus create(TaskInfo taskinfo)

     Creates a task in the persistent store based upon the data found in the TaskInfo object.

Parameters:

     taskinfo - Any object that implements the TaskInfo interface.

Security Roles:

     administrator
     operator


createTaskInfo

public java.lang.Object createTaskInfo(java.lang.Class taskInfoInterface)

     Creates an instance of the specified TaskInfo interface class.

Parameters:

     taskInfoInterface - The interface of the TaskInfo implementation you would like to create.

Security Roles:

     administrator
     operator


cancel

public TaskStatus cancel(java.lang.String taskId, java.lang.Boolean purgeAlso)

     Cancels a task.

Parameters:

     taskId - The Task ID of the task which is to be canceled.
     purgeAlso - Specifies that the task should be purged immediately.

Security Roles:

     administrator
     operator


getStatus

public TaskStatus getStatus(java.lang.String taskId)

     Retrieves the current status of a task.

Parameters:

     taskId - The Task ID of the task that was assigned when created.

Security Roles:

     administrator
     operator


getTask

public TaskInfo getTask(java.lang.String taskId)

     Retrieves the current task.

Parameters:

     taskId - The Task ID of the task that was assigned when created.

Security Roles:

     administrator
     operator


purge

public TaskStatus purge(java.lang.String taskId)

     Deletes a completed or cancelled task from the persistent store.

Parameters:

     taskId - The Task ID of the task to be deleted.

Security Roles:

     administrator
     operator


resume

public TaskStatus resume(java.lang.String taskId)

     Resumes a task which has been suspended.

Parameters:

     taskId - The Task ID of the task to be resumed.

Security Roles:

     administrator
     operator


suspend

public TaskStatus suspend(java.lang.String taskId)

     Suspends a task.

Parameters:

     taskId - The Task ID of the task to be suspended.

Security Roles:

     administrator
     operator


Copyright IBM Corporation 2002, 2012