com.allanbank.mongodb.client.connection.sharded

Class ShardedConnection

java.lang.Object

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

com.allanbank.mongodb.client.connection.sharded.ShardedConnection

All Implemented Interfaces:

Connection, Closeable, Flushable, AutoCloseable

public class ShardedConnection
extends AbstractProxyMultipleConnection<Server>

Provides a Connection implementation for connecting to a sharded environment via mongos servers.

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 ©:

2011-2013, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested classes/interfaces inherited from class com.allanbank.mongodb.client.connection.proxy.AbstractProxyMultipleConnection

AbstractProxyMultipleConnection.ClusterAndConnectionListener

Field Summary

Fields inherited from class com.allanbank.mongodb.client.connection.proxy.AbstractProxyMultipleConnection

myCluster, myConfig, myEventSupport, myFactory, myLastUsedConnection, myListener, myMainKey, myOpen, myShutdown

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

COMMAND_COLLECTION, OPEN_PROP_NAME

Constructor Summary

Constructors

Constructor and Description
ShardedConnection(Connection proxiedConnection, Server server, Cluster cluster, ServerSelector selector, ProxiedConnectionFactory factory, MongoClientConfiguration config) Creates a new ShardedConnection.

Method Summary

Methods

Modifier and Type	Method and Description
protected Connection	connect(Server server) Attempts to create a connection to the server, catching any exceptions thrown.
protected Connection	connection(Server server) Returns the cached connection for the specified key.
protected List<Server>	findPotentialKeys(Message message1, Message message2) Locates the set of servers that can be used to send the specified messages.
protected String	getConnectionType() Returns the type of connection (for logs, etc.).
String	getServerName() Returns the name of a server the connection is currently connected to.
protected ConnectionInfo<Server>	reconnectMain() Creates a connection back to the main server for this connection.

Methods inherited from class com.allanbank.mongodb.client.connection.proxy.AbstractProxyMultipleConnection

addPropertyChangeListener, cacheConnection, close, createReconnectFailure, doSend, flush, getPendingCount, handleConnectionClosed, isAvailable, isIdle, isOpen, isShuttingDown, raiseErrors, removeCachedConnection, removePropertyChangeListener, send, send, shutdown, toString, trySend, updateMain, waitForClosed

Methods inherited from class java.lang.Object

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

Constructor Detail

ShardedConnection

public ShardedConnection(Connection proxiedConnection,
                 Server server,
                 Cluster cluster,
                 ServerSelector selector,
                 ProxiedConnectionFactory factory,
                 MongoClientConfiguration config)

Creates a new ShardedConnection.

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.

selector - The selector for servers when we need to reconnect.

factory - The connection factory for opening secondary connections.

config - The MongoDB client configuration.

Method Detail

getServerName

public String getServerName()

Returns the name of a server the connection is currently connected to.

Overridden to return the canonical name of the primary.

Returns:

The name of a server the connection is currently connected to.

connect

protected Connection connect(Server server)

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

Overridden to create a connection to the server.

Specified by:

connect in class AbstractProxyMultipleConnection<Server>

Parameters:

server - The server to connect to.

Returns:

The connection to the server.

connection

protected Connection connection(Server server)

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

Overridden for testing access.

Overrides:

connection in class AbstractProxyMultipleConnection<Server>

Parameters:

server - The server connected to.

Returns:

The connection in the cache.

findPotentialKeys

protected List<Server> 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.

Specified by:

findPotentialKeys in class AbstractProxyMultipleConnection<Server>

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 String getConnectionType()

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

Overridden to return the string Sharded.

Specified by:

getConnectionType in class AbstractProxyMultipleConnection<Server>

Returns:

The connection type.

reconnectMain

protected ConnectionInfo<Server> reconnectMain()

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

Overridden creates a connection back to the primary server.

Specified by:

reconnectMain in class AbstractProxyMultipleConnection<Server>

Returns:

The information for the new connection.