Packages

o

org.mongodb.scala

MongoCredential

object MongoCredential

Represents credentials to authenticate to a MongoDB server, as well as the source of the credentials and the authentication mechanism to use.

Since

1.0

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MongoCredential
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. val CANONICALIZE_HOST_NAME_KEY: String

    Mechanism property key for specifying whether to canonicalize the host name for GSSAPI authentication.

    Mechanism property key for specifying whether to canonicalize the host name for GSSAPI authentication.

    Since

    4.0

    See also

    #createGSSAPICredential(String)

    #withMechanismProperty(String, Object)

  2. val GSSAPI_MECHANISM: String

    The GSSAPI mechanism.

    The GSSAPI mechanism. See the RFC.

    Since

    4.0

    See also

    GSSAPI

  3. val JAVA_SASL_CLIENT_PROPERTIES_KEY: String

    Mechanism property key for overriding the SaslClient properties for GSSAPI authentication.

    Mechanism property key for overriding the SaslClient properties for GSSAPI authentication.

    The value of this property must be a Map[String, Object]. In most cases there is no need to set this mechanism property. But if an application does:

    • Generally it must set the javax.security.sasl.Sasl#CREDENTIALS property to an instance of org.ietf.jgss.GSSCredential
    • It's recommended that it set the javax.security.sasl.Sasl#MAX_BUFFER property to "0" to ensure compatibility with all versions of MongoDB.
    Since

    4.0

    See also

    #createGSSAPICredential(String)

    #withMechanismProperty(String, Object)

    javax.security.sasl.Sasl

    javax.security.sasl.Sasl#CREDENTIALS

    javax.security.sasl.Sasl#MAX_BUFFER

  4. val JAVA_SUBJECT_KEY: String

    Mechanism property key for overriding the javax.security.auth.Subject under which GSSAPI authentication executes.

    Mechanism property key for overriding the javax.security.auth.Subject under which GSSAPI authentication executes.

    Since

    4.0

    See also

    #createGSSAPICredential(String)

    #withMechanismProperty(String, Object)

  5. val MONGODB_X509_MECHANISM: String

    The MongoDB X.509

    The MongoDB X.509

    Since

    4.0

    See also

    X-509

  6. val PLAIN_MECHANISM: String

    The PLAIN mechanism.

    The PLAIN mechanism. See the RFC.

    Since

    4.0

    See also

    PLAIN

  7. val SCRAM_SHA_1_MECHANISM: String

    The SCRAM-SHA-1 Mechanism.

    The SCRAM-SHA-1 Mechanism.

    Since

    4.0

    Note

    Requires MongoDB 3.0 or greater

    See also

    SCRAM-SHA-1

  8. val SCRAM_SHA_256_MECHANISM: String

    The SCRAM-SHA-256 Mechanism.

    The SCRAM-SHA-256 Mechanism.

    Since

    3.8

    Note

    Requires MongoDB 4.0 or greater

    See also

    SCRAM-SHA-256

  9. val SERVICE_NAME_KEY: String

    Mechanism property key for overriding the service name for GSSAPI authentication.

    Mechanism property key for overriding the service name for GSSAPI authentication.

    Since

    4.0

    See also

    #createGSSAPICredential(String)

    #withMechanismProperty(String, Object)

  10. def createCredential(userName: String, database: String, password: Array[Char]): com.mongodb.MongoCredential

    Creates a MongoCredential instance with an unspecified mechanism.

    Creates a MongoCredential instance with an unspecified mechanism. The client will negotiate the best mechanism based on the version of the server that the client is authenticating to. If the server version is 3.0 or higher, the driver will authenticate using the SCRAM-SHA-1 mechanism. Otherwise, the driver will authenticate using the MONGODB_CR mechanism.

    userName

    the user name

    database

    the database where the user is defined

    password

    the user's password

    returns

    the credential

    See also

    MONGODB-CR

    SCRAM-SHA-1

  11. def createGSSAPICredential(userName: String): com.mongodb.MongoCredential

    Creates a MongoCredential instance for the GSSAPI SASL mechanism.

    Creates a MongoCredential instance for the GSSAPI SASL mechanism. To override the default service name of mongodb, add a mechanism property with the name SERVICE_NAME. To force canonicalization of the host name prior to authentication, add a mechanism property with the name CANONICALIZE_HOST_NAME with the value true.

    userName

    the non-null user name

    returns

    the credential

    See also

    GSSAPI

  12. def createMongoX509Credential(): com.mongodb.MongoCredential

    Creates a MongoCredential instance for the MongoDB X.509 protocol where the distinguished subject name of the client certificate acts as the userName.

    Creates a MongoCredential instance for the MongoDB X.509 protocol where the distinguished subject name of the client certificate acts as the userName.

    returns

    the credential

    Since

    1.2

    Note

    Requires MongoDB 3.4 or greater

    See also

    X-509

  13. def createMongoX509Credential(userName: String): com.mongodb.MongoCredential

    Creates a MongoCredential instance for the MongoDB X.509 protocol.

    Creates a MongoCredential instance for the MongoDB X.509 protocol.

    userName

    the user name

    returns

    the credential

    See also

    X-509

  14. def createPlainCredential(userName: String, source: String, password: Array[Char]): com.mongodb.MongoCredential

    Creates a MongoCredential instance for the PLAIN SASL mechanism.

    Creates a MongoCredential instance for the PLAIN SASL mechanism.

    userName

    the non-null user name

    source

    the source where the user is defined. This can be either $external or the name of a database.

    password

    the non-null user password

    returns

    the credential

    See also

    PLAIN

  15. def createScramSha1Credential(userName: String, source: String, password: Array[Char]): com.mongodb.MongoCredential

    Creates a MongoCredential instance for the SCRAM-SHA-1 SASL mechanism.

    Creates a MongoCredential instance for the SCRAM-SHA-1 SASL mechanism. Use this method only if you want to ensure that the driver uses the MONGODB_CR mechanism regardless of whether the server you are connecting to supports a more secure authentication mechanism. Otherwise use the createCredential method to allow the driver to negotiate the best mechanism based on the server version.

    userName

    the non-null user name

    source

    the source where the user is defined.

    password

    the non-null user password

    returns

    the credential

    See also

    createCredential

    SCRAM-SHA-1

  16. def createScramSha256Credential(userName: String, source: String, password: Array[Char]): com.mongodb.MongoCredential

    Creates a MongoCredential instance for the SCRAM-SHA-256 SASL mechanism.

    Creates a MongoCredential instance for the SCRAM-SHA-256 SASL mechanism.

    userName

    the non-null user name

    source

    the source where the user is defined.

    password

    the non-null user password

    returns

    the credential

    Note

    Requires MongoDB 4.0 or greater

    See also

    SCRAM-SHA-256