WorkflowTaskRuntimeMBean

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

TaskRuntimeMBean for any workflow (WorkflowProgress) executed using management orchestration framework.

           
Since12.2.1.0.0
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.WorkflowTaskRuntimeMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:
Access Points Inherited from RuntimeMBean Because this MBean extends or implements RuntimeMBean, you can also access this MBean by retrieving RuntimeMBeans. The following attributes contain RuntimeMBeans and its subtypes:
Access Points Inherited from TaskRuntimeMBean Because this MBean extends or implements TaskRuntimeMBean, you can also access this MBean by retrieving TaskRuntimeMBeans. The following attributes contain TaskRuntimeMBeans and its subtypes:
Subtypes The following MBeans extend or implement this MBean type:

    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.

      This attribute is not dynamic and requires a server restart to take effect.

             
      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

      Errors

      Lists all errors in the workflow.

             
      Privileges Read only
      Typeclass java.lang.Exception[]

      MBeanInfo

      Returns the MBean info for this MBean.

      This attribute is not dynamic and requires a server restart to take effect.

      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

      NumCompletedCommands

      Number of completed commands in the workflow. Together with {@code getNumTotalCommands()} defines kind of progress information.

             
      Privileges Read only
      Typeint

      NumTotalCommands

      Number of all commands in the workflow. Together with {@code getNumCompletedCommands()} defines kind of progress information.

             
      Privileges Read only
      Typeint

      ObjectName

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

      This attribute is not dynamic and requires a server restart to take effect.

      Deprecated.

             
      Privileges Read only
      Typeweblogic.management.WebLogicObjectName

      Parent

      Return the immediate parent for this MBean

      This attribute is not dynamic and requires a server restart to take effect.

             
      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

      Progress

      The progress of this task.

             
      Available Since Release 12.2.1.0.0
      Privileges Read only
      Typejava.lang.String

      ProgressString

      Human-readable message containing information about the current workflow progress.

             
      Privileges Read only
      Typejava.lang.String

      Registered

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

      This attribute is not dynamic and requires a server restart to take effect.

      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

      StatusHistory

      Provides step by step information (log) about the progress of the workflow.

             
      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.

      This attribute is not dynamic and requires a server restart to take effect.

             
      Privileges Read only
      Typejava.lang.String

      WorkflowId

      Each workflow has a unique id.

             
      Privileges Read only
      Typejava.lang.String

      WorkflowName

      User defined name of this workflow.

             
      Privileges Read only
      Typejava.lang.String

      WorkflowTarget

      Returns the target that was specified when the workflow was created. It will typically be either the name of the domain, of one or more clusters, or one or more servers.

             
      Privileges Read only
      Typejava.lang.String

      WorkflowType

      Returns a string that can be used to identify the different types of workflows.

             
      Privileges Read only
      Typejava.lang.String

      Operations

      This section describes the following operations:

      cancel

      Sets the cancel flag for the workflow. A canceled workflow will stop as soon as possible. If a command implements the CommandCancelInterface, it will be notified when this flag is set, otherwise, the command will either check it periodically, or the workflow will cancel when the current command completes.

      The state of a cancelled command will be {@code CANCELED} or {@code REVERT_CANCELED}.

         
      Operation Name"cancel"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • java.lang.IllegalStateException
        IllegalStateException if the command implements CommandCancelInterface but is in a state that cannot be interrupted

      canResume

      It is possible to resume (execute or revert) a workflow if it was already executed and is in a FAIL, REVERT_FAIL, CANCELED or REVERT_CANCELED state.

         
      Operation Name"canResume"
      Parametersnull
      Signaturenull
      Returns boolean

      showNextExecuteStep

      Get the next step that will be executed if the workflow is eligible to be resumed and the user were to call execute on it.

         
      Operation Name"showNextExecuteStep"
      Parametersnull
      Signaturenull
      ReturnsString

      showNextRevertStep

      Get the next step that will be reverted if the workflow is eligible to be resumed and the user were to call revert on it.

         
      Operation Name"showNextRevertStep"
      Parametersnull
      Signaturenull
      ReturnsString

      waitFor

      Waits for the process to finish.

         
      Operation Name"waitFor"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • java.lang.InterruptedException