Package org.apache.activemq.artemis.core.client.impl

Class ClientSessionFactoryImpl

java.lang.Object

org.apache.activemq.artemis.core.client.impl.ClientSessionFactoryImpl

All Implemented Interfaces:

AutoCloseable, ClientSessionFactory, ClientSessionFactoryInternal, BaseConnectionLifeCycleListener<ClientProtocolManager>, ClientConnectionLifeCycleListener

public class ClientSessionFactoryImpl
extends Object
implements ClientSessionFactoryInternal, ClientConnectionLifeCycleListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ClientSessionFactoryImpl.CloseRunnable

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<ClientSessionFactoryImpl.CloseRunnable>	CLOSE_RUNNABLES
final Exception	createTrace

Constructor Summary

Constructors

Constructor	Description
ClientSessionFactoryImpl(ServerLocatorInternal serverLocator, TransportConfiguration connectorConfig, ServerLocatorConfig locatorConfig, int reconnectAttempts, Executor threadPool, ScheduledExecutorService scheduledThreadPool, Executor flowControlThreadPool, List<Interceptor> incomingInterceptors, List<Interceptor> outgoingInterceptors)

Method Summary

Modifier and Type	Method	Description
ClientSessionFactoryImpl	addFailoverListener(FailoverEventListener listener)	Adds a FailoverEventListener to the session which is notified if a failover event occurs on the session.
void	addFailureListener(SessionFailureListener listener)
void	causeExit()
void	cleanup()	Opposed to close, will call cleanup only on every created session and children objects.
void	close()	Closes this factory and any session created by it.
void	connect(int initialConnectAttempts)
void	connect(int initialConnectAttempts, boolean failoverOnInitialConnection)	Deprecated.
void	connectionCreated(ActiveMQComponent component, Connection connection, ClientProtocolManager protocol)	This method is used both by client connector creation and server connection creation through acceptors.
void	connectionDestroyed(Object connectionID, boolean failed)	Called when a connection is destroyed.
void	connectionException(Object connectionID, ActiveMQException me)	Called when an error occurs on the connection.
void	connectionReadyForWrites(Object connectionID, boolean ready)
protected Connector	createConnector(ConnectorFactory connectorFactory, TransportConfiguration configuration)
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	createSession(String username, String password, boolean xa, boolean autoCommitSends, boolean autoCommitAcks, boolean preAcknowledge, int ackBatchSize, String clientID)	Creates an authenticated session.
protected SessionContext	createSessionChannel(String name, String username, String password, boolean xa, boolean autoCommitSends, boolean autoCommitAcks, boolean preAcknowledge, String clientID)
ClientSession	createTransactedSession()	Creates a transacted session.
protected Connection	createTransportConnection()	It will connect to either primary or backup accordingly to the current configurations it will also switch to backup case it can't connect to primary and there's a backup configured
ClientSession	createXASession()	Creates a session with XA transaction semantics.
protected RemotingConnection	establishNewConnection()
void	flushCloseExecutor(int time, TimeUnit unit)
Object	getBackupConnector()
ConfirmationWindowWarning	getConfirmationWindowWarning()
RemotingConnection	getConnection()	Returns the code connection used by this session factory.
Object	getConnector()
TransportConfiguration	getConnectorConfiguration()	Returns the configuration used.
String	getPrimaryNodeId()
int	getReconnectAttempts()
ServerLocator	getServerLocator()	Returns the server locator associated with this session factory.
protected ConnectorFactory	instantiateConnectorFactory(String connectorFactoryClassName)
boolean	isClosed()	Returns true if the factory is closed, false otherwise.
Lock	lockFailover()
int	numConnections()
int	numSessions()
protected Connection	openTransportConnection(Connector connector)
boolean	removeFailoverListener(FailoverEventListener listener)	Removes a FailoverEventListener to the session.
boolean	removeFailureListener(SessionFailureListener listener)
void	removeSession(ClientSessionInternal session, boolean failingOver)
protected void	schedulePing()
void	setBackupConnector(TransportConfiguration primary, TransportConfiguration backUp)
void	setReconnectAttempts(int attempts)
void	stopPingingAfterOne()
boolean	waitForRetry(long interval)
boolean	waitForTopology(long timeout, TimeUnit unit)

Methods inherited from class java.lang.Object

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

Field Details

createTrace

public final Exception createTrace

CLOSE_RUNNABLES

public static final Set<ClientSessionFactoryImpl.CloseRunnable> CLOSE_RUNNABLES

Constructor Details

ClientSessionFactoryImpl

