weblogic.management.runtime

Class TaskRuntimeMBeanImpl

java.lang.Object

weblogic.management.runtime.RuntimeMBeanDelegate

weblogic.management.runtime.TaskRuntimeMBeanImpl

All Implemented Interfaces:

javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, RuntimeMBean, TaskRuntimeMBean, WebLogicMBean

Direct Known Subclasses:

ClassRedefinitionTaskRuntimeImpl, JDBCDataSourceTaskRuntimeMBeanImpl, PartitionLifeCycleTaskRuntime, ResourceGroupLifeCycleTaskRuntime, WLDFDebugPatchTaskRuntimeMBeanImpl

public abstract class TaskRuntimeMBeanImpl
extends RuntimeMBeanDelegate
implements TaskRuntimeMBean

Excluded in public API Reference.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	beginTime
protected java.lang.String	description
protected long	endTime
protected java.lang.Exception	error
protected boolean	running
protected java.lang.String	status
protected TaskRuntimeMBean[]	subTasks
protected boolean	systemTask

Fields inherited from class weblogic.management.runtime.RuntimeMBeanDelegate

descriptor, name, parent, registered, type

Fields inherited from interface weblogic.management.runtime.TaskRuntimeMBean

PROGRESS_FAILED, PROGRESS_PENDING, PROGRESS_PROCESSING, PROGRESS_SUCCESS

Constructor Summary

Constructors

Constructor and Description
TaskRuntimeMBeanImpl(java.lang.String nameArg, RuntimeMBean parentArg, boolean registerNow) Constructor for the RuntimeMBeanDelegate object

Method Summary

Modifier and Type	Method and Description
void	cancel() Attempts to cancel this task.
long	getBeginTime() Returns the time this task was started.
java.lang.String	getDescription() A description of this task.
long	getEndTime() The time this task was completed.
java.lang.Exception	getError() Returns an exception describing the error, if any, that occurred while performing this Task.
TaskRuntimeMBean	getParentTask() Returns the task of which this task is a part (see getSubTasks), or null if there is none.
java.lang.String	getStatus() The status of this task.
TaskRuntimeMBean[]	getSubTasks() Returns an array of TaskRuntimes describing a set of parallel tasks which are components of this task.
boolean	isRunning() Returns true if the Task is still running.
boolean	isSystemTask() Indicates this task was initiated by the server.
void	printLog(java.io.PrintWriter out) Prints information that was logged during the processing of the task (e.g.
protected void	setBeginTime(long beginTime)
protected void	setDescription(java.lang.String description)
protected void	setEndTime(long endTime)
protected void	setError(java.lang.Exception error)
protected void	setStatus(java.lang.String status)
protected void	setSubTasks(TaskRuntimeMBean[] subTasks)
void	setSystemTask(boolean sys) Make this a system task

Methods inherited from class weblogic.management.runtime.RuntimeMBeanDelegate

_createHelper, _postSet, _postSet, _postSet, _postSet, _postSet, addChild, addNotificationListener, addPropertyChangeListener, createChildCopy, getAttribute, getAttributes, getMBeanInfo, getMetaData, getName, getNotificationInfo, getObjectName, getParent, getParentAttribute, getPropertyChangeListeners, getRegistrationManager, getRestParent, getType, invoke, isCachingDisabled, isEditable, isRegistered, pluralize, postDeregister, postRegister, preDeregister, preRegister, register, removeChild, removeNotificationListener, removePropertyChangeListener, setAttribute, setAttributes, setMetaData, setName, setParent, setRestParent, setRuntimeMBeanHelper, setType, unregister

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface weblogic.management.runtime.TaskRuntimeMBean

getProgress

Methods inherited from interface weblogic.management.runtime.RuntimeMBean

addPropertyChangeListener, preDeregister, removePropertyChangeListener

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Field Detail

description

protected java.lang.String description

status

protected java.lang.String status

beginTime

protected long beginTime

endTime

protected long endTime

subTasks

protected TaskRuntimeMBean[] subTasks

error

protected java.lang.Exception error

running

protected boolean running

systemTask

protected boolean systemTask

Constructor Detail

TaskRuntimeMBeanImpl

public TaskRuntimeMBeanImpl(java.lang.String nameArg,
                            RuntimeMBean parentArg,
                            boolean registerNow)
                     throws ManagementException

Constructor for the RuntimeMBeanDelegate object

Parameters:

nameArg -

parentArg -

Throws:

ManagementException

Method Detail

getDescription

public java.lang.String getDescription()

A description of this task.

Returns a description of this task

Specified by:

getDescription in interface TaskRuntimeMBean

Returns:

The description value

getStatus

public java.lang.String getStatus()

The status of this task.

Returns the status of this Task.

Specified by:

getStatus in interface TaskRuntimeMBean

Returns:

The status value

isRunning

public boolean isRunning()

Returns true if the Task is still running.

Specified by:

isRunning in interface TaskRuntimeMBean

Returns:

The running value

getBeginTime

public long getBeginTime()

Returns the time this task was started.

Specified by:

getBeginTime in interface TaskRuntimeMBean

Returns:

The beginTime value

getEndTime

public long getEndTime()

The time this task was completed.

Returns the time this task was completed. Returns -1 if the task is currently running.

Specified by:

getEndTime in interface TaskRuntimeMBean

Returns:

The endTime value

getSubTasks

public TaskRuntimeMBean[] getSubTasks()

Returns an array of TaskRuntimes describing a set of parallel tasks which are components of this task. Returns null if 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.

Specified by:

getSubTasks in interface TaskRuntimeMBean

Returns:

The subTasks value

getParentTask

public TaskRuntimeMBean getParentTask()

Returns the task of which this task is a part (see getSubTasks), or null if there is none.

Specified by:

getParentTask in interface TaskRuntimeMBean

Returns:

The parentTask value

See Also:

TaskRuntimeMBean.getSubTasks()

cancel

public void cancel()
            throws java.lang.Exception

Attempts to cancel this task. An Exception is thrown to indicate failure to cancel the task. Not all tasks can be cancelled - do we also need isCancellable()?

Specified by:

cancel in interface TaskRuntimeMBean

Throws:

java.lang.Exception

printLog

public void printLog(java.io.PrintWriter out)

Prints information that was logged during the processing of the task (e.g. server startup log) to the given Writer.

Specified by:

printLog in interface TaskRuntimeMBean

Parameters:

out -

getError

public java.lang.Exception getError()

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

Specified by:

getError in interface TaskRuntimeMBean

Returns:

The error value

isSystemTask

public boolean isSystemTask()

Indicates this task was initiated by the server.

Specified by:

isSystemTask in interface TaskRuntimeMBean

Returns:

The systemTask value

setSystemTask

public void setSystemTask(boolean sys)

Make this a system task

Specified by:

setSystemTask in interface TaskRuntimeMBean

Parameters:

sys - The new systemTask value

Excluded in public API Reference (Marked as @internal).

setDescription

protected void setDescription(java.lang.String description)

setStatus

protected void setStatus(java.lang.String status)

setBeginTime

protected void setBeginTime(long beginTime)

setEndTime

protected void setEndTime(long endTime)

setSubTasks

protected void setSubTasks(TaskRuntimeMBean[] subTasks)

setError

protected void setError(java.lang.Exception error)