com.mongodb

Class MongoAuthority

java.lang.Object

com.mongodb.MongoAuthority

@Immutable
class MongoAuthority
extends java.lang.Object

This class represents the authority to which this client is connecting. It includes both the server address(es) and optional authentication credentials. The class name is informed by the URI RFC, which refers to the username/host/port part of a URI as the "authority".

Since:

2.11.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	MongoAuthority.Type Enumeration of the connection types.

Field Summary

Fields

Modifier and Type	Field and Description
private MongoCredentialsStore	credentialsStore
private java.util.List<ServerAddress>	serverAddresses
private MongoAuthority.Type	type

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MongoAuthority(java.util.List<ServerAddress> serverAddresses, MongoAuthority.Type type, MongoCredentialsStore credentialsStore) Constructs an instance with a list of server addresses, which may either be a list of mongos servers or a list of members of a replica set, and a store of authentication credentials.
private	MongoAuthority(ServerAddress serverAddress, MongoCredentialsStore credentialsStore) Constructs an instance with a single server address and a store of authentication credentials.

Method Summary

Modifier and Type	Method and Description
static MongoAuthority	direct(ServerAddress serverAddress)
static MongoAuthority	direct(ServerAddress serverAddress, MongoCredential credentials)
static MongoAuthority	direct(ServerAddress serverAddress, MongoCredentialsStore credentialsStore)
static MongoAuthority	dynamicSet(java.util.List<ServerAddress> serverAddresses)
static MongoAuthority	dynamicSet(java.util.List<ServerAddress> serverAddresses, MongoCredential credentials)
static MongoAuthority	dynamicSet(java.util.List<ServerAddress> serverAddresses, MongoCredentialsStore credentialsStore)
boolean	equals(java.lang.Object o)
MongoCredentialsStore	getCredentialsStore() Gets the credentials store.
java.util.List<ServerAddress>	getServerAddresses() Returns the list of server addresses.
MongoAuthority.Type	getType() Gets the authority type
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

type

private final MongoAuthority.Type type

serverAddresses

private final java.util.List<ServerAddress> serverAddresses

credentialsStore

private final MongoCredentialsStore credentialsStore

Constructor Detail

MongoAuthority

private MongoAuthority(ServerAddress serverAddress,
                       MongoCredentialsStore credentialsStore)

Constructs an instance with a single server address and a store of authentication credentials. This will be a direct connection, even if it's part of a replica set.

Parameters:

serverAddress - the server address of a mongo server

MongoAuthority

private MongoAuthority(java.util.List<ServerAddress> serverAddresses,
                       MongoAuthority.Type type,
                       MongoCredentialsStore credentialsStore)

Constructs an instance with a list of server addresses, which may either be a list of mongos servers or a list of members of a replica set, and a store of authentication credentials.

Parameters:

serverAddresses - the server addresses

credentialsStore - the credentials store

Method Detail

direct

public static MongoAuthority direct(ServerAddress serverAddress)

Parameters:

serverAddress -

Returns:

direct

public static MongoAuthority direct(ServerAddress serverAddress,
                                    MongoCredential credentials)

Parameters:

serverAddress -

credentials -

Returns:

direct

public static MongoAuthority direct(ServerAddress serverAddress,
                                    MongoCredentialsStore credentialsStore)

Parameters:

serverAddress -

credentialsStore -

Returns:

dynamicSet

public static MongoAuthority dynamicSet(java.util.List<ServerAddress> serverAddresses)

Parameters:

serverAddresses -

Returns:

dynamicSet

public static MongoAuthority dynamicSet(java.util.List<ServerAddress> serverAddresses,
                                        MongoCredential credentials)

Parameters:

serverAddresses -

credentials -

Returns:

dynamicSet

public static MongoAuthority dynamicSet(java.util.List<ServerAddress> serverAddresses,
                                        MongoCredentialsStore credentialsStore)

Parameters:

serverAddresses -

credentialsStore -

Returns:

getServerAddresses

public java.util.List<ServerAddress> getServerAddresses()

Returns the list of server addresses.

Returns:

the server address list

getCredentialsStore

public MongoCredentialsStore getCredentialsStore()

Gets the credentials store. If this instance was constructed with a single credential, this store will contain it.

Returns:

the credentials store

getType

public MongoAuthority.Type getType()

Gets the authority type

Returns:

the authority type

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object