org.mule.modules.mongo

Class Config

java.lang.Object

org.mule.modules.mongo.Config

All Implemented Interfaces:

AbstractConfig

@ConnectionManagement(friendlyName="Configuration",
                      configElementName="config")
public class Config
extends Object
implements AbstractConfig

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMA_SEPARATED_REGEX
Integer	connectionsPerHost The number of connections allowed per host (the pool size, per host)
Integer	maxWaitTime The max wait time for a blocking thread for a connection from the pool in ms.
Integer	threadsAllowedToBlockForConnectionMultiplier Multiplier for connectionsPerHost for # of threads that can block.

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Modifier and Type	Method and Description
void	connect(String username, String password, String database) Method invoked when a Mongo session needs to be created.
String	connectionId()
void	disconnect() Method invoked when the Mongo session is to be destroyed.
protected static List<com.mongodb.ServerAddress>	getAddresses(String commaSeparatedHosts)
String	getAuthenticationDatabase()
MongoClient	getClient()
Integer	getConnectionsPerHost()
Integer	getConnectTimeout()
String	getDatabase()
String	getHost()
Integer	getMaxWaitTime()
Integer	getSocketTimeout()
boolean	getSsl()
Integer	getThreadsAllowedToBlockForConnectionMultiplier()
boolean	isConnected()
boolean	isIterableBehaviour()
boolean	isRetryWrites()
void	setAuthenticationDatabase(String authenticationDatabase)
void	setConnectionsPerHost(Integer connectionsPerHost)
void	setConnectTimeout(Integer connectTimeout)
void	setDatabase(String database)
void	setHost(String host)
void	setIterableBehaviour(boolean iterableBehaviour)
void	setMaxWaitTime(Integer maxWaitTime)
void	setRetryWrites(boolean retryWrites)
void	setSocketTimeout(Integer socketTimeout)
void	setSsl(boolean ssl)
void	setThreadsAllowedToBlockForConnectionMultiplier(Integer threadsAllowedToBlockForConnectionMultiplier)
void	testConnect(String username, String password, String database) Method invoked when testing connectivity

Methods inherited from class java.lang.Object

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

Field Detail

COMMA_SEPARATED_REGEX

public static final String COMMA_SEPARATED_REGEX

See Also:

Constant Field Values

connectionsPerHost

@Configurable
 @Optional
public Integer connectionsPerHost

The number of connections allowed per host (the pool size, per host)

threadsAllowedToBlockForConnectionMultiplier

@Configurable
 @Optional
public Integer threadsAllowedToBlockForConnectionMultiplier

Multiplier for connectionsPerHost for # of threads that can block.

maxWaitTime

@Configurable
 @Optional
public Integer maxWaitTime

The max wait time for a blocking thread for a connection from the pool in ms.

Constructor Detail

Config

public Config()

Method Detail

getAddresses

protected static List<com.mongodb.ServerAddress> getAddresses(@NotNull
                                                              String commaSeparatedHosts)
                                                       throws org.mule.api.ConnectionException

Throws:

org.mule.api.ConnectionException

isIterableBehaviour

public boolean isIterableBehaviour()

setIterableBehaviour

public void setIterableBehaviour(boolean iterableBehaviour)

getClient

public MongoClient getClient()

Specified by:

getClient in interface AbstractConfig

connect

@Connect(strategy=SINGLE_INSTANCE)
public void connect(@Default(value="")
                                                       String username,
                                                       @Optional @Password
                                                       String password,
                                                       @ConnectionKey
                                                       String database)
                                                throws org.mule.api.ConnectionException

Method invoked when a Mongo session needs to be created.

Parameters:

username - the username to use for authentication.

password - the password to use for authentication. If the password is null or whitespaces only, the connector won't use authentication and username must be empty too.

database - Name of the database

Throws:

org.mule.api.ConnectionException - if connection cannot be established

testConnect

@TestConnectivity
public void testConnect(@ConnectionKey
                                          String username,
                                          @Optional @Password
                                          String password,
                                          @ConnectionKey
                                          String database)
                                   throws org.mule.api.ConnectionException

Method invoked when testing connectivity

Parameters:

username - the username to use for authentication.

password - the password to use for authentication. If the password is null or whitespaces only, the connector won't use authentication and username must be empty too.

database - Name of the database

Throws:

org.mule.api.ConnectionException - if connection cannot be established

disconnect

@Disconnect
public void disconnect()

Method invoked when the Mongo session is to be destroyed.

isConnected

@ValidateConnection
public boolean isConnected()

connectionId

@ConnectionIdentifier
public String connectionId()

getHost

public String getHost()

setHost

public void setHost(String host)

getDatabase

public String getDatabase()

Specified by:

getDatabase in interface AbstractConfig

setDatabase

public void setDatabase(String database)

getConnectionsPerHost

public Integer getConnectionsPerHost()

setConnectionsPerHost

public void setConnectionsPerHost(Integer connectionsPerHost)

getThreadsAllowedToBlockForConnectionMultiplier

public Integer getThreadsAllowedToBlockForConnectionMultiplier()

setThreadsAllowedToBlockForConnectionMultiplier

public void setThreadsAllowedToBlockForConnectionMultiplier(Integer threadsAllowedToBlockForConnectionMultiplier)

getMaxWaitTime

public Integer getMaxWaitTime()

setMaxWaitTime

public void setMaxWaitTime(Integer maxWaitTime)

getConnectTimeout

public Integer getConnectTimeout()

setConnectTimeout

public void setConnectTimeout(Integer connectTimeout)

getSocketTimeout

public Integer getSocketTimeout()

setSocketTimeout

public void setSocketTimeout(Integer socketTimeout)

getSsl

public boolean getSsl()

setSsl

public void setSsl(boolean ssl)

setAuthenticationDatabase

public void setAuthenticationDatabase(String authenticationDatabase)

getAuthenticationDatabase

public String getAuthenticationDatabase()

isRetryWrites

public boolean isRetryWrites()

setRetryWrites

public void setRetryWrites(boolean retryWrites)