com.solacesystems.jcsmp

Enum FlowEvent

java.lang.Object

java.lang.Enum<FlowEvent>

com.solacesystems.jcsmp.FlowEvent

All Implemented Interfaces:

Serializable, Comparable<FlowEvent>

public enum FlowEvent
extends Enum<FlowEvent>

Flow event types that can be given to the flow event callback handler ( FlowEventHandler) registered for a flow. The flow event callback is registered when a flow is created through JCSMPSession.createFlow(XMLMessageListener, ConsumerFlowProperties, EndpointProperties, FlowEventHandler)

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLOW_ACTIVE The flow is active and ready to receive messages.
FLOW_DOWN The flow was established and then went down.
FLOW_INACTIVE The flow is inactive and cannot receive messages.
FLOW_RECONNECTED The automatic reconnect of the flow was successful, and the flow was established again.
FLOW_RECONNECTING The flow has gone down, and an automatic reconnect attempt is in progress.
FLOW_UP The flow is established.

Method Summary

Modifier and Type	Method and Description
static FlowEvent	valueOf(String name) Returns the enum constant of this type with the specified name.
static FlowEvent[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FLOW_INACTIVE

public static final FlowEvent FLOW_INACTIVE

The flow is inactive and cannot receive messages.

FLOW_ACTIVE

public static final FlowEvent FLOW_ACTIVE

The flow is active and ready to receive messages.

FLOW_UP

public static final FlowEvent FLOW_UP

The flow is established.

FLOW_DOWN

public static final FlowEvent FLOW_DOWN

The flow was established and then went down.

FLOW_RECONNECTING

public static final FlowEvent FLOW_RECONNECTING

The flow has gone down, and an automatic reconnect attempt is in progress.

FLOW_RECONNECTED

public static final FlowEvent FLOW_RECONNECTED

The automatic reconnect of the flow was successful, and the flow was established again.

Method Detail

values

public static FlowEvent[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FlowEvent c : FlowEvent.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FlowEvent valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null