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
- Alphabetic
- By Inheritance
- MongoCredential
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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)
- val GSSAPI_MECHANISM: String
The GSSAPI mechanism.
- 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#CREDENTIALSproperty to an instance oforg.ietf.jgss.GSSCredential - It's recommended that it set the
javax.security.sasl.Sasl#MAX_BUFFERproperty 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
- Generally it must set the
- val JAVA_SUBJECT_KEY: String
Mechanism property key for overriding the
javax.security.auth.Subjectunder which GSSAPI authentication executes.Mechanism property key for overriding the
javax.security.auth.Subjectunder which GSSAPI authentication executes.- Since
4.0
- See also
#createGSSAPICredential(String)
#withMechanismProperty(String, Object)
- val MONGODB_X509_MECHANISM: String
The MongoDB X.509
The MongoDB X.509
- Since
4.0
- See also
- val PLAIN_MECHANISM: String
The PLAIN mechanism.
- 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
- 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
- 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)
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- 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
- 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 nameSERVICE_NAME. To force canonicalization of the host name prior to authentication, add a mechanism property with the nameCANONICALIZE_HOST_NAMEwith the valuetrue.- userName
the non-null user name
- returns
the credential
- See also
- 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
- 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
- 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
$externalor the name of a database.- password
the non-null user password
- returns
the credential
- See also
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
This is the documentation for the MongoDB Scala driver.
Driver structure
The mongodb scala driver.
To get started you need a MongoClient instance, either from a connection string or via a org.mongodb.scala.MongoClientSettings.
Notable packages include: