com.allanbank.mongodb.client.connection.sharded

Class ShardedConnectionFactory

java.lang.Object

com.allanbank.mongodb.client.connection.sharded.ShardedConnectionFactory

All Implemented Interfaces:

ConnectionFactory, Closeable, AutoCloseable

public class ShardedConnectionFactory
extends Object
implements ConnectionFactory

Provides the ability to create connections to a shard configuration 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-2014, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ShardedConnectionFactory.BootstrapState BootstrapState provides the ability to track the state of the bootstrap for the sharded cluster.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Log	LOG The logger for the ShardedConnectionFactory.
protected Cluster	myCluster The state of the cluster.
protected MongoClientConfiguration	myConfig The MongoDB client configuration.
protected ProxiedConnectionFactory	myConnectionFactory The factory to create proxied connections.
protected ClusterPinger	myPinger Pings the servers in the cluster collecting latency and tags.
protected ServerSelector	mySelector The selector for the mongos instance to use.

Constructor Summary

Constructors

Constructor and Description
ShardedConnectionFactory(ProxiedConnectionFactory factory, MongoClientConfiguration config) Creates a new ShardedConnectionFactory.

Method Summary

Methods

Modifier and Type	Method and Description
void	bootstrap() Finds the mongos servers.
void	close()
Connection	connect() Creates a new connection to the shared mongos servers.
protected ShardedConnectionFactory.BootstrapState	createBootstrapState() Creates a new ShardedConnectionFactory.BootstrapState.
protected Cluster	createCluster(MongoClientConfiguration config) Creates a Cluster object to track the state of the servers across the cluster.
protected ClusterPinger	createClusterPinger(ProxiedConnectionFactory factory, MongoClientConfiguration config) Creates a ClusterPinger object to periodically update the status of the servers.
protected ServerSelector	createSelector() Creates a ServerSelector object to select the (presumed) optimal server to handle a request.
protected boolean	findMongosServers(Connection conn) Performs a find on the config database's mongos collection to return the id for all of the mongos servers in the cluster.
protected Cluster	getCluster() Returns the clusterState value.
ClusterStats	getClusterStats() Returns the meta-data on the current cluster.
ClusterType	getClusterType() Returns the type of cluster the connection factory connects to.
ReconnectStrategy	getReconnectStrategy() Returns the reconnection strategy for the type of connections.
protected void	update(ShardedConnectionFactory.BootstrapState state, Connection conn) Queries for the addresses for the mongos servers via the findMongosServers(Connection) method.
protected Connection	wrap(Connection primaryConn, Server server) Wraps the connection in a shard-aware connection.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Log LOG

The logger for the ShardedConnectionFactory.

myCluster

protected final Cluster myCluster

The state of the cluster.

myConfig

protected final MongoClientConfiguration myConfig

The MongoDB client configuration.

myConnectionFactory

protected final ProxiedConnectionFactory myConnectionFactory

The factory to create proxied connections.

myPinger

protected final ClusterPinger myPinger

Pings the servers in the cluster collecting latency and tags.

mySelector

protected final ServerSelector mySelector

The selector for the mongos instance to use.

Constructor Detail

ShardedConnectionFactory

public ShardedConnectionFactory(ProxiedConnectionFactory factory,
                        MongoClientConfiguration config)

Creates a new ShardedConnectionFactory.

Parameters:

factory - The factory to create proxied connections.

config - The initial configuration.

Method Detail

bootstrap

public void bootstrap()

Finds the mongos servers.

close

public void close()

Overridden to close the cluster state and the ProxiedConnectionFactory.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

connect

public Connection connect()
                   throws IOException

Creates a new connection to the shared mongos servers.

Specified by:

connect in interface ConnectionFactory

Returns:

The Connection to MongoDB.

Throws:

IOException - On a failure connecting to the server.

See Also:

ConnectionFactory.connect()

getClusterStats

public ClusterStats getClusterStats()

Returns the meta-data on the current cluster.

Overridden to return the Cluster.

Specified by:

getClusterStats in interface ConnectionFactory

Returns:

The meta-data on the current cluster.

getClusterType

public ClusterType getClusterType()

Returns the type of cluster the connection factory connects to.

Overridden to return ClusterType.SHARDED cluster type.

Specified by:

getClusterType in interface ConnectionFactory

Returns:

The type of cluster the connection factory connects to.

getReconnectStrategy

public ReconnectStrategy getReconnectStrategy()

Returns the reconnection strategy for the type of connections.

Overridden to return the delegates strategy but replace his state and selector with our own.

Specified by:

getReconnectStrategy in interface ConnectionFactory

Returns:

The reconnection strategy for the type of connections.

createBootstrapState

protected ShardedConnectionFactory.BootstrapState createBootstrapState()

Creates a new ShardedConnectionFactory.BootstrapState.

Returns:

The ShardedConnectionFactory.BootstrapState to track state of loading the cluster information.

createCluster

protected Cluster createCluster(MongoClientConfiguration config)

Creates a Cluster object to track the state of the servers across the cluster.

Parameters:

config - The configuration for the cluster.

Returns:

The Cluster to track the servers across the cluster.

createClusterPinger

protected ClusterPinger createClusterPinger(ProxiedConnectionFactory factory,
                                MongoClientConfiguration config)

Creates a ClusterPinger object to periodically update the status of the servers.

Parameters:

factory - The factory for creating the connections to the servers.

config - The configuration for the client.

Returns:

The ClusterPinger object to periodically update the status of the servers.

createSelector

protected ServerSelector createSelector()

Creates a ServerSelector object to select the (presumed) optimal server to handle a request.

For a sharded cluster this defaults to the LatencyServerSelector.

Returns:

The ServerSelector object to select the (presumed) optimal server to handle a request.

findMongosServers

protected boolean findMongosServers(Connection conn)
                             throws InterruptedException,
                                    ExecutionException

Performs a find on the config database's mongos collection to return the id for all of the mongos servers in the cluster.

A single mongos entry looks like:

 
 {
     "_id" : "mongos.example.com:27017",
     "ping" : ISODate("2011-12-05T23:54:03.122Z"),
     "up" : 330
 }
 
 

Parameters:

conn - The connection to request from.

Returns:

True if the configuration servers have been determined.

Throws:

ExecutionException - On a failure to recover the response from the server.

InterruptedException - On a failure to receive a response from the server.

getCluster

protected Cluster getCluster()

Returns the clusterState value.

Returns:

The clusterState value.

update

protected void update(ShardedConnectionFactory.BootstrapState state,
          Connection conn)
               throws InterruptedException,
                      ExecutionException

Queries for the addresses for the mongos servers via the findMongosServers(Connection) method.

Parameters:

state - The state of the bootstrap to be updated.

conn - The connection to use to locate the mongos servers

Throws:

InterruptedException - On a failure to wait for the reply to the query due to the thread being interrupted.

ExecutionException - On a failure to execute the query.

wrap

protected Connection wrap(Connection primaryConn,
              Server server)

Wraps the connection in a shard-aware connection.

Parameters:

primaryConn - The primary shard connection.

server - The server the connection is connected to.

Returns:

The wrapped connection.