RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://mongodb.github.io/mongo-java-driver/3.12/javadoc/com/mongodb/MongoCredential.html below:

MongoCredential

- Field Detail
  - MONGODB_CR_MECHANISM
```
@Deprecated
public static final String MONGODB_CR_MECHANISM
```
    The MongoDB Challenge Response mechanism.
    
    MongoDB documentation
    
    MONGODB-CR
  - GSSAPI_MECHANISM
```
public static final String GSSAPI_MECHANISM
```
    The GSSAPI mechanism. See the
    RFC
    .
    
    MongoDB documentation
    
    GSSAPI
    
    Since server release
    
    2.4
  - PLAIN_MECHANISM
```
public static final String PLAIN_MECHANISM
```
    The PLAIN mechanism. See the
    RFC
    .
    
    Since:
    
    2.12
    
    MongoDB documentation
    
    PLAIN
    
    Since server release
    
    2.6
  - MONGODB_X509_MECHANISM
```
public static final String MONGODB_X509_MECHANISM
```
    The MongoDB X.509
    
    Since:
    
    2.12
    
    MongoDB documentation
    
    X-509
    
    Since server release
    
    2.6
  - SCRAM_SHA_1_MECHANISM
```
public static final String SCRAM_SHA_1_MECHANISM
```
    The SCRAM-SHA-1 Mechanism.
    
    Since:
    
    2.13
    
    MongoDB documentation
    
    SCRAM-SHA-1
    
    Since server release
    
    3.0
  - SCRAM_SHA_256_MECHANISM
```
public static final String SCRAM_SHA_256_MECHANISM
```
    The SCRAM-SHA-256 Mechanism.
    
    Since:
    
    3.8
    
    MongoDB documentation
    
    SCRAM-SHA-256
    
    Since server release
    
    4.0
  - SERVICE_NAME_KEY
```
public static final String SERVICE_NAME_KEY
```
    Mechanism property key for overriding the service name for GSSAPI authentication.
    
    Since:
    
    3.3
    
    See Also:
    
    createGSSAPICredential(String), withMechanismProperty(String, Object), Constant Field Values
  - CANONICALIZE_HOST_NAME_KEY
```
public static final String CANONICALIZE_HOST_NAME_KEY
```
    Mechanism property key for specifying whether to canonicalize the host name for GSSAPI authentication.
    
    Since:
    
    3.3
    
    See Also:
    
    createGSSAPICredential(String), withMechanismProperty(String, Object), Constant Field Values
  - JAVA_SASL_CLIENT_PROPERTIES_KEY
```
public static final String JAVA_SASL_CLIENT_PROPERTIES_KEY
```
    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 Sasl.CREDENTIALS property to an instance of GSSCredential.
    - It's recommended that it set the Sasl.MAX_BUFFER property to "0" to ensure compatibility with all versions of MongoDB.
    Since:
    
    3.3
    
    See Also:
    
    createGSSAPICredential(String), withMechanismProperty(String, Object), Sasl, Sasl.CREDENTIALS, Sasl.MAX_BUFFER, Constant Field Values
  - JAVA_SUBJECT_KEY
```
public static final String JAVA_SUBJECT_KEY
```
    Mechanism property key for overriding the
    Subject
    under which GSSAPI authentication executes.
    
    Since:
    
    3.3
    
    See Also:
    
    createGSSAPICredential(String), withMechanismProperty(String, Object), Constant Field Values
- Method Detail
  - createCredential
```
public static MongoCredential createCredential(String userName,
                                               String database,
                                               char[] password)
```
    If the server version is 4.0 or higher, the driver will negotiate with the server preferring the SCRAM-SHA-256 mechanism. 3.x servers will authenticate using SCRAM-SHA-1, older servers will authenticate using the MONGODB_CR mechanism.
    
    Parameters:
    
    userName - the user name
    
    database - the database where the user is defined
    
    password - the user's password
    
    Returns:
    
    the credential
    
    Since:
    
    2.13
    
    MongoDB documentation
    
    SCRAM-SHA-256
    
    SCRAM-SHA-1
    
    MONGODB-CR
  - createScramSha1Credential
```
public static MongoCredential createScramSha1Credential(String userName,
                                                        String source,
                                                        char[] password)
```
    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 SCRAM-SHA-1 mechanism regardless of whether the server you are connecting to supports the authentication mechanism. Otherwise use the
    createCredential(String, String, char[])
    method to allow the driver to negotiate the best mechanism based on the server version.
    
    Parameters:
    
    userName - the non-null user name
    
    source - the source where the user is defined.
    
    password - the non-null user password
    
    Returns:
    
    the credential
    
    Since:
    
    2.13
    
    See Also:
    
    createCredential(String, String, char[])
    
    MongoDB documentation
    
    SCRAM-SHA-1
    
    Since server release
    
    3.0
  - createScramSha256Credential
