com.ibm.websphere.management.cmdframework.provider

Class CommandNotification

  1. java.lang.Object
  2. extended bycom.ibm.websphere.management.cmdframework.provider.CommandNotification
All implemented interfaces:
java.io.Serializable

  1. public class CommandNotification
  2. extends java.lang.Object
  3. 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

Modifier and Type Class and Description
  1. 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

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

Constructor Summary

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

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

  1. public static final java.lang.String STATUS_INPROGRESS
See Also:

STATUS_COMPLETED

  1. public static final java.lang.String STATUS_COMPLETED
See Also:

STATUS_INTERACTIVE

  1. public static final java.lang.String STATUS_INTERACTIVE
See Also:

STATUS_WARNING

  1. public static final java.lang.String STATUS_WARNING
See Also:

Constructor Detail

CommandNotification

  1. public CommandNotification(java.lang.String cName,
  2. java.lang.String sName,
  3. java.lang.String cStatus,
  4. java.lang.String sStatus,
  5. java.lang.String msg,
  6. long session,
  7. java.lang.Object uData,
  8. 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

  1. public CommandNotification(java.lang.String cName,
  2. java.lang.String sName,
  3. java.lang.String cStatus,
  4. java.lang.String sStatus,
  5. java.lang.String msg,
  6. long session,
  7. CommandResult cmdResult)

CommandNotification

  1. public CommandNotification(java.lang.String cName,
  2. java.lang.String sName,
  3. java.lang.String cStatus,
  4. java.lang.String sStatus,
  5. java.lang.String msg,
  6. long session)

Method Detail

getCmdName

  1. public java.lang.String getCmdName( )

setCmdName

  1. public void setCmdName(java.lang.String cmdName)

getCmdStatus

  1. public java.lang.String getCmdStatus( )

setCmdStatus

  1. public void setCmdStatus(java.lang.String cmdStatus)

getCmdStepName

  1. public java.lang.String getCmdStepName( )

setCmdStepName

  1. public void setCmdStepName(java.lang.String cmdStepName)

getCmdStepStatus

  1. public java.lang.String getCmdStepStatus( )

setCmdStepStatus

  1. public void setCmdStepStatus(java.lang.String cmdStepStatus)

getMessage

  1. public java.lang.String getMessage( )

setMessage

  1. public void setMessage(java.lang.String message)

getSessionID

  1. public long getSessionID()

setSessionID

  1. public void setSessionID(long sessionID)

getUserData

  1. 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

  1. 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

  1. public CommandResult getResult( )

setResult

  1. public void setResult(CommandResult cmdResult)

toString

  1. public java.lang.String toString( )
Overrides:
toString in class java.lang.Object