TaskRuntimeMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Exposes monitoring information about an ongoing and potentially long-running administrative process. This should be taken to mean, at minimum, any OA&M operation involving I/O. Examples include starting and stopping servers, deploying and undeploying applications, or migrating services.

An MBean operation of this sort should fork a separate thread to perform the actual work and immediately return an instance of TaskRuntimeMBean to the caller. The caller can then use this to track the task's progress as desired. Users can also query for all instances of TaskRuntimeMBean to get a summary of both currently-running and recently-completed tasks.

Instance of TaskRuntimeMBean continue to exist in the MBeanServer after the completion of the work they describe. They will eventually either be explicitly deregistered by the user, or removed by a scavenger process which periodically purges TaskRuntimeMBeans that have been completed for some time.

           
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.runtime.TaskRuntimeMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:
Subtypes The following MBeans extend or implement this MBean type:
Deprecated Factory Methods and Access Points


    Related MBeans

    This section describes attributes that provide access to other MBeans.


      SubTasks

      An array of TaskRuntimeMBeans that describes a set of parallel tasks which are components of this task.

      A value of null indicates that this task has no subtasks.

      A simple example of a task with subtasks would be one which monitors a user's request to start a cluster; that task should return a set of subtasks indicating the individual server-startup processes which compose the overall cluster-startup task.

             
      Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
      Privileges Read only
      TypeTaskRuntimeMBean[]
      Relationship type: Containment.


      Attributes

      This section describes the following attributes:


      BeginTime

      The time at which this task was started.

             
      Privileges Read only
      Typelong

      CachingDisabled

      Private property that disables caching in proxies.

             
      Privileges Read only
      Typeboolean

      Description

      A description of this task.

             
      Privileges Read only
      Typejava.lang.String

      EndTime

      The time at which this task was completed.

      A value of -1 indicates that the task is currently running.

             
      Privileges Read only
      Typelong

      Error

      Returns an exception describing the error, if any, that occurred while performing this task.

             
      Privileges Read only
      Typejava.lang.Exception

      MBeanInfo

      Returns the MBean info for this MBean.

      Deprecated.

             
      Privileges Read only
      Typejavax.management.MBeanInfo

      Name

      The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

             
      Privileges Read only
      Typejava.lang.String

      ObjectName

      Returns the ObjectName under which this MBean is registered in the MBean server.

      Deprecated.

             
      Privileges Read only
      Typeweblogic.management.WebLogicObjectName

      Parent

      Return the immediate parent for this MBean

             
      Privileges Read/Write
      Type

      ParentTask

      The task of which this task is a part.

      A value of null indicates that this task is not a subtask.

      For more information, see:

             
      Privileges Read only
      Type

      Registered

      Returns false if the the MBean represented by this object has been unregistered.

      Deprecated.

             
      Privileges Read only
      Typeboolean

      Running

      Indicates whether the task is still running.

             
      Privileges Read only
      Typeboolean

      Status

      The status of this task.

             
      Privileges Read only
      Typejava.lang.String

      SystemTask

      Indicates whether this task was initiated by the server versus a user.

             
      Privileges Read only
      Typeboolean

      Type

      Returns the type of the MBean.

             
      Privileges Read only
      Typejava.lang.String


      Operations

      This section describes the following operations:


        cancel

        Attempts to cancel this task.

        An exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled.

           
        Operation Name"cancel"
        Parametersnull
        Signaturenull
        Returns void
        Exceptions
        • java.lang.Exception