Module io.helidon.messaging.connectors.aq

Package io.helidon.messaging.connectors.aq

Class AqConfigBuilder

java.lang.Object

io.helidon.messaging.ConnectorConfigBuilder

io.helidon.messaging.connectors.aq.AqConfigBuilder

All Implemented Interfaces:

Builder<Config>, Supplier<Config>

public class AqConfigBuilder
extends ConnectorConfigBuilder

Build AQ specific config.

Method Summary

Modifier and Type	Method	Description
AqConfigBuilder	acknowledgeMode(AcknowledgeMode acknowledgeMode)	JMS acknowledgement mode.
AqConfigBuilder	dataSource(String dataSourceName)	Mapping to DataSource supplied with AqConnectorBuilder.dataSource().
AqConfigBuilder	destination(String destination)	Queue or topic name.
AqConfigBuilder	messageSelector(String messageSelector)	JMS API message selector expression based on a subset of the SQL92.
AqConfigBuilder	password(String password)	Password used for creating JMS connection.
AqConfigBuilder	periodExecutions(long periodExecutions)	Period for executing poll cycles in millis.
AqConfigBuilder	pollTimeout(long pollTimeout)	Timeout for polling for next message in every poll cycle in millis.
AqConfigBuilder	property(String key, String value)	Add custom property.
AqConfigBuilder	queue(String destination)	Use supplied destination name and QUEUE as type.
AqConfigBuilder	sessionGroupId(String sessionGroupId)	When multiple channels share same session-group-id, they share same JMS session.
AqConfigBuilder	topic(String destination)	Use supplied destination name and TOPIC as type.
AqConfigBuilder	transacted(boolean transacted)	Indicates whether the session will use a local transaction.
AqConfigBuilder	type(Type type)	Specify if connection is queue or topic.
AqConfigBuilder	username(String username)	User name used for creating JMS connection.

Methods inherited from class io.helidon.messaging.ConnectorConfigBuilder

build

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get

Method Detail

property

public AqConfigBuilder property(String key,
                                String value)

Add custom property.

Overrides:

property in class ConnectorConfigBuilder

Parameters:

key - property key

value - property value

Returns:

this builder

dataSource

public AqConfigBuilder dataSource(String dataSourceName)

Mapping to DataSource supplied with AqConnectorBuilder.dataSource().

• Type: string

Parameters:

dataSourceName - data source identifier

Returns:

this builder

acknowledgeMode

public AqConfigBuilder acknowledgeMode(AcknowledgeMode acknowledgeMode)

JMS acknowledgement mode.

• AUTO_ACKNOWLEDGE Acknowledges automatically after message reception over JMS api.
• CLIENT_ACKNOWLEDGE Message is acknowledged when Message.ack() is invoked either manually or by Acknowledgment policy.
• DUPS_OK_ACKNOWLEDGE Messages are acknowledged lazily which can result in duplicate messages being delivered.

• Type: enum
• Default: AUTO_ACKNOWLEDGE
• Valid Values: AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE

Parameters:

acknowledgeMode - AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE

Returns:

this builder

transacted

public AqConfigBuilder transacted(boolean transacted)

Indicates whether the session will use a local transaction.

• Type: boolean
• Default: false
• Valid Values: true, false

Parameters:

transacted - true if so

Returns:

this builder

username

public AqConfigBuilder username(String username)

User name used for creating JMS connection.

• Type: string

Parameters:

username - JMS connection user name

Returns:

this builder

password

public AqConfigBuilder password(String password)

Password used for creating JMS connection.

• Type: string

Parameters:

password - JMS connection password

Returns:

this builder

type

public AqConfigBuilder type(Type type)

Specify if connection is queue or topic.

• Type: enum
• Default: QUEUE
• Valid Values: QUEUE, TOPIC

Parameters:

type - queue or topic

Returns:

this builder

destination

public AqConfigBuilder destination(String destination)

Queue or topic name.

• Type: string

Parameters:

destination - queue or topic name

Returns:

this builder

queue

public AqConfigBuilder queue(String destination)

Use supplied destination name and QUEUE as type.

• Type: string

Parameters:

destination - queue name

Returns:

this builder

topic

public AqConfigBuilder topic(String destination)

Use supplied destination name and TOPIC as type.

• Type: string

Parameters:

destination - topic name

Returns:

this builder

messageSelector

public AqConfigBuilder messageSelector(String messageSelector)

JMS API message selector expression based on a subset of the SQL92. Expression can only access headers and properties, not the payload.

• Type: string
• Example: NewsType = ’Sports’ OR NewsType = ’Opinion’

Parameters:

messageSelector - message selector expression

Returns:

this builder

pollTimeout

public AqConfigBuilder pollTimeout(long pollTimeout)

Timeout for polling for next message in every poll cycle in millis.

• Type: milliseconds
• Default: 50

Parameters:

pollTimeout - timeout of polling for next message

Returns:

this builder

periodExecutions

public AqConfigBuilder periodExecutions(long periodExecutions)

Period for executing poll cycles in millis.

• Type: milliseconds
• Default: 100

Parameters:

periodExecutions - period for executing poll cycles in millis

Returns:

this builder

sessionGroupId

public AqConfigBuilder sessionGroupId(String sessionGroupId)

When multiple channels share same session-group-id, they share same JMS session.

• Type: string

Parameters:

sessionGroupId - identifier for channels sharing same JMS session

Returns:

this builder