org.hornetq.core.client.impl

Class ClientSessionFactoryImpl

java.lang.Object

org.hornetq.core.client.impl.ClientSessionFactoryImpl

All Implemented Interfaces:

AutoCloseable, ClientSessionFactory, ClientSessionFactoryInternal, ConnectionLifeCycleListener

public class ClientSessionFactoryImpl
extends Object
implements ClientSessionFactoryInternal, ConnectionLifeCycleListener

Author:

Tim Fox

See Also:

ClientSessionFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ClientSessionFactoryImpl.CloseRunnable

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
void	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, boolean failoverOnInitialConnection)
void	connectionCreated(HornetQComponent component, Connection connection, String protocol) This method is used both by client connector creation and server connection creation through acceptors.
void	connectionDestroyed(Object connectionID) Called when a connection is destroyed.
void	connectionException(Object connectionID, HornetQException me) Called when an error occurs on the connection.
void	connectionReadyForWrites(Object connectionID, boolean ready)
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.
void	disableFinalizeCheck()
protected void	finalize()
Object	getBackupConnector()
ConfirmationWindowWarning	getConfirmationWindowWarning()
CoreRemotingConnection	getConnection() Returns the code connection used by this session factory.
Object	getConnector()
TransportConfiguration	getConnectorConfiguration()
ServerLocator	getServerLocator()
boolean	isClosed()
int	numConnections()
int	numSessions()
boolean	removeFailoverListener(FailoverEventListener listener) Removes a FailoverEventListener to the session.
boolean	removeFailureListener(SessionFailureListener listener)
void	removeSession(ClientSessionInternal session, boolean failingOver)
void	sendNodeAnnounce(long currentEventID, String nodeID, String nodeName, boolean isBackup, TransportConfiguration config, TransportConfiguration backupConfig)
void	setBackupConnector(TransportConfiguration live, TransportConfiguration backUp)
void	setReconnectAttempts(int attempts)
void	stopPingingAfterOne()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

traceException

public final Exception traceException

CLOSE_RUNNABLES

public static final Set<ClientSessionFactoryImpl.CloseRunnable> CLOSE_RUNNABLES

Method Detail

disableFinalizeCheck

public void disableFinalizeCheck()

Specified by:

disableFinalizeCheck in interface ClientSessionFactoryInternal

connect

public void connect(int initialConnectAttempts,
           boolean failoverOnInitialConnection)
             throws HornetQException

Specified by:

connect in interface ClientSessionFactoryInternal

Throws:

HornetQException

getConnectorConfiguration

public TransportConfiguration getConnectorConfiguration()

Specified by:

getConnectorConfiguration in interface ClientSessionFactoryInternal

setBackupConnector

public void setBackupConnector(TransportConfiguration live,
                      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)
                            throws HornetQException

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:

HornetQException - if an exception occurs while creating the session

createSession

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

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:

HornetQException - if an exception occurs while creating the session

createXASession

public ClientSession createXASession()
                              throws HornetQException

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:

HornetQException - if an exception occurs while creating the session

createTransactedSession

public ClientSession createTransactedSession()
                                      throws HornetQException

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:

HornetQException - if an exception occurs while creating the session

See Also:

ClientSession.commit()

createSession

public ClientSession createSession()
                            throws HornetQException

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:

HornetQException - if an exception occurs while creating the session

createSession

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

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:

HornetQException - if an exception occurs while creating the session

createSession

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

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:

HornetQException - if an exception occurs while creating the session

createSession

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

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:

HornetQException - if an exception occurs while creating the session

connectionCreated

public void connectionCreated(HornetQComponent component,
                     Connection connection,
                     String protocol)

Description copied from interface: ConnectionLifeCycleListener

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 hornetq-server and hornetq-client packages while avoiding to pull too much into hornetq-core. The pivotal point keeping us from removing the method is ConnectorFactory and the usage of it.

Specified by:

connectionCreated in interface ConnectionLifeCycleListener

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)

Description copied from interface: ConnectionLifeCycleListener

Called when a connection is destroyed.

Specified by:

connectionDestroyed in interface ConnectionLifeCycleListener

Parameters:

connectionID - the connection being destroyed.

connectionException

public void connectionException(Object connectionID,
                       HornetQException me)

Description copied from interface: ConnectionLifeCycleListener

Called when an error occurs on the connection.

Specified by:

connectionException in interface ConnectionLifeCycleListener

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 ConnectionLifeCycleListener

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 void 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

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

isClosed

public boolean isClosed()

Specified by:

isClosed in interface ClientSessionFactory

Returns:

true if the factory is closed, false otherwise.

getServerLocator

public ServerLocator getServerLocator()

Specified by:

getServerLocator in interface ClientSessionFactory

Returns:

the server locator associated with this session factory

stopPingingAfterOne

public void stopPingingAfterOne()

getConnection

public CoreRemotingConnection getConnection()

Description copied from interface: ClientSessionFactory

Returns the code connection used by this session factory.

Specified by:

getConnection in interface ClientSessionFactory

Returns:

the core connection

sendNodeAnnounce

public void sendNodeAnnounce(long currentEventID,
                    String nodeID,
                    String nodeName,
                    boolean isBackup,
                    TransportConfiguration config,
                    TransportConfiguration backupConfig)

Specified by:

sendNodeAnnounce in interface ClientSessionFactoryInternal

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

toString

public String toString()

Overrides:

toString in class Object

setReconnectAttempts

public void setReconnectAttempts(int attempts)

Specified by:

setReconnectAttempts in interface ClientSessionFactoryInternal

getConnector

public Object getConnector()

Specified by:

getConnector in interface ClientSessionFactoryInternal

getConfirmationWindowWarning

public ConfirmationWindowWarning getConfirmationWindowWarning()

Specified by:

getConfirmationWindowWarning in interface ClientSessionFactoryInternal