com.solacesystems.jcsmp

Class ConsumerFlowProperties

java.lang.Object

com.solacesystems.jcsmp.ConsumerFlowProperties

public class ConsumerFlowProperties
extends Object

Properties for binding a consumer flow, used in JCSMPSession.createFlow(XMLMessageListener, ConsumerFlowProperties).

Constructor Summary

Constructors

Constructor and Description
ConsumerFlowProperties() Creates a new instance of ConsumerFlowProperties.

Method Summary

Modifier and Type	Method and Description
void	addRequiredSettlementOutcomes(XMLMessage.Outcome... requiredOutcomes) Controls whether a newly created flow is expected to support all specified settlement capability options.
String	getAckMode() Gets the flow's acknowledgement mode.
int	getAckThreshold() Gets the flow's acknowledgement threshold.
int	getAckTimerInMsecs() Gets the flow's acknowledgement timer value (in milliseconds).
Endpoint	getEndpoint() Gets the remote Endpoint to bind to.
Subscription	getNewSubscription() If binding to a TopicEndpoint, the subscription to set on the Endpoint.
int	getReconnectRetryIntervalInMsecs() Gets how much time (in ms) to wait between each attempt to reconnect to an endpoint.
int	getReconnectTries() Gets number of times to attempt to reconnect to an endpoint after the initial bound flow goes down.
ReplayStartLocation	getReplayStartLocation() Gets the message replay start location, or null if it is not set.
String	getSelector() Gets the message selector, if one is set.
int	getTransportWindowSize() Returns the Guaranteed message transport window size for the flow.
boolean	isActiveFlowIndication() Gets the flow's active flow indication state.
boolean	isNoLocal() Gets the flow's noLocal setting.
boolean	isStartState() Checks whether a newly created flow should be in the started state upon creation.
ConsumerFlowProperties	setAckMode(String ackMode) Indicates whether the acknowledgement of receiving a message is done by JCSMP automatically or by the application explicitly calling XMLMessage.ackMessage() or XMLMessage.settle(Outcome).
ConsumerFlowProperties	setAckThreshold(int ackThreshold) Sets threshold for sending an acknowledgement, as a percentage of window size.
ConsumerFlowProperties	setAckTimerInMsecs(int ackTimerInMsecs) Sets the acknowledgement timer for the flow (in milliseconds).
ConsumerFlowProperties	setActiveFlowIndication(boolean activeFlowIndication) Applications that require a separate message for active or inactive flow indication must set this property to true when creating the flow.
ConsumerFlowProperties	setEndpoint(Endpoint endpoint) The appliance Endpoint to bind to.
ConsumerFlowProperties	setNewSubscription(Subscription newSubscription) If binding to a TopicEndpoint, the Topic to set/replace as a topic subscription on the endpoint.
ConsumerFlowProperties	setNoLocal(boolean noLocal) When the flow has the noLocal flag enabled, messages published on the session cannot appear in a flow created in the same session, even if the endpoint contains a subscription that matches the published message.
ConsumerFlowProperties	setReconnectRetryIntervalInMsecs(int val) This property specifies how much time (in ms) to wait between each attempt to reconnect to an endpoint.
ConsumerFlowProperties	setReconnectTries(int count) This property specifies the number of times to attempt to reconnect to an endpoint after the initial bound flow goes down.
ConsumerFlowProperties	setReplayStartLocation(ReplayStartLocation startLocation) This property specifies a message replay start location.
ConsumerFlowProperties	setSelector(String selector) A SQL-92 selector to use for selection of messages for delivery.
ConsumerFlowProperties	setStartState(boolean startState) Controls whether a newly created flow should be in the started state upon creation.
ConsumerFlowProperties	setTransportWindowSize(int winSz) Sets the Guaranteed message transport window size for the flow.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsumerFlowProperties

public ConsumerFlowProperties()

Creates a new instance of ConsumerFlowProperties.

Method Detail

getEndpoint

public Endpoint getEndpoint()

Gets the remote Endpoint to bind to.

Returns:

The Endpoint object targeted for this flow.

setEndpoint

public ConsumerFlowProperties setEndpoint(Endpoint endpoint)

The appliance Endpoint to bind to.

Parameters:

endpoint - parameter

getNewSubscription

public Subscription getNewSubscription()

If binding to a TopicEndpoint, the subscription to set on the Endpoint.

Returns:

The subscription to set on the Topic Endpoint.

setNewSubscription

public ConsumerFlowProperties setNewSubscription(Subscription newSubscription)

If binding to a TopicEndpoint, the Topic to set/replace as a topic subscription on the endpoint. This must be specified for a TopicEndpoint, null otherwise.

Parameters:

newSubscription - The subscription to set.

getSelector

public String getSelector()

Gets the message selector, if one is set.

Returns:

The message selector.

setSelector

public ConsumerFlowProperties setSelector(String selector)

A SQL-92 selector to use for selection of messages for delivery.

Parameters:

selector - The selector to use on this flow.

isStartState

public boolean isStartState()

Checks whether a newly created flow should be in the started state upon creation.

Returns:

The value of the startState property.

setStartState

public ConsumerFlowProperties setStartState(boolean startState)

Controls whether a newly created flow should be in the started state upon creation. The default is false: new message flows are created in the stopped state.

Parameters:

startState - Whether a newly created flow based on these properties should be started automatically.

setAckMode

public ConsumerFlowProperties setAckMode(String ackMode)

Indicates whether the acknowledgement of receiving a message is done by JCSMP automatically or by the application explicitly calling XMLMessage.ackMessage() or XMLMessage.settle(Outcome). Default: null (inherit from session).

Allowed values are:

