Enum Class MongoDBDocumentConfigurations
java.lang.Object
java.lang.Enum<MongoDBDocumentConfigurations>
org.eclipse.jnosql.databases.mongodb.communication.MongoDBDocumentConfigurations
- All Implemented Interfaces:
Serializable,Comparable<MongoDBDocumentConfigurations>,Constable,Supplier<String>
public enum MongoDBDocumentConfigurations
extends Enum<MongoDBDocumentConfigurations>
implements Supplier<String>
An enumeration to show the available options to connect to the Mongodb database.
It implements
Supplier, where its it returns the property name that might be
overwritten by the system environment using Eclipse Microprofile or Jakarta Config API.- See Also:
-
Settings
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionDefines the logical name of the application connecting to MongoDB.Authentication mechanismsAuthenticationMechanismThe source where the user is defined.The database host as prefix.The password's credentialMongoDB's connection stringThe user's credential. -
Method Summary
Modifier and TypeMethodDescriptionget()Returns the enum constant of this class with the specified name.static MongoDBDocumentConfigurations[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
HOST
The database host as prefix. E.g.: jnosql.mongodb.host.1=localhost:27017 -
USER
The user's credential. -
PASSWORD
The password's credential -
URL
MongoDB's connection string -
AUTHENTICATION_SOURCE
The source where the user is defined. -
AUTHENTICATION_MECHANISM
Authentication mechanismsAuthenticationMechanism -
APPLICATION_NAME
Defines the logical name of the application connecting to MongoDB.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
get
-