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. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. 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

  7. 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

  8. 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

  9. 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

  10. 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

  11. 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

  12. 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

  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Deprecated Value Members

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

    Creates a MongoCredential instance for the MongoDB Challenge Response protocol.

    Creates a MongoCredential instance for the MongoDB Challenge Response protocol. 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 user name

    database

    the database where the user is defined

    password

    the user's password

    returns

    the credential

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) MONGODB-CR was replaced by SCRAM-SHA-1 in MongoDB 3.0, and is now deprecated.

    See also

    createCredential

    MONGODB-CR

Inherited from AnyRef

Inherited from Any

Ungrouped