org.springframework.boot.autoconfigure.mongo

Class MongoProperties

java.lang.Object

org.springframework.boot.autoconfigure.mongo.MongoProperties

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

Configuration properties for Mongo.

Author:

Dave Syer, Phillip Webb, Josh Long, Andy Wilkinson, Eddú Meléndez

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MongoProperties()

Method Summary

Modifier and Type	Method and Description
void	clearPassword()
com.mongodb.MongoClient	createMongoClient(com.mongodb.MongoClientOptions options) Deprecated. Since 1.3.0 in favour of createMongoClient(MongoClientOptions, Environment)
com.mongodb.MongoClient	createMongoClient(com.mongodb.MongoClientOptions options, Environment environment) Creates a MongoClient using the given options and environment.
String	getAuthenticationDatabase()
String	getDatabase()
Class<? extends org.springframework.data.mapping.model.FieldNamingStrategy>	getFieldNamingStrategy()
String	getGridFsDatabase()
String	getHost()
String	getMongoClientDatabase()
char[]	getPassword()
Integer	getPort()
String	getUri()
String	getUsername()
void	setAuthenticationDatabase(String authenticationDatabase)
void	setDatabase(String database)
void	setFieldNamingStrategy(Class<? extends org.springframework.data.mapping.model.FieldNamingStrategy> fieldNamingStrategy)
void	setGridFsDatabase(String gridFsDatabase)
void	setHost(String host)
void	setPassword(char[] password)
void	setPort(Integer port)
void	setUri(String uri)
void	setUsername(String username)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

Default port used when the configured port is null.

See Also:

Constant Field Values

Constructor Detail

MongoProperties

public MongoProperties()

Method Detail

getHost

public String getHost()

setHost

public void setHost(String host)

getDatabase

public String getDatabase()

setDatabase

public void setDatabase(String database)

getAuthenticationDatabase

public String getAuthenticationDatabase()

setAuthenticationDatabase

public void setAuthenticationDatabase(String authenticationDatabase)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public char[] getPassword()

setPassword

public void setPassword(char[] password)

getFieldNamingStrategy

public Class<? extends org.springframework.data.mapping.model.FieldNamingStrategy> getFieldNamingStrategy()

setFieldNamingStrategy

public void setFieldNamingStrategy(Class<? extends org.springframework.data.mapping.model.FieldNamingStrategy> fieldNamingStrategy)

clearPassword

public void clearPassword()

getUri

public String getUri()

setUri

public void setUri(String uri)

getPort

public Integer getPort()

setPort

public void setPort(Integer port)

getGridFsDatabase

public String getGridFsDatabase()

setGridFsDatabase

public void setGridFsDatabase(String gridFsDatabase)

getMongoClientDatabase

public String getMongoClientDatabase()

createMongoClient

@Deprecated
public com.mongodb.MongoClient createMongoClient(com.mongodb.MongoClientOptions options)
                                                      throws UnknownHostException

Deprecated. Since 1.3.0 in favour of createMongoClient(MongoClientOptions, Environment)

Creates a MongoClient using the given options

Parameters:

options - the options

Returns:

the Mongo client

Throws:

UnknownHostException - if the configured host is unknown

createMongoClient

public com.mongodb.MongoClient createMongoClient(com.mongodb.MongoClientOptions options,
                                                 Environment environment)
                                          throws UnknownHostException

Creates a MongoClient using the given options and environment. If the configured port is zero, the value of the local.mongo.port property retrieved from the environment is used to configure the client.

Parameters:

options - the options

environment - the environment

Returns:

the Mongo client

Throws:

UnknownHostException - if the configured host is unknown