com.allanbank.mongodb.client.connection.proxy

Class AbstractProxyMultipleConnection<K>

java.lang.Object

com.allanbank.mongodb.client.connection.proxy.AbstractProxyMultipleConnection<K>

Type Parameters:

K - The key used to track the various connections.

All Implemented Interfaces:

Connection, Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

ReplicaSetConnection, ShardedConnection

public abstract class AbstractProxyMultipleConnection<K>
extends Object
implements Connection

AbstractProxyMultipleConnection provides the core functionality for a connection that multiplexes requests across multiple connections.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2014, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractProxyMultipleConnection.ClusterAndConnectionListener ClusterListener provides a listener for changes in the cluster.

Field Summary

Fields

Modifier and Type	Field and Description
protected Cluster	myCluster The state of the cluster for finding secondary connections.
protected MongoClientConfiguration	myConfig The MongoDB client configuration.
protected PropertyChangeSupport	myEventSupport Support for emitting property change events.
protected ProxiedConnectionFactory	myFactory The connection factory for opening secondary connections.
protected AtomicReference<Connection>	myLastUsedConnection The most recently used connection.
protected PropertyChangeListener	myListener The listener for changes in the cluster and connections.
protected K	myMainKey The primary instance this connection is connected to.
protected AtomicBoolean	myOpen Set to false when the connection is closed.
protected AtomicBoolean	myShutdown Set to true when the connection should be gracefully closed.

Fields inherited from interface com.allanbank.mongodb.client.connection.Connection

COMMAND_COLLECTION, OPEN_PROP_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractProxyMultipleConnection(Connection proxiedConnection, K server, Cluster cluster, ProxiedConnectionFactory factory, MongoClientConfiguration config) Creates a new AbstractProxyMultipleConnection.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to this connection.
protected Connection	cacheConnection(K server, Connection conn) Caches the connection to the server if there is not already a connection in the cache.
void	close() Closes the underlying connection.
protected abstract Connection	connect(K server) Attempts to create a connection to the server, catching any exceptions thrown.
protected Connection	connection(K server) Returns the cached connection for the specified key.
protected MongoDbException	createReconnectFailure(Message message1, Message message2) Creates a exception for a reconnect failure.
protected void	doSend(Connection conn, Message message1, Message message2, ReplyCallback reply) Sends the message on the connection.
protected abstract List<K>	findPotentialKeys(Message message1, Message message2) Locates the set of servers that can be used to send the specified messages.
void	flush()
protected abstract String	getConnectionType() Returns the type of connection (for logs, etc.).
int	getPendingCount() Returns the number of messages that are pending responses from the server.
protected void	handleConnectionClosed(Connection connection) Tries to reconnect previously open Connections.
boolean	isAvailable() Returns true if the connection is open and not shutting down, false otherwise.
boolean	isIdle() Determines if the connection is idle.
boolean	isOpen() Determines if the connection is open.
boolean	isShuttingDown() Returns true if the connection is being gracefully closed, false otherwise.
void	raiseErrors(MongoDbException exception) Notifies the call backs for the pending and optionally the to be sent messages that there has been an external, unrecoverable error.
protected abstract ConnectionInfo<K>	reconnectMain() Creates a connection back to the main server for this connection.
protected void	removeCachedConnection(Object key, Connection connection) Remove the connection from the cache.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener from this connection.
void	send(Message message1, Message message2, ReplyCallback replyCallback) Sends a message on the connection.
void	send(Message message, ReplyCallback replyCallback) Sends a message on the connection.
void	shutdown(boolean force) Notifies the connection that once all outstanding requests have been sent and all replies received the Connection should be closed.
String	toString()
protected boolean	trySend(List<K> servers, Message message1, Message message2, ReplyCallback reply) Tries to send the messages to the first server with either an open connection or that we can open a connection to.
protected void	updateMain(ConnectionInfo<K> newConn) Update the state with the new primary server.
void	waitForClosed(int timeout, TimeUnit timeoutUnits) Waits for the connection to become idle.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.allanbank.mongodb.client.connection.Connection

getServerName

Field Detail

myCluster

