Class MongoProperties

java.lang.Object

org.springframework.boot.mongodb.autoconfigure.MongoProperties

@ConfigurationProperties("spring.mongodb")
public class MongoProperties
extends Object

Configuration properties for Mongo.

Since:

4.0.0

Author:

Dave Syer, Phillip Webb, Josh Long, Andy Wilkinson, Eddú Meléndez, Stephane Nicoll, Nasko Vasilev, Mark Paluch, Artsiom Yudovin, Safeer Ansari

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MongoProperties.Representation
static class	MongoProperties.Ssl

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_PORT	Default port used when the configured port is null.
static final String	DEFAULT_URI	Default URI used when the configured URI is null.

Constructor Summary

Constructors

Constructor	Description
MongoProperties()

Method Summary

Modifier and Type	Method	Description
String	determineUri()
@Nullable List<String>	getAdditionalHosts()
@Nullable String	getAuthenticationDatabase()
@Nullable String	getDatabase()
@Nullable String	getHost()
@Nullable String	getMongoClientDatabase()
char @Nullable []	getPassword()
@Nullable Integer	getPort()
String	getProtocol()
@Nullable String	getReplicaSetName()
MongoProperties.Representation	getRepresentation()
MongoProperties.Ssl	getSsl()
@Nullable String	getUri()
@Nullable String	getUsername()
void	setAdditionalHosts(@Nullable List<String> additionalHosts)
void	setAuthenticationDatabase(@Nullable String authenticationDatabase)
void	setDatabase(@Nullable String database)
void	setHost(@Nullable String host)
void	setPassword(char @Nullable [] password)
void	setPort(@Nullable Integer port)
void	setProtocol(String protocol)
void	setReplicaSetName(@Nullable String replicaSetName)
void	setUri(@Nullable String uri)
void	setUsername(@Nullable String username)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_PORT

public static final int DEFAULT_PORT

Default port used when the configured port is null.

See Also:

• Constant Field Values

DEFAULT_URI

public static final String DEFAULT_URI

Default URI used when the configured URI is null.

See Also:

• Constant Field Values

Constructor Details

MongoProperties

public MongoProperties()

Method Details

setProtocol

public void setProtocol(String protocol)

getProtocol

public String getProtocol()

getHost

public @Nullable String getHost()

setHost

public void setHost(@Nullable String host)

getDatabase

public @Nullable String getDatabase()

setDatabase

public void setDatabase(@Nullable String database)

getAuthenticationDatabase

public @Nullable String getAuthenticationDatabase()

setAuthenticationDatabase

public void setAuthenticationDatabase(@Nullable String authenticationDatabase)

getUsername

public @Nullable String getUsername()

setUsername

public void setUsername(@Nullable String username)

getPassword

public char @Nullable [] getPassword()

setPassword

public void setPassword(char @Nullable [] password)

getReplicaSetName

public @Nullable String getReplicaSetName()

setReplicaSetName

public void setReplicaSetName(@Nullable String replicaSetName)

getUri

public @Nullable String getUri()

determineUri

public String determineUri()

setUri

public void setUri(@Nullable String uri)

getPort

public @Nullable Integer getPort()

setPort

public void setPort(@Nullable Integer port)

getMongoClientDatabase

public @Nullable String getMongoClientDatabase()

getAdditionalHosts

public @Nullable List<String> getAdditionalHosts()

setAdditionalHosts

public void setAdditionalHosts(@Nullable List<String> additionalHosts)

getRepresentation

public MongoProperties.Representation getRepresentation()

getSsl

public MongoProperties.Ssl getSsl()