com.ibm.datapower.wamt.amp
Class DomainStatus

java.lang.Object
  extended by com.ibm.datapower.wamt.amp.DomainStatus

public class DomainStatus
extends java.lang.Object

A container to hold the multiple objects returned from Commands.getDomainStatus(DeviceContext, String).


Field Summary
static java.lang.String COPYRIGHT_2009_2012
           
static DomainStatus UNKNOWN_DOMAIN_STATUS
           
 
Constructor Summary
DomainStatus(AdminStatus adminState, OperationStatus operationStatus, boolean needsSave, boolean debugState, QuiesceStatus quiesceStatus)
           
DomainStatus(OperationStatus operationStatus, boolean needsSave, boolean debugState, QuiesceStatus quiesceStatus)
          Create an instance of the DomainStatus.
 
Method Summary
 AdminStatus getAdminStatus()
          Get the admin state of domain, enabled (AdminState.ENABLED) or disabled (AdminState.DISABLED).
 boolean getDebugState()
          Get a boolean value which indicates if this domain has debug or troubleshooting enabled.
 boolean getNeedsSave()
          Get a boolean value which indicates if this domain has been modified but not saved to flash.
 OperationStatus getOperationStatus()
          Get the operation status of this domain as it had been previously fetched by Commands.getDomainStatus(DeviceContext, String).
 QuiesceStatus getQuiesceStatus()
          Get the quiesce status of this domain as it had been previously fetched by Commands.getDomainStatus(DeviceContext, String).
 void setStatus(DomainStatus newStatus)
          Update the domain status
 java.lang.String toString()
          Get a String representation of this object for the purpose of debugging or tracing.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT_2009_2012

public static final java.lang.String COPYRIGHT_2009_2012
See Also:
Constant Field Values

UNKNOWN_DOMAIN_STATUS

public static final DomainStatus UNKNOWN_DOMAIN_STATUS
Constructor Detail

DomainStatus

public DomainStatus(OperationStatus operationStatus,
                    boolean needsSave,
                    boolean debugState,
                    QuiesceStatus quiesceStatus)
Create an instance of the DomainStatus. This constructor should be invoked only by Commands.getDomainStatus(DeviceContext, String).

Parameters:
operationStatus - the operation status of the domain
needsSave - true if the domain has been modified but not saved to flash, false otherwise
debugState - true if the domain has debugging/troubleshooting enabled, false otherwise

DomainStatus

public DomainStatus(AdminStatus adminState,
                    OperationStatus operationStatus,
                    boolean needsSave,
                    boolean debugState,
                    QuiesceStatus quiesceStatus)
Method Detail

getAdminStatus

public AdminStatus getAdminStatus()
Get the admin state of domain, enabled (AdminState.ENABLED) or disabled (AdminState.DISABLED).

Returns:
AdminStatus.ENABLED if this object's admin state is "enabled", AdminStatus.DISABLED is "disabled", AdminStatus.UNKNOWN if the domain is not on the device.

getOperationStatus

public OperationStatus getOperationStatus()
Get the operation status of this domain as it had been previously fetched by Commands.getDomainStatus(DeviceContext, String).

Returns:
the operation status of this domain

getQuiesceStatus

public QuiesceStatus getQuiesceStatus()
Get the quiesce status of this domain as it had been previously fetched by Commands.getDomainStatus(DeviceContext, String).

Returns:
the quiesce status of this domain

getNeedsSave

public boolean getNeedsSave()
Get a boolean value which indicates if this domain has been modified but not saved to flash.

Returns:
true if this domain has been modified but not saved to flash, false otherwise.

getDebugState

public boolean getDebugState()
Get a boolean value which indicates if this domain has debug or troubleshooting enabled.

Returns:
true if this domain has debug or troubleshooting enabled, false otherwise.

setStatus

public void setStatus(DomainStatus newStatus)
Update the domain status

Parameters:
newStatus - new domain status

toString

public java.lang.String toString()
Get a String representation of this object for the purpose of debugging or tracing.

Overrides:
toString in class java.lang.Object
Returns:
a String representation of this object for the purpose of debugging or tracing.


© Copyright IBM Corp. 2006, 2010 All Rights Reserved.