protected final Cluster myCluster

The state of the cluster for finding secondary connections.

myConfig

protected final MongoClientConfiguration myConfig

The MongoDB client configuration.

myEventSupport

protected final PropertyChangeSupport myEventSupport

Support for emitting property change events.

myFactory

protected final ProxiedConnectionFactory myFactory

The connection factory for opening secondary connections.

myLastUsedConnection

protected final AtomicReference<Connection> myLastUsedConnection

The most recently used connection.

myListener

protected final PropertyChangeListener myListener

The listener for changes in the cluster and connections.

myMainKey

protected volatile K myMainKey

The primary instance this connection is connected to.

myOpen

protected final AtomicBoolean myOpen

Set to false when the connection is closed.

myShutdown

protected final AtomicBoolean myShutdown

Set to true when the connection should be gracefully closed.

Constructor Detail

AbstractProxyMultipleConnection

public AbstractProxyMultipleConnection(Connection proxiedConnection,
                               K server,
                               Cluster cluster,
                               ProxiedConnectionFactory factory,
                               MongoClientConfiguration config)

Creates a new AbstractProxyMultipleConnection.

Parameters:

proxiedConnection - The connection being proxied.

server - The primary server this connection is connected to.

cluster - The state of the cluster for finding secondary connections.

factory - The connection factory for opening secondary connections.

config - The MongoDB client configuration.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a PropertyChangeListener to this connection. Events are fired as the state of the connection changes.

Overridden to add this listener to this connection's event source.

Specified by:

addPropertyChangeListener in interface Connection

Parameters:

listener - The listener for the change events.

close

public void close()

Closes the underlying connection.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

See Also:

Closeable.close()

flush

public void flush()
           throws IOException

Forwards the call to the proxied Connection.

Specified by:

flush in interface Flushable

Throws:

IOException

See Also:

Flushable.flush()

getPendingCount

public int getPendingCount()

Returns the number of messages that are pending responses from the server.

Overridden to return the pending count for the last connection used to send a message.

Specified by:

getPendingCount in interface Connection

Returns:

The number of messages pending responses from the server.

isAvailable

public boolean isAvailable()

Returns true if the connection is open and not shutting down, false otherwise.

True if the connection is open and not shutting down.

Specified by:

isAvailable in interface Connection

Returns:

True if the connection is open and not shutting down, false otherwise.

isIdle

public boolean isIdle()

Determines if the connection is idle.

Overridden to return if the last used connection is idle.

Specified by:

isIdle in interface Connection

Returns:

True if the connection is waiting for messages to send and has no outstanding messages to receive.

isOpen

public boolean isOpen()

Determines if the connection is open.

Overridden to return if this connection has any open connections.

Specified by:

isOpen in interface Connection

Returns:

True if the connection is open and thinks it can send messages.

isShuttingDown

public boolean isShuttingDown()

Returns true if the connection is being gracefully closed, false otherwise.

Overridden to return if the last used connection is shutting down.

Specified by:

isShuttingDown in interface Connection

Returns:

True if the connection is being gracefully closed, false otherwise.

raiseErrors

public void raiseErrors(MongoDbException exception)

Notifies the call backs for the pending and optionally the to be sent messages that there has been an external, unrecoverable error.

Overridden to raise the errors with all of the underlying connections.

Specified by:

raiseErrors in interface Connection

Parameters:

exception - The error condition.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a PropertyChangeListener from this connection.

Overridden to remove the listener from this connection.

Specified by:

removePropertyChangeListener in interface Connection

Parameters:

listener - The listener for the change events.

send

public void send(Message message1,
        Message message2,
        ReplyCallback replyCallback)
          throws MongoDbException

Sends a message on the connection.

Locates all of the potential servers that can receive all of the messages. Tries to then send the messages to a server with a connection already open or failing that tries to open a connection to open of the servers.

Specified by:

send in interface Connection

Parameters:

message1 - The first message to send on the connection.

message2 - The second message to send on the connection.

replyCallback - The callback to notify of responses to the message2. May be null.

Throws:

MongoDbException - On an error sending the message.

send