```
public static MongoCredential createScramSha256Credential(String userName,
                                                          String source,
                                                          char[] password)
```
    Creates a MongoCredential instance for the SCRAM-SHA-256 SASL mechanism.
    
    Parameters:
    
    userName - the non-null user name
    
    source - the source where the user is defined.
    
    password - the non-null user password
    
    Returns:
    
    the credential
    
    Since:
    
    3.8
    
    See Also:
    
    createCredential(String, String, char[])
    
    MongoDB documentation
    
    SCRAM-SHA-256
    
    Since server release
    
    4.0
  - createMongoCRCredential
```
@Deprecated
public static MongoCredential createMongoCRCredential(String userName,
                                                      String database,
                                                      char[] password)
```
    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(String, String, char[])
    method to allow the driver to negotiate the best mechanism based on the server version.
    
    Parameters:
    
    userName - the user name
    
    database - the database where the user is defined
    
    password - the user's password
    
    Returns:
    
    the credential
    
    See Also:
    
    createCredential(String, String, char[])
    
    MongoDB documentation
    
    MONGODB-CR
  - createMongoX509Credential
```
public static MongoCredential createMongoX509Credential(String userName)
```
    Creates a MongoCredential instance for the MongoDB X.509 protocol.
    
    Parameters:
    
    userName - the user name
    
    Returns:
    
    the credential
    
    Since:
    
    2.12
    
    MongoDB documentation
    
    X-509
    
    Since server release
    
    2.6
  - createMongoX509Credential
```
public static MongoCredential createMongoX509Credential()
```
    Available on MongoDB server versions >= 3.4.
    
    Returns:
    
    the credential
    
    Since:
    
    3.4
    
    MongoDB documentation
    
    X-509
    
    Since server release
    
    3.4
  - createPlainCredential
```
public static MongoCredential createPlainCredential(String userName,
                                                    String source,
                                                    char[] password)
```
    Creates a MongoCredential instance for the PLAIN SASL mechanism.
    
    Parameters:
    
    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
    
    Since:
    
    2.12
    
    MongoDB documentation
    
    PLAIN
    
    Since server release
    
    2.6
  - createGSSAPICredential
```
public static MongoCredential createGSSAPICredential(String userName)
```
    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 valuetrue.
    
    To override the Subject with which the authentication executes, add a mechanism property with the name "JAVA_SUBJECT" with the value of a Subject instance.
    
    To override the properties of the SaslClient with which the authentication executes, add a mechanism property with the name "JAVA_SASL_CLIENT_PROPERTIES" with the value of a Map<String, Object instance containing the necessary properties. This can be useful if the application is customizing the default SaslClientFactory.
    
    Parameters:
    
    userName - the non-null user name
    
    Returns:
    
    the credential
    
    See Also:
    
    withMechanismProperty(String, Object), SERVICE_NAME_KEY, CANONICALIZE_HOST_NAME_KEY, JAVA_SUBJECT_KEY, JAVA_SASL_CLIENT_PROPERTIES_KEY
    
    MongoDB documentation
    
    GSSAPI
    
    Since server release
    
    2.4
  - withMechanismProperty
```
public <T> MongoCredential withMechanismProperty(String key,
                                                 T value)
```
    Creates a new MongoCredential as a copy of this instance, with the specified mechanism property added.
    
    Type Parameters:
    
    T - the property type
    
    Parameters:
    
    key - the key to the property, which is treated as case-insensitive
    
    value - the value of the property
    
    Returns:
    
    the credential
    
    Since:
    
    2.12
  - withMechanism
```
public MongoCredential withMechanism(AuthenticationMechanism mechanism)
```
    Creates a new MongoCredential with the set mechanism. The existing mechanism must be null.
    
    Parameters:
    
    mechanism - the mechanism to set
    
    Returns:
    
    the credential
    
    Since:
    
    3.8
  - getMechanism
```
@Nullable
public String getMechanism()
```
    Gets the mechanism
    
    Returns:
    
    the mechanism.
  - getAuthenticationMechanism
```
@Nullable
public AuthenticationMechanism getAuthenticationMechanism()
```
    Gets the mechanism
    
    Returns:
    
    the mechanism.
    
    Since:
    
    3.0
  - getUserName
```
@Nullable
public String getUserName()
```
    Gets the user name
    
    Returns:
    
    the user name.
  - getSource
```
public String getSource()
```
    Gets the source of the user name, typically the name of the database where the user is defined.
    
    Returns:
    
    the user name. Can never be null.
  - getPassword
```
@Nullable
public char[] getPassword()
```
    Gets the password.
    
    Returns:
    
    the password. Can be null for some mechanisms.
  - getMechanismProperty
```
@Nullable
public <T> T getMechanismProperty(String key,
                                  @Nullable
                                  T defaultValue)
```
    Get the value of the given key to a mechanism property, or defaultValue if there is no mapping.
    
    Type Parameters:
    
    T - the value type
    
    Parameters:
    
    key - the mechanism property key, which is treated as case-insensitive
    
    defaultValue - the default value, if no mapping exists
    
    Returns:
    
    the mechanism property value
    
    Since:
    
    2.12
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4