|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ClientSessionFactory
A ClientSessionFactory is the entry point to create and configure HornetQ resources to produce and consume messages.
It is possible to configure a factory using the setter methods only if no session has been created.
Once a session is created, the configuration is fixed and any call to a setter method will throw a IllegalStateException.
Method Summary | |
---|---|
void |
addInterceptor(Interceptor interceptor)
Adds an interceptor which will be executed after packets are received from the server. |
void |
close()
Closes this factory and release all its resources |
ClientSessionFactory |
copy()
Creates a copy of this factory. |
ClientSession |
createSession()
Creates a non-transacted session. |
ClientSession |
createSession(boolean autoCommitSends,
boolean autoCommitAcks)
Creates a session. |
ClientSession |
createSession(boolean xa,
boolean autoCommitSends,
boolean autoCommitAcks)
Creates a session. |
ClientSession |
createSession(boolean xa,
boolean autoCommitSends,
boolean autoCommitAcks,
boolean preAcknowledge)
Creates a session. |
ClientSession |
createSession(boolean autoCommitSends,
boolean autoCommitAcks,
int ackBatchSize)
Creates a session. |
ClientSession |
createSession(String username,
String password,
boolean xa,
boolean autoCommitSends,
boolean autoCommitAcks,
boolean preAcknowledge,
int ackBatchSize)
Creates an authenticated session. |
ClientSession |
createTransactedSession()
Creates a transacted session. |
ClientSession |
createXASession()
Creates a session with XA transaction semantics. |
int |
getAckBatchSize()
Returns the acknowledgements batch size. |
long |
getCallTimeout()
Returns the blocking calls timeout. |
long |
getClientFailureCheckPeriod()
Returns the period used to check if a client has failed to receive pings from the server. |
int |
getConfirmationWindowSize()
Returns the size for the confirmation window of clients using this factory. |
String |
getConnectionLoadBalancingPolicyClassName()
Returns the class name of the connection load balancing policy. |
long |
getConnectionTTL()
Returns the connection time-to-live. |
int |
getConsumerMaxRate()
Returns the maximum rate of message consumption for consumers created through this factory. |
int |
getConsumerWindowSize()
Returns the window size for flow control of the consumers created through this factory. |
String |
getDiscoveryAddress()
Returns the address to listen to discover which connectors this factory can use. |
long |
getDiscoveryInitialWaitTimeout()
Returns the initial wait timeout if this factory is configured to use discovery. |
int |
getDiscoveryPort()
Returns the port to listen to discover which connectors this factory can use. |
long |
getDiscoveryRefreshTimeout()
Returns the refresh timeout for discovered HornetQ servers. |
String |
getGroupID()
Returns the group ID that will be eventually set on each message for the property Message.HDR_GROUP_ID . |
int |
getInitialMessagePacketSize()
Returns the initial size of messages created through this factory. |
String |
getLocalBindAddress()
Returns the local bind address to which the multicast socket is bound for discovery. |
long |
getMaxRetryInterval()
Returns the maximum retry interval (in the case a retry interval multiplier has been specified). |
int |
getMinLargeMessageSize()
Returns the large message size threshold. |
int |
getProducerMaxRate()
Returns the maximum rate of message production for producers created through this factory. |
int |
getProducerWindowSize()
Returns the window size for flow control of the producers created through this factory. |
int |
getReconnectAttempts()
Returns the maximum number of attempts to retry connection in case of failure. |
long |
getRetryInterval()
Returns the time to retry connections created by this factory after failure. |
double |
getRetryIntervalMultiplier()
Returns the multiplier to apply to successive retry intervals. |
int |
getScheduledThreadPoolMaxSize()
Returns the maximum size of the scheduled thread pool. |
List<Pair<TransportConfiguration,TransportConfiguration>> |
getStaticConnectors()
Returns the list of live - backup connectors pairs configured that sessions created by this factory will use to connect to HornetQ servers or null if the factory is using discovery group. |
int |
getThreadPoolMaxSize()
Returns the maximum size of the thread pool. |
boolean |
isAutoGroup()
Returns whether producers created through this factory will automatically assign a group ID to the messages they sent. |
boolean |
isBlockOnAcknowledge()
Returns whether consumers created through this factory will block while sending message acknowledgements or do it asynchronously. |
boolean |
isBlockOnDurableSend()
Returns whether producers created through this factory will block while sending durable messages or do it asynchronously. |
boolean |
isBlockOnNonDurableSend()
Returns whether producers created through this factory will block while sending non-durable messages or do it asynchronously. |
boolean |
isCacheLargeMessagesClient()
When true , consumers created through this factory will create temporary files to cache large messages. |
boolean |
isFailoverOnInitialConnection()
Returns true if the client will automatically attempt to connect to the backup server if the initial connection to the live server fails Default value is HornetQClient.DEFAULT_FAILOVER_ON_INITIAL_CONNECTION . |
boolean |
isFailoverOnServerShutdown()
Returns whether connections created by this factory must failover in case the server they are connected to has normally shut down. |
boolean |
isPreAcknowledge()
Returns whether messages will pre-acknowledged on the server before they are sent to the consumers or not. |
boolean |
isUseGlobalPools()
Returns whether this factory will use global thread pools (shared among all the factories in the same JVM) or its own pools. |
boolean |
removeInterceptor(Interceptor interceptor)
Removes an interceptor. |
void |
setAckBatchSize(int ackBatchSize)
Sets the acknowledgements batch size. |
void |
setAutoGroup(boolean autoGroup)
Sets whether producers created through this factory will automatically assign a group ID to the messages they sent. |
void |
setBlockOnAcknowledge(boolean blockOnAcknowledge)
Sets whether consumers created through this factory will block while sending message acknowledgements or do it asynchronously. |
void |
setBlockOnDurableSend(boolean blockOnDurableSend)
Sets whether producers created through this factory will block while sending durable messages or do it asynchronously. |
void |
setBlockOnNonDurableSend(boolean blockOnNonDurableSend)
Sets whether producers created through this factory will block while sending non-durable messages or do it asynchronously. |
void |
setCacheLargeMessagesClient(boolean cached)
Sets whether large messages received by consumers created through this factory will be cached in temporary files or not. |
void |
setCallTimeout(long callTimeout)
Sets the blocking call timeout. |
void |
setClientFailureCheckPeriod(long clientFailureCheckPeriod)
Sets the period (in milliseconds) used to check if a client has failed to receive pings from the server. |
void |
setConfirmationWindowSize(int confirmationWindowSize)
Sets the size for the confirmation window buffer of clients using this factory. |
void |
setConnectionLoadBalancingPolicyClassName(String loadBalancingPolicyClassName)
Sets the class name of the connection load balancing policy. |
void |
setConnectionTTL(long connectionTTL)
Sets this factory's connections time-to-live. |
void |
setConsumerMaxRate(int consumerMaxRate)
Sets the maximum rate of message consumption for consumers created through this factory. |
void |
setConsumerWindowSize(int consumerWindowSize)
Sets the window size for flow control of the consumers created through this factory. |
void |
setDiscoveryAddress(String discoveryAddress)
Sets the address to listen to discover which connectors this factory can use. |
void |
setDiscoveryInitialWaitTimeout(long initialWaitTimeout)
Sets the initial wait timeout if this factory is configured to use discovery. |
void |
setDiscoveryPort(int discoveryPort)
Sets the port to listen to discover which connectors this factory can use. |
void |
setDiscoveryRefreshTimeout(long discoveryRefreshTimeout)
Sets the refresh timeout for discovered HornetQ servers. |
void |
setFailoverOnInitialConnection(boolean failover)
Sets the value for FailoverOnInitialReconnection |
void |
setFailoverOnServerShutdown(boolean failoverOnServerShutdown)
Sets whether connections created by this factory must failover in case the server they are connected to has normally shut down |
void |
setGroupID(String groupID)
Sets the group ID that will be set on each message sent through this factory. |
void |
setInitialMessagePacketSize(int size)
Sets the initial size of messages created through this factory. |
void |
setLocalBindAddress(String localBindAddress)
Sets the local bind address to which the multicast socket is bound for discovery. |
void |
setMaxRetryInterval(long maxRetryInterval)
Sets the maximum retry interval. |
void |
setMinLargeMessageSize(int minLargeMessageSize)
Sets the large message size threshold. |
void |
setPreAcknowledge(boolean preAcknowledge)
Sets to true to pre-acknowledge consumed messages on the server before they are sent to consumers, else set to false to let
clients acknowledge the message they consume. |
void |
setProducerMaxRate(int producerMaxRate)
Sets the maximum rate of message production for producers created through this factory. |
void |
setProducerWindowSize(int producerWindowSize)
Returns the window size for flow control of the producers created through this factory. |
void |
setReconnectAttempts(int reconnectAttempts)
Sets the maximum number of attempts to retry connection in case of failure. |
void |
setRetryInterval(long retryInterval)
Sets the time to retry connections created by this factory after failure. |
void |
setRetryIntervalMultiplier(double retryIntervalMultiplier)
Sets the multiplier to apply to successive retry intervals. |
void |
setScheduledThreadPoolMaxSize(int scheduledThreadPoolMaxSize)
Sets the maximum size of the scheduled thread pool. |
void |
setStaticConnectors(List<Pair<TransportConfiguration,TransportConfiguration>> staticConnectors)
Sets the static list of live - backup connectors pairs that sessions created by this factory will use to connect to HornetQ servers. |
void |
setThreadPoolMaxSize(int threadPoolMaxSize)
Sets the maximum size of the thread pool. |
void |
setUseGlobalPools(boolean useGlobalPools)
Sets whether this factory will use global thread pools (shared among all the factories in the same JVM) or its own pools. |
Method Detail |
---|
ClientSession createXASession() throws HornetQException
HornetQException
- if an exception occurs while creating the sessionClientSession createTransactedSession() throws HornetQException
HornetQException
- if an exception occurs while creating the sessionClientSession.commit()
ClientSession createSession() throws HornetQException
HornetQException
- if an exception occurs while creating the sessionClientSession createSession(boolean autoCommitSends, boolean autoCommitAcks) throws HornetQException
autoCommitSends
- true
to automatically commit message sends, false
to commit manuallyautoCommitAcks
- true
to automatically commit message acknowledgement, false
to commit manually
HornetQException
- if an exception occurs while creating the sessionClientSession createSession(boolean autoCommitSends, boolean autoCommitAcks, int ackBatchSize) throws HornetQException
autoCommitSends
- true
to automatically commit message sends, false
to commit manuallyautoCommitAcks
- true
to automatically commit message acknowledgement, false
to commit manuallyackBatchSize
- the batch size of the acknowledgements
HornetQException
- if an exception occurs while creating the sessionClientSession createSession(boolean xa, boolean autoCommitSends, boolean autoCommitAcks) throws HornetQException
xa
- whether the session support XA transaction semantic or notautoCommitSends
- true
to automatically commit message sends, false
to commit manuallyautoCommitAcks
- true
to automatically commit message acknowledgement, false
to commit manually
HornetQException
- if an exception occurs while creating the sessionClientSession createSession(boolean xa, boolean autoCommitSends, boolean autoCommitAcks, boolean preAcknowledge) throws HornetQException
xa
- whether the session support XA transaction semantic or notautoCommitSends
- true
to automatically commit message sends, false
to commit manuallyautoCommitAcks
- true
to automatically commit message acknowledgement, false
to commit manuallypreAcknowledge
- true
to pre-acknowledge messages on the server, false
to let the client acknowledge the messages
HornetQException
- if an exception occurs while creating the sessionClientSession createSession(String username, String password, boolean xa, boolean autoCommitSends, boolean autoCommitAcks, boolean preAcknowledge, int ackBatchSize) throws HornetQException
username
- the user namepassword
- the user passwordxa
- whether the session support XA transaction semantic or notautoCommitSends
- true
to automatically commit message sends, false
to commit manuallyautoCommitAcks
- true
to automatically commit message acknowledgement, false
to commit manuallypreAcknowledge
- true
to pre-acknowledge messages on the server, false
to let the client acknowledge the messages
HornetQException
- if an exception occurs while creating the sessionList<Pair<TransportConfiguration,TransportConfiguration>> getStaticConnectors()
null
if the factory is using discovery group.
The backup configuration (returned by Pair.b
) can be null
if there is no
backup for the corresponding live configuration (returned by Pair.a
)
void setStaticConnectors(List<Pair<TransportConfiguration,TransportConfiguration>> staticConnectors)
Pair.b
) can be null
if there is no
backup for the corresponding live configuration (returned by Pair.a
)
staticConnectors
- a list of pair of TransportConfiguration corresponding to the live - backup nodeslong getClientFailureCheckPeriod()
HornetQClient.DEFAULT_CLIENT_FAILURE_CHECK_PERIOD
.
void setClientFailureCheckPeriod(long clientFailureCheckPeriod)
clientFailureCheckPeriod
- the period to check failureboolean isCacheLargeMessagesClient()
true
, consumers created through this factory will create temporary files to cache large messages.
There is 1 temporary file created for each large message.
Default value is HornetQClient.DEFAULT_CACHE_LARGE_MESSAGE_CLIENT
.
true
if consumers created through this factory will cache large messages in temporary files, false
elsevoid setCacheLargeMessagesClient(boolean cached)
cached
- true
to cache large messages in temporary files, false
elselong getConnectionTTL()
HornetQClient.DEFAULT_CONNECTION_TTL
.
void setConnectionTTL(long connectionTTL)
connectionTTL
- period in millisecondslong getCallTimeout()
HornetQException
with the code HornetQException.CONNECTION_TIMEDOUT
.
Value is in milliseconds, default value is HornetQClient.DEFAULT_CALL_TIMEOUT
.
void setCallTimeout(long callTimeout)
callTimeout
- blocking call timeout in millisecondsint getMinLargeMessageSize()
HornetQClient.DEFAULT_MIN_LARGE_MESSAGE_SIZE
.
void setMinLargeMessageSize(int minLargeMessageSize)
minLargeMessageSize
- large message size threshold in bytesint getConsumerWindowSize()
HornetQClient.DEFAULT_CONSUMER_WINDOW_SIZE
.
void setConsumerWindowSize(int consumerWindowSize)
consumerWindowSize
- window size (in bytes) used for consumer flow controlint getConsumerMaxRate()
HornetQClient.DEFAULT_CONSUMER_MAX_RATE
.
void setConsumerMaxRate(int consumerMaxRate)
consumerMaxRate
- maximum rate of message consumption (in messages per seconds)int getConfirmationWindowSize()
HornetQClient.DEFAULT_CONFIRMATION_WINDOW_SIZE
.
void setConfirmationWindowSize(int confirmationWindowSize)
confirmationWindowSize
- size of the confirmation window (in bytes)int getProducerWindowSize()
HornetQClient.DEFAULT_PRODUCER_WINDOW_SIZE
.
void setProducerWindowSize(int producerWindowSize)
producerWindowSize
- window size (in bytest) for flow control of the producers created through this factory.int getProducerMaxRate()
HornetQClient.DEFAULT_PRODUCER_MAX_RATE
.
void setProducerMaxRate(int producerMaxRate)
producerMaxRate
- maximum rate of message production (in messages per seconds)boolean isBlockOnAcknowledge()
HornetQClient.DEFAULT_BLOCK_ON_ACKNOWLEDGE
.
void setBlockOnAcknowledge(boolean blockOnAcknowledge)
blockOnAcknowledge
- true
to block when sending message acknowledgements or false
to send them asynchronouslyboolean isBlockOnDurableSend()
HornetQClient.DEFAULT_BLOCK_ON_DURABLE_SEND
.
void setBlockOnDurableSend(boolean blockOnDurableSend)
blockOnDurableSend
- true
to block when sending durable messages or false
to send them asynchronouslyboolean isBlockOnNonDurableSend()
HornetQClient.DEFAULT_BLOCK_ON_NON_DURABLE_SEND
.
void setBlockOnNonDurableSend(boolean blockOnNonDurableSend)
blockOnNonDurableSend
- true
to block when sending non-durable messages or false
to send them asynchronouslyboolean isAutoGroup()
true
, a random unique group ID is created and set on each message for the property
Message.HDR_GROUP_ID
.
Default value is HornetQClient.DEFAULT_AUTO_GROUP
.
void setAutoGroup(boolean autoGroup)
autoGroup
- true
to automatically assign a group ID to each messages sent through this factory, false
elseString getGroupID()
Message.HDR_GROUP_ID
.
Default value is is null
and no group ID will be set on the messages.
void setGroupID(String groupID)
groupID
- the group ID to useboolean isPreAcknowledge()
HornetQClient.DEFAULT_PRE_ACKNOWLEDGE
void setPreAcknowledge(boolean preAcknowledge)
true
to pre-acknowledge consumed messages on the server before they are sent to consumers, else set to false
to let
clients acknowledge the message they consume.
preAcknowledge
- true
to enable pre-acknowledgement, false
elseint getAckBatchSize()
HornetQClient.DEFAULT_ACK_BATCH_SIZE
.
void setAckBatchSize(int ackBatchSize)
ackBatchSize
- acknowledgements batch sizeString getLocalBindAddress()
void setLocalBindAddress(String localBindAddress)
localBindAddress
- the local bind addressString getDiscoveryAddress()
void setDiscoveryAddress(String discoveryAddress)
discoveryAddress
- address to listen to discover which connectors this factory can useint getDiscoveryPort()
void setDiscoveryPort(int discoveryPort)
discoveryPort
- port to listen to discover which connectors this factory can uselong getDiscoveryRefreshTimeout()
HornetQClient.DEFAULT_DISCOVERY_REFRESH_TIMEOUT
.
void setDiscoveryRefreshTimeout(long discoveryRefreshTimeout)
discoveryRefreshTimeout
- refresh timeout (in milliseconds) for discovered HornetQ serverslong getDiscoveryInitialWaitTimeout()
HornetQClient.DEFAULT_DISCOVERY_INITIAL_WAIT_TIMEOUT
.
void setDiscoveryInitialWaitTimeout(long initialWaitTimeout)
initialWaitTimeout
- initial wait timeout when using discoveryboolean isUseGlobalPools()
HornetQClient.DEFAULT_USE_GLOBAL_POOLS
.
true
if this factory uses global thread pools, false
elsevoid setUseGlobalPools(boolean useGlobalPools)
useGlobalPools
- true
to let this factory uses global thread pools, false
elseint getScheduledThreadPoolMaxSize()
HornetQClient.DEFAULT_SCHEDULED_THREAD_POOL_MAX_SIZE
.
void setScheduledThreadPoolMaxSize(int scheduledThreadPoolMaxSize)
scheduledThreadPoolMaxSize
- maximum size of the scheduled thread pool.int getThreadPoolMaxSize()
HornetQClient.DEFAULT_THREAD_POOL_MAX_SIZE
.
void setThreadPoolMaxSize(int threadPoolMaxSize)
threadPoolMaxSize
- maximum size of the thread pool.long getRetryInterval()
HornetQClient.DEFAULT_RETRY_INTERVAL
.
void setRetryInterval(long retryInterval)
retryInterval
- time (in milliseconds) to retry connections created by this factory after failuredouble getRetryIntervalMultiplier()
HornetQClient.DEFAULT_RETRY_INTERVAL_MULTIPLIER
.
void setRetryIntervalMultiplier(double retryIntervalMultiplier)
retryIntervalMultiplier
- multiplier to apply to successive retry intervalslong getMaxRetryInterval()
HornetQClient.DEFAULT_MAX_RETRY_INTERVAL
.
void setMaxRetryInterval(long maxRetryInterval)
maxRetryInterval
- maximum retry interval to apply in the case a retry interval multiplier has been specifiedint getReconnectAttempts()
HornetQClient.DEFAULT_RECONNECT_ATTEMPTS
.
void setReconnectAttempts(int reconnectAttempts)
reconnectAttempts
- maximum number of attempts to retry connection in case of failureboolean isFailoverOnInitialConnection()
HornetQClient.DEFAULT_FAILOVER_ON_INITIAL_CONNECTION
.
void setFailoverOnInitialConnection(boolean failover)
failover
- boolean isFailoverOnServerShutdown()
HornetQClient.DEFAULT_FAILOVER_ON_SERVER_SHUTDOWN
.
true
if connections must failover if the server has normally shut down, else false
void setFailoverOnServerShutdown(boolean failoverOnServerShutdown)
failoverOnServerShutdown
- true
if connections must failover if the server has normally shut down, false
elseString getConnectionLoadBalancingPolicyClassName()
void setConnectionLoadBalancingPolicyClassName(String loadBalancingPolicyClassName)
ConnectionLoadBalancingPolicy
.
loadBalancingPolicyClassName
- class name of the connection load balancing policyint getInitialMessagePacketSize()
HornetQClient.DEFAULT_INITIAL_MESSAGE_PACKET_SIZE
.
void setInitialMessagePacketSize(int size)
size
- initial size of messages created through this factory.void addInterceptor(Interceptor interceptor)
interceptor
- an Interceptorboolean removeInterceptor(Interceptor interceptor)
interceptor
- interceptor to remove
true
if the interceptor is removed from this factory, false
elsevoid close()
ClientSessionFactory copy()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |