com.mulesoft.mule.runtime.bti.api.jms

Class JmsConnectionConfig.Builder

java.lang.Object

com.mulesoft.mule.runtime.bti.api.jms.JmsConnectionConfig.Builder

Enclosing class:

JmsConnectionConfig

public static class JmsConnectionConfig.Builder
extends Object

Builds JMS configuration instances

Constructor Summary

Constructors

Constructor and Description
Builder(String name) Creates a new configuration

Method Summary

Modifier and Type	Method and Description
JmsConnectionConfig	build()
JmsConnectionConfig.Builder	setClientId(String clientId) Sets the client ID on the created JMS connections
JmsConnectionConfig.Builder	setExceptionListener(javax.jms.ExceptionListener exceptionListener) Sets the exception to manage JMS errors
JmsConnectionConfig.Builder	setMaxIdleTime(int maxIdleTime) Sets the amount of seconds a pooled XA connection can remain idle before it's eligible for eviction
JmsConnectionConfig.Builder	setMaxPoolSize(int maxPoolSize) Sets the maximum size for the XA connection pool
JmsConnectionConfig.Builder	setMinPoolSize(int minPoolSize) Sets the minimum size for the XA connection pool
JmsConnectionConfig.Builder	setPassword(String password) Sets the configuration password
JmsConnectionConfig.Builder	setReuseSessions(boolean reuseSessions) Indicates if the config must reuse JMS sessions
JmsConnectionConfig.Builder	setUserName(String userName) Sets the configuration username

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String name)

Creates a new configuration

Parameters:

name - name that identifies the connection. Non empty

Method Detail

setExceptionListener

public JmsConnectionConfig.Builder setExceptionListener(javax.jms.ExceptionListener exceptionListener)

Sets the exception to manage JMS errors

Parameters:

exceptionListener - listener used to manage JMS errors.

Returns:

same builder instance

setReuseSessions

public JmsConnectionConfig.Builder setReuseSessions(boolean reuseSessions)

Indicates if the config must reuse JMS sessions

Parameters:

reuseSessions - true if sessions must be reused, false otherwise.

Returns:

same builder instance

setClientId

public JmsConnectionConfig.Builder setClientId(String clientId)

Sets the client ID on the created JMS connections

Parameters:

clientId - ID to use on the created connections

Returns:

same builder instance

setPassword

public JmsConnectionConfig.Builder setPassword(String password)

Sets the configuration password

Parameters:

password - password used to connect to the JMS broker

Returns:

same builder instance

setUserName

public JmsConnectionConfig.Builder setUserName(String userName)

Sets the configuration username

Parameters:

userName - username used to connect to the JMS broker

Returns:

same builder instance

setMinPoolSize

public JmsConnectionConfig.Builder setMinPoolSize(int minPoolSize)

Sets the minimum size for the XA connection pool

Parameters:

minPoolSize - the size

Returns:

this builder

Since:

4.1.6 - 4.2.1

setMaxPoolSize

public JmsConnectionConfig.Builder setMaxPoolSize(int maxPoolSize)

Sets the maximum size for the XA connection pool

Parameters:

maxPoolSize - the size

Returns:

this builder

Since:

4.1.6 - 4.2.1

setMaxIdleTime

public JmsConnectionConfig.Builder setMaxIdleTime(int maxIdleTime)

Sets the amount of seconds a pooled XA connection can remain idle before it's eligible for eviction

Parameters:

maxIdleTime - the idle time in seconds

Returns:

this builder

Since:

4.1.6 - 4.2.1

build

public JmsConnectionConfig build()

Returns:

the new JMS configuration with the applied setup