Sonic ESB API

com.sonicsw.xq
Class XQState

java.lang.Object
  extended by com.sonicsw.xq.XQState
All Implemented Interfaces:
com.sonicsw.mf.common.runtime.IState, java.io.Serializable, java.lang.Comparable

public class XQState
extends java.lang.Object
implements com.sonicsw.mf.common.runtime.IState, java.io.Serializable

This class represents the states during the life cycle of an ESB container and ESB service.

XQState instances are immutable and serializable.

See Also:
Serialized Form

Field Summary
static XQState STARTED
          State indicating that the container or service has been successfully started.
static XQState STARTING
          Transient State indicating that the container or service is in the process of getting started
static XQState STOPPED
          State indicating that the container or service has been stopped.
static XQState STOPPING
          Transient State indicating that the container or service is in the process of getting stopped
static XQState UNINITIALIZED
          State indicating that the container or service has not yet been initialized.
 
Method Summary
 boolean canTransitionTo(XQState targetState)
          Indicates whether it is valid to transition from this state to the given target state.
 int compareTo(java.lang.Object object)
           
static XQState get(short ordinal)
           
 com.sonicsw.mf.common.runtime.IIdentity getRuntimeIdentity()
           
 short getState()
           
 java.lang.String getStateString()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.sonicsw.mf.common.runtime.IState
equals
 

Field Detail

UNINITIALIZED

public static final XQState UNINITIALIZED
State indicating that the container or service has not yet been initialized.


STOPPED

public static final XQState STOPPED
State indicating that the container or service has been stopped.


STARTING

public static final XQState STARTING
Transient State indicating that the container or service is in the process of getting started


STARTED

public static final XQState STARTED
State indicating that the container or service has been successfully started.


STOPPING

public static final XQState STOPPING
Transient State indicating that the container or service is in the process of getting stopped

Method Detail

get

public static XQState get(short ordinal)

toString

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

canTransitionTo

public final boolean canTransitionTo(XQState targetState)
Indicates whether it is valid to transition from this state to the given target state.

Parameters:
targetState - the desired target state
Returns:
true if it is valid to transition to the given target; false otherwise

compareTo

public int compareTo(java.lang.Object object)
              throws java.lang.ClassCastException
Specified by:
compareTo in interface com.sonicsw.mf.common.runtime.IState
Specified by:
compareTo in interface java.lang.Comparable
Throws:
java.lang.ClassCastException

getRuntimeIdentity

public com.sonicsw.mf.common.runtime.IIdentity getRuntimeIdentity()
Specified by:
getRuntimeIdentity in interface com.sonicsw.mf.common.runtime.IState

getState

public short getState()
Specified by:
getState in interface com.sonicsw.mf.common.runtime.IState

getStateString

public java.lang.String getStateString()
Specified by:
getStateString in interface com.sonicsw.mf.common.runtime.IState

Sonic ESB API

Copyright © 2001-2013 Aurea, Inc. All Rights Reserved.
HTML formatted on 29-April-2013.