public ClientSessionFactoryImpl(ServerLocatorInternal serverLocator,
 TransportConfiguration connectorConfig,
 ServerLocatorConfig locatorConfig,
 int reconnectAttempts,
 Executor threadPool,
 ScheduledExecutorService scheduledThreadPool,
 Executor flowControlThreadPool,
 List<Interceptor> incomingInterceptors,
 List<Interceptor> outgoingInterceptors)

Method Details

lockFailover

public Lock lockFailover()

Specified by:

lockFailover in interface ClientSessionFactoryInternal

connect

public void connect(int initialConnectAttempts)
             throws ActiveMQException

Specified by:

connect in interface ClientSessionFactoryInternal

Throws:

ActiveMQException

connect

@Deprecated
public void connect(int initialConnectAttempts,
 boolean failoverOnInitialConnection)
             throws ActiveMQException

Deprecated.

Specified by:

connect in interface ClientSessionFactoryInternal

Throws:

ActiveMQException

getConnectorConfiguration

public TransportConfiguration getConnectorConfiguration()

Description copied from interface: ClientSessionFactory

Returns the configuration used.

Specified by:

getConnectorConfiguration in interface ClientSessionFactory

Returns:

the configuration used

setBackupConnector

public void setBackupConnector(TransportConfiguration primary,
 TransportConfiguration backUp)

Specified by:

setBackupConnector in interface ClientSessionFactoryInternal

getBackupConnector

public Object getBackupConnector()

Specified by:

getBackupConnector in interface ClientSessionFactoryInternal

createSession

public ClientSession createSession(String username,
 String password,
 boolean xa,
 boolean autoCommitSends,
 boolean autoCommitAcks,
 boolean preAcknowledge,
 int ackBatchSize,
 String clientID)
                            throws ActiveMQException

Description copied from interface: ClientSessionFactory

Creates an authenticated session.

It is possible to pre-acknowledge messages on the server so that the client can avoid additional network trip to the server to acknowledge messages. While this increase performance, this does not guarantee delivery (as messages can be lost after being pre-acknowledged on the server). Use with caution if your application design permits it.

Specified by:

createSession in interface ClientSessionFactory

Parameters:

username - the user name

password - the user password

xa - whether the session support XA transaction semantic or not

autoCommitSends - true to automatically commit message sends, false to commit manually

autoCommitAcks - true to automatically commit message acknowledgement, false to commit manually

preAcknowledge - true to pre-acknowledge messages on the server, false to let the client acknowledge the messages

clientID - the session clientID

Returns:

a ClientSession

Throws:

ActiveMQException - if an exception occurs while creating the session

createSession

public ClientSession createSession(String username,
 String password,
 boolean xa,
 boolean autoCommitSends,
 boolean autoCommitAcks,
 boolean preAcknowledge,
 int ackBatchSize)
                            throws ActiveMQException

Description copied from interface: ClientSessionFactory

Creates an authenticated session.

It is possible to pre-acknowledge messages on the server so that the client can avoid additional network trip to the server to acknowledge messages. While this increase performance, this does not guarantee delivery (as messages can be lost after being pre-acknowledged on the server). Use with caution if your application design permits it.

Specified by:

createSession in interface ClientSessionFactory

Parameters:

username - the user name

password - the user password

xa - whether the session support XA transaction semantic or not

autoCommitSends - true to automatically commit message sends, false to commit manually

autoCommitAcks - true to automatically commit message acknowledgement, false to commit manually

preAcknowledge - true to pre-acknowledge messages on the server, false to let the client acknowledge the messages

Returns:

a ClientSession

Throws:

ActiveMQException - if an exception occurs while creating the session

createSession

public ClientSession createSession(boolean autoCommitSends,
 boolean autoCommitAcks,
 int ackBatchSize)
                            throws ActiveMQException

Description copied from interface: ClientSessionFactory

Creates a session.

Specified by:

createSession in interface ClientSessionFactory

Parameters:

autoCommitSends - true to automatically commit message sends, false to commit manually

autoCommitAcks - true to automatically commit message acknowledgement, false to commit manually

ackBatchSize - the batch size of the acknowledgements

Returns:

a ClientSession

Throws:

ActiveMQException - if an exception occurs while creating the session

createXASession

public ClientSession createXASession()
                              throws ActiveMQException

Description copied from interface: ClientSessionFactory

Creates a session with XA transaction semantics.

Specified by:

createXASession in interface ClientSessionFactory

Returns:

a ClientSession with XA transaction semantics

Throws:

ActiveMQException - if an exception occurs while creating the session

