FlowHandle.PROPERTIES (Solace Java RTO Messaging API v10.8.0)

java.lang.Object
- com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES

Enclosing interface:

FlowHandle
```
public static final class FlowHandle.PROPERTIES
extends java.lang.Object
```
Defines the property names used to configure a Flow handle

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACK_THRESHOLD` The threshold for sending an acknowledgement, configured as a percentage.
`static java.lang.String`	`ACK_TIMER_MS` The duration of the Flow acknowledgement timer (in milliseconds).
`static java.lang.String`	`ACKMODE` Controls how acknowledgements are generated for received Guaranteed messages. Possible values in `SolEnum.AckMode` Default: `SolEnum.AckMode.AUTO`
`static java.lang.String`	`ACTIVE_FLOW_IND` When a Flow has the Active Flow Indication property enabled, the application will receive flow events when the flow becomes active, or inactive.
`static java.lang.String`	`BIND_BLOCKING` This property controls whether or not to block in `SessionHandle#createFlowForHandle`. Possible values in `SolEnum.BooleanValue` Default: `SolEnum.BooleanValue#ENABLE`
`static java.lang.String`	`BIND_TIMEOUT_MS` The timeout (in milliseconds) used when creating a Flow in blocking mode.
`static java.lang.String`	`BROWSER` Set browser mode on flow and signal it is a browser flow to appliance on bind.
`static java.lang.String`	`MAX_BIND_TRIES` When creating a non-blocking Flow, or a Flow that is bound due to Session-connect, the maximum number of bind attempts to make.
`static java.lang.String`	`MAX_RECONNECT_TRIES` When a connected flow receives an unsolicited unbind event with subcode REPLAY_STARTED or GM_UNAVAILABLE, the SDK can reconnect the flow automatically.
`static java.lang.String`	`MAX_UNACKED_MESSAGES` This property may only be set when the Flow property `FlowHandle.PROPERTIES.ACKMODE` is set to `SolEnum.AckMode.CLIENT`.
`static java.lang.String`	`NO_LOCAL` When a Flow has the No Local property 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.
`static java.lang.String`	`RECONNECT_RETRY_INTERVAL_MS` Time to wait between flow auto reconnect attempts, in milliseconds.
`static java.lang.String`	`REPLAY_START_LOCATION` When a Flow is created, the application may request replay of messages from the replay log, even messages that have been previously delivered and removed from the topic endpoint or queue.
`static java.lang.String`	`REQUIRED_OUTCOME_FAILED` This property allows the flow to use `FlowHandle.settle(long, int)` or `FlowHandle.settle(MessageHandle, int)` with `SolEnum.MessageOutcome.FAILED` outcome.
`static java.lang.String`	`REQUIRED_OUTCOME_REJECTED` This property allows the flow to use `FlowHandle.settle(long, int)` or `FlowHandle.settle(MessageHandle, int)` with `SolEnum.MessageOutcome.REJECTED` outcome.
`static java.lang.String`	`SELECTOR` A Java Message System (JMS) defined selector.
`static java.lang.String`	`START_STATE` This property controls whether the Flow should be created in a start or stop state with respect to receiving messages.
`static java.lang.String`	`WINDOWSIZE` The Guaranteed message window size for the Flow.

Constructor Summary

Constructors
Constructor and Description

PROPERTIES()

Constructors
Constructor and Description
`PROPERTIES()`

Method Summary
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BIND_BLOCKING
```
public static final java.lang.String BIND_BLOCKING
```
    This property controls whether or not to block in SessionHandle#createFlowForHandle.
    Possible values in SolEnum.BooleanValue
    Default: SolEnum.BooleanValue#ENABLE
    
    See Also:
    
    Constant Field Values
  - BIND_TIMEOUT_MS
```
public static final java.lang.String BIND_TIMEOUT_MS
```
    The timeout (in milliseconds) used when creating a Flow in blocking mode. The valid range is > 0.
    Default: 10000
    
    See Also:
    
    Constant Field Values
  - WINDOWSIZE
```
public static final java.lang.String WINDOWSIZE
```
    The Guaranteed message window size for the Flow. This sets 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). The valid range is 1..255.
    Default: 255
    
    See Also:
    
    Constant Field Values
  - ACKMODE