• JCSMPProperties.SUPPORTED_MESSAGE_ACK_AUTO
• JCSMPProperties.SUPPORTED_MESSAGE_ACK_CLIENT

If message acknowledgement mode for the flow is SUPPORTED_MESSAGE_ACK_AUTO (the default behaviour), the call to XMLMessage.ackMessage() is ignored and a warning log is generated.

Parameters:

ackMode - The acknowledgement mode to use.

getAckMode

public String getAckMode()

Gets the flow's acknowledgement mode.

Returns:

The Message acknowledgement mode.

See Also:

ConsumerFlowProperties.setAckMode(String)

getTransportWindowSize

public int getTransportWindowSize()

Returns the Guaranteed message transport window size for the flow.

See Also:

ConsumerFlowProperties.setTransportWindowSize(int)

setTransportWindowSize

public ConsumerFlowProperties setTransportWindowSize(int winSz)

Sets the Guaranteed message transport window size for the flow. Valid values are 1-255. Default: 0 (inherit from session).

If the transport window size is set to N, the maximum number of messages that can be in transit (that is, the messages are sent from the appliance, but are not yet delivered to the application) is N+1.

Parameters:

winSz - The Guaranteed message window size.

getAckTimerInMsecs

public int getAckTimerInMsecs()

Gets the flow's acknowledgement timer value (in milliseconds).

See Also:

ConsumerFlowProperties.setAckTimerInMsecs(int)

setAckTimerInMsecs

public ConsumerFlowProperties setAckTimerInMsecs(int ackTimerInMsecs)

Sets the acknowledgement timer for the flow (in milliseconds). Default: 0 (inherit from session).

The valid range is 20-1500.

Parameters:

ackTimerInMsecs - The flow message acknowledgement timer.

getAckThreshold

public int getAckThreshold()

Gets the flow's acknowledgement threshold.

See Also:

ConsumerFlowProperties.setAckThreshold(int)

setAckThreshold

public ConsumerFlowProperties setAckThreshold(int ackThreshold)

Sets threshold for sending an acknowledgement, as a percentage of window size. The valid range is 1-75. Default: 0 (inherit from session).

Parameters:

ackThreshold - Acknowledgement threshold

isNoLocal

public boolean isNoLocal()

Gets the flow's noLocal setting.

Returns:

The flow's noLocal setting.

See Also:

ConsumerFlowProperties.setNoLocal(boolean)

setNoLocal

public ConsumerFlowProperties setNoLocal(boolean noLocal)

When the flow has the noLocal flag enabled, messages published on the session cannot appear in a flow created in the same session, even if the endpoint contains a subscription that matches the published message.

The appliance that the session connects to must have the No Local capability, and the capability must be must be enabled.

Default: false.

Parameters:

noLocal - Whether to set the NoLocal option on this flow.

Returns:

this

Throws:

InvalidOperationException - If this option is requested, but the peer does not support CapabilityType.NO_LOCAL.

isActiveFlowIndication

public boolean isActiveFlowIndication()

Gets the flow's active flow indication state.

Returns:

the flow's active flow indication state.

setActiveFlowIndication

public ConsumerFlowProperties setActiveFlowIndication(boolean activeFlowIndication)

Applications that require a separate message for active or inactive flow indication must set this property to true when creating the flow.

If the underlying session capabilities indicate that the appliance does not support active flow indication (CapabilityType.ACTIVE_FLOW_INDICATION), then JCSMPSession.createFlow(XMLMessageListener, ConsumerFlowProperties) will fail immediately and throw a InvalidOperationException.

Default: false

Parameters:

activeFlowIndication - parameter

setReplayStartLocation

public ConsumerFlowProperties setReplayStartLocation(ReplayStartLocation startLocation)

This property specifies a message replay start location. If the underlying session capabilities indicate that the appliance does not support message replay (see CapabilityType.MESSAGE_REPLAY) then JCSMPSession.createFlow(...) will fail immediately with InvalidOperationException thrown.

Parameters:

startLocation - replay start location

getReplayStartLocation

public ReplayStartLocation getReplayStartLocation()

Gets the message replay start location, or null if it is not set.

Returns:

replay start location.

getReconnectTries

public int getReconnectTries()

Gets number of times to attempt to reconnect to an endpoint after the initial bound flow goes down.

Returns:

number of reconnect attempts.

setReconnectTries

public ConsumerFlowProperties setReconnectTries(int count)

This property specifies the number of times to attempt to reconnect to an endpoint after the initial bound flow goes down. Valid values are >= -1. -1 means "retry forever". 0 means no automatic reconnection retries. The default value is -1.

getReconnectRetryIntervalInMsecs

public int getReconnectRetryIntervalInMsecs()

Gets how much time (in ms) to wait between each attempt to reconnect to an endpoint.

Returns:

How much time (in ms) to wait between each attempt

setReconnectRetryIntervalInMsecs

public ConsumerFlowProperties setReconnectRetryIntervalInMsecs(int val)

This property specifies how much time (in ms) to wait between each attempt to reconnect to an endpoint. Valid values are >= 50. The default value is 3000.

addRequiredSettlementOutcomes

public void addRequiredSettlementOutcomes(XMLMessage.Outcome... requiredOutcomes)

Controls whether a newly created flow is expected to support all specified settlement capability options. Setting of negative message settlement options is required to prepare the client to work with any of negative message settlement options such as XMLMessage.Outcome.FAILED or XMLMessage.Outcome.REJECTED.

NOTE: XMLMessage.Outcome.ACCEPTED is always available and can always be used to indicate a successful message settlement, regardless of whether it is specified in the list of required outcomes.

NOTE: Ignored on transacted flows

Parameters:

requiredOutcomes - if set, flow bind request will respect requirements provided and prevent flow from being established with older unsupported broker.