createTransactedSession

public ClientSession createTransactedSession()
                                      throws ActiveMQException

Description copied from interface: ClientSessionFactory

Creates a transacted session.

It is up to the client to commit when sending and acknowledging messages.

Specified by:

createTransactedSession in interface ClientSessionFactory

Returns:

a transacted ClientSession

Throws:

ActiveMQException - if an exception occurs while creating the session

See Also:

• ClientSession.commit()

createSession

public ClientSession createSession()
                            throws ActiveMQException

Description copied from interface: ClientSessionFactory

Creates a non-transacted session. Message sends and acknowledgements are automatically committed by the session. This does not mean that messages are automatically acknowledged, only that when messages are acknowledged, the session will automatically commit the transaction containing the acknowledgements.

Specified by:

createSession in interface ClientSessionFactory

Returns:

a non-transacted ClientSession

Throws:

ActiveMQException - if an exception occurs while creating the session

createSession

public ClientSession createSession(boolean autoCommitSends,
 boolean autoCommitAcks)
                            throws ActiveMQException

Description copied from interface: ClientSessionFactory

Creates a session.

Specified by:

createSession in interface ClientSessionFactory

Parameters:

autoCommitSends - true to automatically commit message sends, false to commit manually

autoCommitAcks - true to automatically commit message acknowledgement, false to commit manually

Returns:

a ClientSession

Throws:

ActiveMQException - if an exception occurs while creating the session

createSession

public ClientSession createSession(boolean xa,
 boolean autoCommitSends,
 boolean autoCommitAcks)
                            throws ActiveMQException

Description copied from interface: ClientSessionFactory

Creates a session.

Specified by:

createSession in interface ClientSessionFactory

Parameters:

xa - whether the session support XA transaction semantic or not

autoCommitSends - true to automatically commit message sends, false to commit manually

autoCommitAcks - true to automatically commit message acknowledgement, false to commit manually

Returns:

a ClientSession

Throws:

ActiveMQException - if an exception occurs while creating the session

createSession

public ClientSession createSession(boolean xa,
 boolean autoCommitSends,
 boolean autoCommitAcks,
 boolean preAcknowledge)
                            throws ActiveMQException

Description copied from interface: ClientSessionFactory

Creates a session.

It is possible to pre-acknowledge messages on the server so that the client can avoid additional network trip to the server to acknowledge messages. While this increase performance, this does not guarantee delivery (as messages can be lost after being pre-acknowledged on the server). Use with caution if your application design permits it.

Specified by:

createSession in interface ClientSessionFactory

Parameters:

xa - whether the session support XA transaction semantic or not

autoCommitSends - true to automatically commit message sends, false to commit manually

autoCommitAcks - true to automatically commit message acknowledgement, false to commit manually

preAcknowledge - true to pre-acknowledge messages on the server, false to let the client acknowledge the messages

Returns:

a ClientSession

Throws:

ActiveMQException - if an exception occurs while creating the session

connectionCreated

public void connectionCreated(ActiveMQComponent component,
 Connection connection,
 ClientProtocolManager protocol)

Description copied from interface: BaseConnectionLifeCycleListener

This method is used both by client connector creation and server connection creation through acceptors. On the client side the component parameter is normally passed as null.

Leaving this method here and adding a different one at ServerConnectionLifeCycleListener is a compromise for a reasonable split between the activemq-server and activemq-client packages while avoiding to pull too much into activemq-core. The pivotal point keeping us from removing the method is ConnectorFactory and the usage of it.

Specified by:

connectionCreated in interface BaseConnectionLifeCycleListener<ClientProtocolManager>

Parameters:

component - This will probably be an Acceptor and only used on the server side.

connection - the connection that has been created

protocol - the messaging protocol type this connection uses

connectionDestroyed

public void connectionDestroyed(Object connectionID,
 boolean failed)

Description copied from interface: BaseConnectionLifeCycleListener

Called when a connection is destroyed.

Specified by:

connectionDestroyed in interface BaseConnectionLifeCycleListener<ClientProtocolManager>

Parameters:

connectionID - the connection being destroyed.

connectionException

public void connectionException(Object connectionID,
 ActiveMQException me)

Description copied from interface: BaseConnectionLifeCycleListener

Called when an error occurs on the connection.

Specified by:

connectionException in interface BaseConnectionLifeCycleListener<ClientProtocolManager>

Parameters:

connectionID - the id of the connection.

me - the exception.

removeSession

public void removeSession(ClientSessionInternal session,
 boolean failingOver)

Specified by:

removeSession in interface ClientSessionFactoryInternal

connectionReadyForWrites

public void connectionReadyForWrites(Object connectionID,
 boolean ready)

Specified by:

connectionReadyForWrites in interface BaseConnectionLifeCycleListener<ClientProtocolManager>

numConnections

public int numConnections()

Specified by:

numConnections in interface ClientSessionFactoryInternal

numSessions

public int numSessions()

Specified by:

numSessions in interface ClientSessionFactoryInternal

addFailureListener

public void addFailureListener(SessionFailureListener listener)

Specified by:

addFailureListener in interface ClientSessionFactoryInternal

removeFailureListener

public boolean removeFailureListener(SessionFailureListener listener)

Specified by:

removeFailureListener in interface ClientSessionFactoryInternal

addFailoverListener

public ClientSessionFactoryImpl addFailoverListener(FailoverEventListener listener)

Description copied from interface: ClientSessionFactory

Adds a FailoverEventListener to the session which is notified if a failover event occurs on the session.

Specified by:

addFailoverListener in interface ClientSessionFactory

Parameters:

listener - the listener to add

Returns:

this ClientSessionFactory

removeFailoverListener

public boolean removeFailoverListener(FailoverEventListener listener)

Description copied from interface: ClientSessionFactory

Removes a FailoverEventListener to the session.

Specified by:

removeFailoverListener in interface ClientSessionFactory

Parameters:

listener - the listener to remove

Returns:

true if the listener was removed, false else

causeExit

public void causeExit()

Specified by:

causeExit in interface ClientSessionFactoryInternal

close

public void close()

Description copied from interface: ClientSessionFactory

Closes this factory and any session created by it.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ClientSessionFactory

cleanup

public void cleanup()

Description copied from interface: ClientSessionFactory

Opposed to close, will call cleanup only on every created session and children objects.

Specified by:

cleanup in interface ClientSessionFactory

waitForTopology

public boolean waitForTopology(long timeout,
 TimeUnit unit)

Specified by:

waitForTopology in interface ClientSessionFactoryInternal

isClosed

public boolean isClosed()

Description copied from interface: ClientSessionFactory

Returns true if the factory is closed, false otherwise.

Specified by:

isClosed in interface ClientSessionFactory

Returns:

true if the factory is closed, false otherwise

getServerLocator

public ServerLocator getServerLocator()

Description copied from interface: ClientSessionFactory

Returns the server locator associated with this session factory.

Specified by:

getServerLocator in interface ClientSessionFactory

Returns:

the server locator associated with this session factory

stopPingingAfterOne

public void stopPingingAfterOne()

waitForRetry

public boolean waitForRetry(long interval)

Specified by:

waitForRetry in interface ClientSessionFactoryInternal

getConnection

public RemotingConnection getConnection()

Description copied from interface: ClientSessionFactory

Returns the code connection used by this session factory.

Specified by:

getConnection in interface ClientSessionFactory

Returns:

the code connection used by this session factory

schedulePing

protected void schedulePing()

instantiateConnectorFactory

protected ConnectorFactory instantiateConnectorFactory(String connectorFactoryClassName)

setReconnectAttempts

public void setReconnectAttempts(int attempts)

Specified by:

setReconnectAttempts in interface ClientSessionFactoryInternal

getReconnectAttempts

public int getReconnectAttempts()

getConnector

public Object getConnector()

Specified by:

getConnector in interface ClientSessionFactoryInternal

getConfirmationWindowWarning

public ConfirmationWindowWarning getConfirmationWindowWarning()

Specified by:

getConfirmationWindowWarning in interface ClientSessionFactoryInternal

openTransportConnection

protected Connection openTransportConnection(Connector connector)

createConnector

protected Connector createConnector(ConnectorFactory connectorFactory,
 TransportConfiguration configuration)

createTransportConnection

protected Connection createTransportConnection()

It will connect to either primary or backup accordingly to the current configurations it will also switch to backup case it can't connect to primary and there's a backup configured

establishNewConnection

protected RemotingConnection establishNewConnection()

createSessionChannel

protected SessionContext createSessionChannel(String name,
 String username,
 String password,
 boolean xa,
 boolean autoCommitSends,
 boolean autoCommitAcks,
 boolean preAcknowledge,
 String clientID)
                                       throws ActiveMQException

Throws:

ActiveMQException

getPrimaryNodeId

public String getPrimaryNodeId()

Specified by:

getPrimaryNodeId in interface ClientSessionFactoryInternal

flushCloseExecutor

public void flushCloseExecutor(int time,
 TimeUnit unit)