```
public static final java.lang.String ACKMODE
```
    Controls how acknowledgements are generated for received Guaranteed messages.
    Possible values in SolEnum.AckMode
    Default: SolEnum.AckMode.AUTO
    
    See Also:
    
    Constant Field Values
  - MAX_BIND_TRIES
```
public static final java.lang.String MAX_BIND_TRIES
```
    When creating a non-blocking Flow, or a Flow that is bound due to Session-connect, the maximum number of bind attempts to make. The valid range is >= 1.
    Default: 3
    
    See Also:
    
    Constant Field Values
  - ACK_TIMER_MS
```
public static final java.lang.String ACK_TIMER_MS
```
    The duration of the Flow acknowledgement timer (in milliseconds). The valid range is 20..1500.
    Default: 1000
    
    See Also:
    
    Constant Field Values
  - ACK_THRESHOLD
```
public static final java.lang.String ACK_THRESHOLD
```
    The threshold for sending an acknowledgement, configured as a percentage. The API sends a transport acknowledgment every N messages where N is calculated as this percentage of the flow window size if the endpoint's max-delivered-unacked-msgs-per-flow setting at bind time is greater than or equal to the transport window size. Otherwise, N is calculated as this percentage of the endpoint's max-delivered-unacked-msgs-per-flow setting at bind time. The valid range is 1..75.
    Default: 60
    
    See Also:
    
    Constant Field Values
  - START_STATE
```
public static final java.lang.String START_STATE
```
    This property controls whether the Flow should be created in a start or stop state with respect to receiving messages. Flow start/stop state can be changed later through FlowHandle.start() or FlowHandle.stop().
    Possible values in SolEnum.BooleanValue
    Default: SolEnum.BooleanValue.ENABLE
    
    See Also:
    
    Constant Field Values
  - SELECTOR
```
public static final java.lang.String SELECTOR
```
    A Java Message System (JMS) defined selector. It can be a maximum 1023 bytes in length.
    
    See Also:
    
    Constant Field Values
  - NO_LOCAL
```
public static final java.lang.String NO_LOCAL
```
    When a Flow has the No Local property 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 enabled. If the appliance the Session is connected to does not support No Local, a call to SessionHandle#createFlowForHandle returns SolEnum.ReturnCode.FAIL and SolEnum.SubCode#NO_LOCAL_NOT_SUPPORTED set.
    Possible values in SolEnum.BooleanValue
    Default: SolEnum.BooleanValue.DISABLE
    
    See Also:
    
    Constant Field Values
  - MAX_UNACKED_MESSAGES
```
public static final java.lang.String MAX_UNACKED_MESSAGES
```
    This property may only be set when the Flow property FlowHandle.PROPERTIES.ACKMODE is set to SolEnum.AckMode.CLIENT. When set to a positive value, this property controls the maximum number of messages that may be unacknowledged on the Flow (FlowHandle.ack(long) is called to acknowledge messages and remove those messages from the message spool). This property cannot be used to increase the appliance configured maximum number of acknowledged messages on the endpoint. When set to -1, the appliance configured maximum controls how many unacknowledged messages may be received by the application. Valid values are -1 and >0.
    Default -1
    
    See Also:
    
    Constant Field Values
  - BROWSER
```
public static final java.lang.String BROWSER
```
    Set browser mode on flow and signal it is a browser flow to appliance on bind. A browser flow allows client applications to look at messages spooled on Endpoints without removing them. Messages are browsed from oldest to newest. The flow window size will be reduced as messages are received. Applications have to call FlowHandle.start() to get more messages. After being browsed, messages are still available for consumption over normal flows. However, it is possible to selectively remove messages (by calling FlowHandle.ack(long)) from the persistent store of an Endpoint, in this case, these removed messages will no longer be available for consumption.
    Possible values in SolEnum.BooleanValue
    Default: SolEnum.BooleanValue.DISABLE
    
    See Also:
    
    Constant Field Values
  - ACTIVE_FLOW_IND
```
public static final java.lang.String ACTIVE_FLOW_IND
```
    When a Flow has the Active Flow Indication property enabled, the application will receive flow events when the flow becomes active, or inactive. If the underlying session capabilities indicate that the appliance does not support active flow indications, then SessionHandle#createFlowForHandle returns SolEnum.ReturnCode.FAIL and sets the SubCode SolEnum.SubCode#FLOW_ACTIVE_FLOW_INDICATION_UNSUPPORTED.
    Possible values in SolEnum.BooleanValue
    Default: SolEnum.BooleanValue.DISABLE
    
    See Also:
    
    Constant Field Values
  - REPLAY_START_LOCATION
