com.ibm.websphere.management.cmdframework.provider

Class CommandNotification

java.lang.Object

com.ibm.websphere.management.cmdframework.provider.CommandNotification

All Implemented Interfaces:

java.io.Serializable

public class CommandNotification
extends java.lang.Object
implements java.io.Serializable

AppNotification class defines the event data passed back by AppManagement implementation during asynchronous operations such installation or uninstallation. When AppManagement implementation runs in local mode an AppNotification instance is passed to the caller via appEventReceived callback of the Listener interface. In JMX mode the AppManagement implementation passes AppNotification instance as user data for JMX event.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CommandNotification.Listener An implementation of Listener interface is used by the clients that invoke install/uninstall functions of AppManagement in local mode.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	STATUS_COMPLETED
static java.lang.String	STATUS_INPROGRESS
static java.lang.String	STATUS_INTERACTIVE
static java.lang.String	STATUS_WARNING

Constructor Summary

Constructors

Constructor and Description
CommandNotification(java.lang.String cName, java.lang.String sName, java.lang.String cStatus, java.lang.String sStatus, java.lang.String msg, long session)
CommandNotification(java.lang.String cName, java.lang.String sName, java.lang.String cStatus, java.lang.String sStatus, java.lang.String msg, long session, CommandResult cmdResult)
CommandNotification(java.lang.String cName, java.lang.String sName, java.lang.String cStatus, java.lang.String sStatus, java.lang.String msg, long session, java.lang.Object uData, CommandResult cmdResult) Creates a new notifier instance.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCmdName()
java.lang.String	getCmdStatus()
java.lang.String	getCmdStepName()
java.lang.String	getCmdStepStatus()
java.lang.String	getMessage()
CommandResult	getResult()
long	getSessionID()
java.lang.Object	getUserData() Get additional user data for this command or task notification.
void	setCmdName(java.lang.String cmdName)
void	setCmdStatus(java.lang.String cmdStatus)
void	setCmdStepName(java.lang.String cmdStepName)
void	setCmdStepStatus(java.lang.String cmdStepStatus)
void	setMessage(java.lang.String message)
void	setResult(CommandResult cmdResult)
void	setSessionID(long sessionID)
void	setUserData(java.lang.Object userData) Set additional user data for this command or task notification.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_INPROGRESS

public static final java.lang.String STATUS_INPROGRESS

See Also:

Constant Field Values

STATUS_COMPLETED

public static final java.lang.String STATUS_COMPLETED

See Also:

Constant Field Values

STATUS_INTERACTIVE

public static final java.lang.String STATUS_INTERACTIVE

See Also:

Constant Field Values

STATUS_WARNING

public static final java.lang.String STATUS_WARNING

See Also:

Constant Field Values

Constructor Detail

CommandNotification

public CommandNotification(java.lang.String cName,
                   java.lang.String sName,
                   java.lang.String cStatus,
                   java.lang.String sStatus,
                   java.lang.String msg,
                   long session,
                   java.lang.Object uData,
                   CommandResult cmdResult)

Creates a new notifier instance. If there is a valid uData, it need to be a Serializable object. If no uData is available, it can be set to null; Otherwise, a runtime IllegalArgumentException will be thrown.

Parameters:

cName - Name of the command or task.

sName - Name of the step or subtask.

cStatus - Command or task status.

sStatus - Step or subtask status.

msg - Detailed task message.

uData - Additional user data for this command or task.

cmdResult - Properties of command or task.

CommandNotification

public CommandNotification(java.lang.String cName,
                   java.lang.String sName,
                   java.lang.String cStatus,
                   java.lang.String sStatus,
                   java.lang.String msg,
                   long session,
                   CommandResult cmdResult)

CommandNotification

public CommandNotification(java.lang.String cName,
                   java.lang.String sName,
                   java.lang.String cStatus,
                   java.lang.String sStatus,
                   java.lang.String msg,
                   long session)

Method Detail

getCmdName

public java.lang.String getCmdName()

setCmdName

public void setCmdName(java.lang.String cmdName)

getCmdStatus

public java.lang.String getCmdStatus()

setCmdStatus

public void setCmdStatus(java.lang.String cmdStatus)

getCmdStepName

public java.lang.String getCmdStepName()

setCmdStepName

public void setCmdStepName(java.lang.String cmdStepName)

getCmdStepStatus

public java.lang.String getCmdStepStatus()

setCmdStepStatus

public void setCmdStepStatus(java.lang.String cmdStepStatus)

getMessage

public java.lang.String getMessage()

setMessage

public void setMessage(java.lang.String message)

getSessionID

public long getSessionID()

setSessionID

public void setSessionID(long sessionID)

getUserData

public java.lang.Object getUserData()

Get additional user data for this command or task notification.

Returns:

null or a generic java.lang.Object of Serializable user data object.

setUserData

public void setUserData(java.lang.Object userData)

Set additional user data for this command or task notification. If there is a valid userData, it need to be a Serializable object. If no userData is available, it can be set to null; Otherwise, a runtime IllegalArgumentException will be thrown.

Parameters:

userData - Additional user data for this command or task.

getResult

public CommandResult getResult()

setResult

public void setResult(CommandResult cmdResult)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object