com.solacesystems.jms.events

Class ActiveFlowIndicationEvent

java.lang.Object

com.solacesystems.jms.events.SolJMSEvent<SolConsumerEvent.EventType>

com.solacesystems.jms.events.SolConsumerEvent

com.solacesystems.jms.events.ActiveFlowIndicationEvent

All Implemented Interfaces:

SolEvent

public class ActiveFlowIndicationEvent
extends SolConsumerEvent
implements SolEvent

This event is used to indicate a change in the state of a bound SolQueueReceiver. The state can alter between FLOW_INACTIVE and FLOW_ACTIVE Such events can occur upon starting a SolQueueReceiver, due to changes in underlying connection state or due to events indicated from the router.

Nested Class Summary

Nested classes/interfaces inherited from class com.solacesystems.jms.events.SolConsumerEvent

SolConsumerEvent.EventType

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLOW_ACTIVE
static int	FLOW_INACTIVE
static int	FLOW_STATE_MAX

Fields inherited from interface com.solacesystems.jms.events.SolEvent

SOLEVENT_TYPE_ACTIVE_FLOW_INDICATION

Constructor Summary

Constructors

Constructor and Description
ActiveFlowIndicationEvent()
ActiveFlowIndicationEvent(int flowState)

Method Summary

Modifier and Type	Method and Description
long	getEventType() Returns the event type of the SolEvent instance as defined by constants starting with SOLEVENT_TYPE_
int	getFlowState()
void	setFlowState(int flowState)
java.lang.String	toString() Returns a string representation of the event

Methods inherited from class com.solacesystems.jms.events.SolJMSEvent

getException, getType

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FLOW_INACTIVE

public static final int FLOW_INACTIVE

See Also:

Constant Field Values

FLOW_ACTIVE

public static final int FLOW_ACTIVE

See Also:

Constant Field Values

FLOW_STATE_MAX

public static final int FLOW_STATE_MAX

See Also:

Constant Field Values

Constructor Detail

ActiveFlowIndicationEvent

public ActiveFlowIndicationEvent()

ActiveFlowIndicationEvent

public ActiveFlowIndicationEvent(int flowState)
                          throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

Method Detail

getEventType

public long getEventType()

Description copied from interface: SolEvent

Returns the event type of the SolEvent instance as defined by constants starting with SOLEVENT_TYPE_

Specified by:

getEventType in interface SolEvent

Returns:

The event type.

toString

public java.lang.String toString()

Description copied from class: SolJMSEvent

Returns a string representation of the event

Specified by:

toString in interface SolEvent

Overrides:

toString in class SolJMSEvent<SolConsumerEvent.EventType>

Returns:

Description of the event

setFlowState

public void setFlowState(int flowState)
                  throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getFlowState

public int getFlowState()