Sonic Management API

com.sonicsw.mf.common.runtime
Interface IContainerState

All Superinterfaces:
java.lang.Comparable, IState

public interface IContainerState
extends IState

The implmentation of this interface represents the state of a container and all its hosted components.

See Also:
IComponentState

Field Summary
static short STATE_OFFLINE
          Indicates the container is offline.
static short STATE_ONLINE
          Indicates the container is online (in operational state).
static java.lang.String[] STATE_TEXT
          Textual representations of container states (indexed by STATE_<> values).
static short STATE_UNKNOWN
          Indicates the container state cannot be determined.
 
Method Summary
 IComponentState[] getComponentStates()
          Get a list of the state of all the components hosted by the container.
 java.lang.String getContainerHost()
          Get the IP hostname of the machine hosting the container.
 long getTimeStamp()
          Get the time the state value was captured.
 
Methods inherited from interface com.sonicsw.mf.common.runtime.IState
compareTo, equals, getRuntimeIdentity, getState, getStateString
 

Field Detail

STATE_OFFLINE

static final short STATE_OFFLINE
Indicates the container is offline. The container is either not contactable or a shutdown has been triggered the offline state.

See Also:
Constant Field Values

STATE_ONLINE

static final short STATE_ONLINE
Indicates the container is online (in operational state).

See Also:
Constant Field Values

STATE_TEXT

static final java.lang.String[] STATE_TEXT
Textual representations of container states (indexed by STATE_<> values).


STATE_UNKNOWN

static final short STATE_UNKNOWN
Indicates the container state cannot be determined.

See Also:
Constant Field Values
Method Detail

getComponentStates

IComponentState[] getComponentStates()
Get a list of the state of all the components hosted by the container.


getContainerHost

java.lang.String getContainerHost()
Get the IP hostname of the machine hosting the container.


getTimeStamp

long getTimeStamp()
Get the time the state value was captured.


Sonic Management API

Copyright © 2001-2011 Progress Software Corporation. All Rights Reserved.
HTML formatted on 12-Aug-2011.