```
public static final java.lang.String REPLAY_START_LOCATION
```
    When a Flow is created, the application may request replay of messages from the replay log, even messages that have been previously delivered and removed from the topic endpoint or queue. The replay start location may be SolEnum.ReplayStartLocation.BEGINNING to indicate that all messages available should be replayed. Or the replay start location may be a string that begins with "DATE:" followed by a date in one of two formats. The date may be a string representing a long integer, which is the number of seconds since the epoch - 0:00:00 Jan 1, 1970. The data may be a string as specified in RFC3339 - 'YYYY-MM-DDTHH:MM:SS[.1*DIGIT]Z' or 'YYYY-MM-DDTHH:MM:SS[.1*DIGIT]("+"/"-")HH:MM'. Additionally, the replay start location may be a replication-group-message-id string as returned by ReplicationGroupMessageIdHandleImpl.toString(). Such a string starts with "rmid1:" and is a ReplicationGroupMessageIdHandle.
    
    See Also:
    
    Constant Field Values
  - MAX_RECONNECT_TRIES
```
public static final java.lang.String MAX_RECONNECT_TRIES
```
    When a connected flow receives an unsolicited unbind event with subcode REPLAY_STARTED or GM_UNAVAILABLE, the SDK can reconnect the flow automatically. This property controls the flow auto reconnect feature: 0: Disable flow auto reconnect for this consumer flow. -1: Enable flow auto reconnect for this consumer flow, infiinite retries (default) : Enable flow auto reconnect for this consumer flow, n retries. When the flow auto rebind is enabled, DOWN_ERRORs with REPLAY_STARTED and GM_UNAVAILABLE are handled internally, and not (immediately) emitted to the application. A RECONNECTING event (with the same subcode) is emitted instead, ideally followed by a RECONNECTED event when the reconnect succeedes. In case of REPLAY_STARTED, the window of message IDs and acknowledgements are reset to allow replay packets to be passed to the application without marking them as duplicates. In case of GM_UNAVAILABLE, flow state is preserved. If reconnecting fails after exhausting the number of retries, a DOWN_ERROR is emitted with the details of the last retry. Default: -1
    
    See Also:
    
    Constant Field Values
  - RECONNECT_RETRY_INTERVAL_MS
```
public static final java.lang.String RECONNECT_RETRY_INTERVAL_MS
```
    Time to wait between flow auto reconnect attempts, in milliseconds. See FlowHandle.PROPERTIES.REPLAY_START_LOCATION Default: 3000
    
    See Also:
    
    Constant Field Values
  - REQUIRED_OUTCOME_FAILED
```
public static final java.lang.String REQUIRED_OUTCOME_FAILED
```
    This property allows the flow to use FlowHandle.settle(long, int) or FlowHandle.settle(MessageHandle, int) with SolEnum.MessageOutcome.FAILED outcome. Requires broker capability SolEnum.CapabilityName.CAPABILITY_AD_APP_ACK_FAILED
    Default: SolEnum.BooleanValue.DISABLE
    
    See Also:
    
    Constant Field Values
  - REQUIRED_OUTCOME_REJECTED
```
public static final java.lang.String REQUIRED_OUTCOME_REJECTED
```
    This property allows the flow to use FlowHandle.settle(long, int) or FlowHandle.settle(MessageHandle, int) with SolEnum.MessageOutcome.REJECTED outcome. Requires broker capability SolEnum.CapabilityName.CAPABILITY_AD_APP_ACK_FAILED
    Default: SolEnum.BooleanValue.DISABLE
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PROPERTIES
```
public PROPERTIES()
```

Class FlowHandle.PROPERTIES

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BIND_BLOCKING

BIND_TIMEOUT_MS

WINDOWSIZE

ACKMODE

MAX_BIND_TRIES

ACK_TIMER_MS

ACK_THRESHOLD

START_STATE

SELECTOR

NO_LOCAL

MAX_UNACKED_MESSAGES

BROWSER

ACTIVE_FLOW_IND

REPLAY_START_LOCATION

MAX_RECONNECT_TRIES

RECONNECT_RETRY_INTERVAL_MS

REQUIRED_OUTCOME_FAILED

REQUIRED_OUTCOME_REJECTED

Constructor Detail

PROPERTIES