public void send(Message message,
        ReplyCallback replyCallback)
          throws MongoDbException

Sends a message on the connection.

Locates all of the potential servers that can receive all of the messages. Tries to then send the messages to a server with a connection already open or failing that tries to open a connection to open of the servers.

Specified by:

send in interface Connection

Parameters:

message - The message to send on the connection.

replyCallback - The callback to notify of responses to the messages. May be null.

Throws:

MongoDbException - On an error sending the message.

shutdown

public void shutdown(boolean force)

Notifies the connection that once all outstanding requests have been sent and all replies received the Connection should be closed. This method will return prior to the connection being closed.

Overridden to shutdown all of the underlying connections.

Specified by:

shutdown in interface Connection

Parameters:

force - If true then the connection can be immediately closed as the caller knows there are no outstanding requests to the server.

toString

public String toString()

Overridden to return the socket information.

Overrides:

toString in class Object

waitForClosed

public void waitForClosed(int timeout,
                 TimeUnit timeoutUnits)

Waits for the connection to become idle.

Overridden to wait for all of the underlying connections to close.

Specified by:

waitForClosed in interface Connection

Parameters:

timeout - The amount of time to wait for the connection to become idle.

timeoutUnits - The units for the amount of time to wait for the connection to become idle.

cacheConnection

protected Connection cacheConnection(K server,
                         Connection conn)

Caches the connection to the server if there is not already a connection in the cache. If there is a connection already in the cache then the one provided is closed and the cached connection it returned.

Parameters:

server - The server connected to.

conn - The connection to cache, if possible.

Returns:

The connection in the cache.

connect

protected abstract Connection connect(K server)

Attempts to create a connection to the server, catching any exceptions thrown. If a connection is created it should be cached.

Parameters:

server - The server to connect to.

Returns:

The connection to the server.

connection

protected Connection connection(K server)

Returns the cached connection for the specified key. This method may return null.

Parameters:

server - The server connected to.

Returns:

The connection in the cache.

createReconnectFailure

protected MongoDbException createReconnectFailure(Message message1,
                                      Message message2)

Creates a exception for a reconnect failure.

Parameters:

message1 - The first message to send.

message2 - The second message to send.

Returns:

The exception.

doSend

protected void doSend(Connection conn,
          Message message1,
          Message message2,
          ReplyCallback reply)

Sends the message on the connection.

Parameters:

conn - The connection to send on.

message1 - The first message to send.

message2 - The second message to send, may be null.

reply - The reply Callback.

findPotentialKeys

protected abstract List<K> findPotentialKeys(Message message1,
                        Message message2)
                                      throws MongoDbException

Locates the set of servers that can be used to send the specified messages. This method will attempt to connect to the primary server if there is not a current connection to the primary.

Parameters:

message1 - The first message to send.

message2 - The second message to send. May be null.

Returns:

The servers that can be used.

Throws:

MongoDbException - On a failure to locate a server that all messages can be sent to.

getConnectionType

protected abstract String getConnectionType()

Returns the type of connection (for logs, etc.).

Returns:

The connection type.

handleConnectionClosed

protected void handleConnectionClosed(Connection connection)

Tries to reconnect previously open Connections. If a connection was being closed then cleans up the remaining state.

Parameters:

connection - The connection that was closed.

reconnectMain

protected abstract ConnectionInfo<K> reconnectMain()

Creates a connection back to the main server for this connection.

Returns:

The information for the new connection.

removeCachedConnection

protected void removeCachedConnection(Object key,
                          Connection connection)

Remove the connection from the cache.

Parameters:

key - The key to remove the connection for.

connection - The connection to remove (if known).

trySend

protected boolean trySend(List<K> servers,
              Message message1,
              Message message2,
              ReplyCallback reply)

Tries to send the messages to the first server with either an open connection or that we can open a connection to.

Parameters:

servers - The servers the messages can be sent to.

message1 - The first message to send.

message2 - The second message to send. May be null.

reply - The callback for the replies.

Returns:

The true if the message was sent.

updateMain

protected void updateMain(ConnectionInfo<K> newConn)

Update the state with the new primary server.

Parameters:

newConn - The new primary server.