MorphiumConfig (Morphium 2.2.13 API)

java.lang.Object
- de.caluga.morphium.MorphiumConfig

```
public class MorphiumConfig
extends Object
```
Stores the configuration for the MongoDBLayer.

Author:

stephan

Constructor Summary

Constructors
Constructor and Description
`MorphiumConfig()`
`MorphiumConfig(Properties prop)`
`MorphiumConfig(String db, int maxConnections, int globalCacheValidTime, int housekeepingTimeout)`
`MorphiumConfig(String db, int maxConnections, int globalCacheValidTime, int housekeepingTimeout, String resourceName)`
`MorphiumConfig(String db, int maxConnections, int globalCacheValidTime, int housekeepingTimeout, URL loggingConfigResource)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAddress(String host)` Deprecated.
`void`	`addAddress(String host, int port)` Deprecated.
`void`	`addHost(String host)`
`void`	`addHost(String host, int port)`
`Properties`	`asProperties()` returns a property set only containing non-default values set
`void`	`configureLogging()`
`static MorphiumConfig`	`createFromJson(String json)`
`void`	`disableAsyncWrites()`
`void`	`disableAutoValues()`
`void`	`disableBufferedWrites()`
`void`	`disableReadCache()`
`void`	`enableAsyncWrites()`
`void`	`enableAutoValues()`
`void`	`enableBufferedWrites()`
`void`	`enableReadCache()`
`static MorphiumConfig`	`fromProperties(Properties p)`
`int`	`getAcceptableLatencyDifference()`
`List<com.mongodb.ServerAddress>`	`getAdr()`
`Class<? extends Aggregator>`	`getAggregatorClass()`
`AggregatorFactory`	`getAggregatorFactory()`
`MorphiumWriter`	`getAsyncWriter()`
`int`	`getBlockingThreadsMultiplier()`
`MorphiumWriter`	`getBufferedWriter()`
`MorphiumCache`	`getCache()`
`int`	`getConnectionTimeout()`
`String`	`getDatabase()`
`com.mongodb.DB`	`getDb()`
`ReadPreferenceLevel`	`getDefaultReadPreference()`
`Class<? extends MongoField>`	`getFieldImplClass()`
`int`	`getGlobalCacheValidTime()` for future use - set Global Caching time
`int`	`getGlobalW()`
`int`	`getHousekeepingTimeout()`
`Class<? extends MorphiumIterator>`	`getIteratorClass()`
`String`	`getLoggingConfigFile()`
`int`	`getMaxAutoReconnectTime()`
`int`	`getMaxConnections()`
`int`	`getMaximumRetriesAsyncWriter()`
`int`	`getMaximumRetriesBufferedWriter()`
`int`	`getMaximumRetriesWriter()`
`int`	`getMaxWaitTime()`
`String`	`getMongoAdminPwd()`
`String`	`getMongoAdminUser()`
`String`	`getMongoLogin()`
`String`	`getMongoPassword()`
`Class<? extends ObjectMapper>`	`getOmClass()`
`Class<? extends Query>`	`getQueryClass()`
`QueryFactory`	`getQueryFact()`
`int`	`getReplicaSetMonitoringTimeout()`
`int`	`getRetriesOnNetworkError()`
`int`	`getRetryWaitTimeAsyncWriter()`
`int`	`getRetryWaitTimeBufferedWriter()`
`int`	`getRetryWaitTimeWriter()`
`int`	`getSleepBetweenNetworkErrorRetries()`
`int`	`getSocketTimeout()`
`long`	`getValidTime()`
`int`	`getWriteBufferTime()`
`int`	`getWriteBufferTimeGranularity()`
`int`	`getWriteCacheTimeout()`
`MorphiumWriter`	`getWriter()`
`int`	`getWriteTimeout()`
`boolean`	`isAsyncWritesEnabled()`
`boolean`	`isAutoreconnect()`
`boolean`	`isAutoValuesEnabled()`
`boolean`	`isBufferedWritesEnabled()`
`boolean`	`isCamelCaseConversionEnabled()`
`boolean`	`isCheckForNew()`
`boolean`	`isGlobalFsync()`
`boolean`	`isGlobalJ()`
`boolean`	`isReadCacheEnabled()`
`boolean`	`isSafeMode()`
`boolean`	`isSocketKeepAlive()`
`void`	`setAcceptableLatencyDifference(int acceptableLatencyDifference)`
`void`	`setAdr(List<com.mongodb.ServerAddress> adr)` add addresses to your servers here.
`void`	`setAggregatorClass(Class<? extends Aggregator> aggregatorClass)`
`void`	`setAggregatorFactory(AggregatorFactory aggregatorFactory)`
`void`	`setAsyncWriter(MorphiumWriter asyncWriter)`
`void`	`setAsyncWritesEnabled(boolean asyncWritesEnabled)`
`void`	`setAutoreconnect(boolean autoreconnect)`
`void`	`setAutoValuesEnabled(boolean enabled)`
`void`	`setBlockingThreadsMultiplier(int blockingThreadsMultiplier)`
`void`	`setBufferedWriter(MorphiumWriter bufferedWriter)`
`void`	`setBufferedWritesEnabled(boolean bufferedWritesEnabled)`
`void`	`setCache(MorphiumCache cache)`
`void`	`setCamelCaseConversionEnabled(boolean camelCaseConversionEnabled)`
`void`	`setCheckForNew(boolean checkForNew)`
`void`	`setConnectionTimeout(int connectionTimeout)`
`void`	`setDatabase(String database)`
`void`	`setDb(com.mongodb.DB db)`
`void`	`setDefaultReadPreference(ReadPreferenceLevel defaultReadPreference)`
`void`	`setFieldImplClass(Class<? extends MongoField> fieldImplClass)`
`void`	`setGlobalCacheValidTime(int globalCacheValidTime)`
`void`	`setGlobalFsync(boolean globalFsync)`
`void`	`setGlobalJ(boolean globalJ)`
`void`	`setGlobalW(int globalW)`
`void`	`setHosts(List<String> str)` setting hosts as Host:Port
`void`	`setHosts(List<String> str, List<Integer> ports)`
`void`	`setHosts(String hostPorts)`
`void`	`setHosts(String hosts, String ports)`
`void`	`setHousekeepingTimeout(int housekeepingTimeout)`
`void`	`setIteratorClass(Class<? extends MorphiumIterator> iteratorClass)`
`void`	`setLoggingConfigFile(String loggingConfigFile)`
`void`	`setMaxAutoReconnectTime(int maxAutoReconnectTime)`
`void`	`setMaxConnections(int maxConnections)`
`void`	`setMaximumRetriesAsyncWriter(int maximumRetriesAsyncWriter)`
`void`	`setMaximumRetriesBufferedWriter(int maximumRetriesBufferedWriter)`
`void`	`setMaximumRetriesWriter(int maximumRetriesWriter)`
`void`	`setMaxWaitTime(int maxWaitTime)`
`void`	`setMongoAdminPwd(String mongoAdminPwd)`
`void`	`setMongoAdminUser(String mongoAdminUser)`
`void`	`setMongoLogin(String mongoLogin)`
`void`	`setMongoPassword(String mongoPassword)`
`void`	`setOmClass(Class<? extends ObjectMapper> omClass)`
`void`	`setQueryClass(Class<Query> queryClass)`
`void`	`setQueryFact(QueryFactory queryFact)`
`void`	`setReadCacheEnabled(boolean readCacheEnabled)`
`void`	`setReplicaSetMonitoringTimeout(int replicaSetMonitoringTimeout)`
`void`	`setRetriesOnNetworkError(int retriesOnNetworkError)`
`void`	`setRetryWaitTimeAsyncWriter(int retryWaitTimeAsyncWriter)`
`void`	`setRetryWaitTimeBufferedWriter(int retryWaitTimeBufferedWriter)`
`void`	`setRetryWaitTimeWriter(int retryWaitTimeWriter)`
`void`	`setSafeMode(boolean safeMode)`
`void`	`setSleepBetweenNetworkErrorRetries(int sleepBetweenNetworkErrorRetries)`
`void`	`setSocketKeepAlive(boolean socketKeepAlive)`
`void`	`setSocketTimeout(int socketTimeout)`
`void`	`setValidTime(int tm)`
`void`	`setWriteBufferTime(int writeBufferTime)`
`void`	`setWriteBufferTimeGranularity(int writeBufferTimeGranularity)`
`void`	`setWriteCacheTimeout(int writeCacheTimeout)`
`void`	`setWriter(MorphiumWriter writer)`
`void`	`setWriteTimeout(int writeTimeout)`
`String`	`toString()` returns json representation of this object containing all values

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MorphiumConfig

public MorphiumConfig(Properties prop)

MorphiumConfig
```
public MorphiumConfig()
```

MorphiumConfig

public MorphiumConfig(String db,
              int maxConnections,
              int globalCacheValidTime,
              int housekeepingTimeout)
               throws IOException

Throws:: IOException

MorphiumConfig

public MorphiumConfig(String db,
              int maxConnections,
              int globalCacheValidTime,
              int housekeepingTimeout,
              String resourceName)
               throws IOException

Throws:: IOException

MorphiumConfig

public MorphiumConfig(String db,
              int maxConnections,
              int globalCacheValidTime,
              int housekeepingTimeout,
              URL loggingConfigResource)

Method Detail

isCheckForNew
```
public boolean isCheckForNew()
```

setCheckForNew

public void setCheckForNew(boolean checkForNew)

getLoggingConfigFile
```
public String getLoggingConfigFile()
```

setLoggingConfigFile

public void setLoggingConfigFile(String loggingConfigFile)

configureLogging
```
public void configureLogging()
```

createFromJson

public static MorphiumConfig createFromJson(String json)
                                     throws org.json.simple.parser.ParseException,
                                            NoSuchFieldException,
                                            ClassNotFoundException,
                                            IllegalAccessException,
                                            InstantiationException,
                                            UnknownHostException,
                                            NoSuchMethodException,
                                            InvocationTargetException

Throws:: org.json.simple.parser.ParseException; NoSuchFieldException; ClassNotFoundException; IllegalAccessException; InstantiationException; UnknownHostException; NoSuchMethodException; InvocationTargetException

getRetriesOnNetworkError
```
public int getRetriesOnNetworkError()
```

setRetriesOnNetworkError

public void setRetriesOnNetworkError(int retriesOnNetworkError)

getSleepBetweenNetworkErrorRetries

public int getSleepBetweenNetworkErrorRetries()

setSleepBetweenNetworkErrorRetries

public void setSleepBetweenNetworkErrorRetries(int sleepBetweenNetworkErrorRetries)

getReplicaSetMonitoringTimeout

public int getReplicaSetMonitoringTimeout()

setReplicaSetMonitoringTimeout

public void setReplicaSetMonitoringTimeout(int replicaSetMonitoringTimeout)

getWriteBufferTimeGranularity

public int getWriteBufferTimeGranularity()

setWriteBufferTimeGranularity

public void setWriteBufferTimeGranularity(int writeBufferTimeGranularity)

getCache
```
public MorphiumCache getCache()
```

setCache

public void setCache(MorphiumCache cache)

getWriteBufferTime
```
public int getWriteBufferTime()
```

setWriteBufferTime

public void setWriteBufferTime(int writeBufferTime)

getOmClass

public Class<? extends ObjectMapper> getOmClass()

setOmClass

public void setOmClass(Class<? extends ObjectMapper> omClass)

getWriteTimeout
```
public int getWriteTimeout()
```

setWriteTimeout

public void setWriteTimeout(int writeTimeout)

getGlobalW
```
public int getGlobalW()
```

setGlobalW
```
public void setGlobalW(int globalW)
```

isGlobalJ
```
public boolean isGlobalJ()
```

setGlobalJ

public void setGlobalJ(boolean globalJ)

getQueryClass

public Class<? extends Query> getQueryClass()

setQueryClass

public void setQueryClass(Class<Query> queryClass)

getQueryFact
```
public QueryFactory getQueryFact()
```

setQueryFact

public void setQueryFact(QueryFactory queryFact)

getAggregatorFactory

public AggregatorFactory getAggregatorFactory()

setAggregatorFactory

public void setAggregatorFactory(AggregatorFactory aggregatorFactory)

getAggregatorClass

public Class<? extends Aggregator> getAggregatorClass()

setAggregatorClass

public void setAggregatorClass(Class<? extends Aggregator> aggregatorClass)

isGlobalFsync
```
public boolean isGlobalFsync()
```

setGlobalFsync

public void setGlobalFsync(boolean globalFsync)

isSafeMode
```
public boolean isSafeMode()
```

setSafeMode

public void setSafeMode(boolean safeMode)

getBlockingThreadsMultiplier

public int getBlockingThreadsMultiplier()

setBlockingThreadsMultiplier

public void setBlockingThreadsMultiplier(int blockingThreadsMultiplier)

getBufferedWriter

public MorphiumWriter getBufferedWriter()

setBufferedWriter

public void setBufferedWriter(MorphiumWriter bufferedWriter)

getDb
```
public com.mongodb.DB getDb()
```

setDb
```
public void setDb(com.mongodb.DB db)
```

getWriter
```
public MorphiumWriter getWriter()
```

setWriter

public void setWriter(MorphiumWriter writer)

getConnectionTimeout
```
public int getConnectionTimeout()
```

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

getSocketTimeout
```
public int getSocketTimeout()
```

setSocketTimeout

public void setSocketTimeout(int socketTimeout)

getFieldImplClass

public Class<? extends MongoField> getFieldImplClass()

setFieldImplClass

public void setFieldImplClass(Class<? extends MongoField> fieldImplClass)

getMaxWaitTime
```
public int getMaxWaitTime()
```

setMaxWaitTime

public void setMaxWaitTime(int maxWaitTime)

isAutoreconnect
```
public boolean isAutoreconnect()
```

setAutoreconnect

public void setAutoreconnect(boolean autoreconnect)

getMaxAutoReconnectTime
```
public int getMaxAutoReconnectTime()
```

setMaxAutoReconnectTime

public void setMaxAutoReconnectTime(int maxAutoReconnectTime)

isSocketKeepAlive
```
public boolean isSocketKeepAlive()
```

setSocketKeepAlive

public void setSocketKeepAlive(boolean socketKeepAlive)

getMongoLogin
```
public String getMongoLogin()
```

setMongoLogin

public void setMongoLogin(String mongoLogin)

getMongoPassword
```
public String getMongoPassword()
```

setMongoPassword

public void setMongoPassword(String mongoPassword)

getDefaultReadPreference

public ReadPreferenceLevel getDefaultReadPreference()

setDefaultReadPreference

public void setDefaultReadPreference(ReadPreferenceLevel defaultReadPreference)

getMongoAdminUser
```
public String getMongoAdminUser()
```

setMongoAdminUser

public void setMongoAdminUser(String mongoAdminUser)

getMongoAdminPwd
```
public String getMongoAdminPwd()
```

setMongoAdminPwd

public void setMongoAdminPwd(String mongoAdminPwd)

getWriteCacheTimeout
```
public int getWriteCacheTimeout()
```

setWriteCacheTimeout

public void setWriteCacheTimeout(int writeCacheTimeout)

getAdr

public List<com.mongodb.ServerAddress> getAdr()

setAdr
```
public void setAdr(List<com.mongodb.ServerAddress> adr)
```
add addresses to your servers here. Depending on isREplicaSet() and isPaired() one ore more server addresses are needed

setHosts
```
public void setHosts(List<String> str)
              throws UnknownHostException
```
setting hosts as Host:Port

Parameters:
str - list of hosts, with or without port

Throws:

UnknownHostException

setHosts

public void setHosts(List<String> str,
            List<Integer> ports)
              throws UnknownHostException

Throws:: UnknownHostException

setHosts

public void setHosts(String hostPorts)
              throws UnknownHostException

Throws:: UnknownHostException

setHosts

public void setHosts(String hosts,
            String ports)
              throws UnknownHostException

Throws:: UnknownHostException

addAddress
```
@Deprecated
public void addAddress(String host,
                         int port)
                throws UnknownHostException
```
Deprecated.

add addresses to your servers here. Depending on isREplicaSet() and isPaired() one ore more server addresses are needed use addHost instead

Throws:

UnknownHostException

addHost

public void addHost(String host,
           int port)
             throws UnknownHostException

Throws:: UnknownHostException

addAddress

@Deprecated
public void addAddress(String host)
                throws UnknownHostException

Deprecated.

use addhost instead

Parameters:: host -
Throws:: UnknownHostException

addHost

public void addHost(String host)
             throws UnknownHostException

Throws:: UnknownHostException

getMaxConnections
```
public int getMaxConnections()
```

setMaxConnections

public void setMaxConnections(int maxConnections)

getGlobalCacheValidTime
```
public int getGlobalCacheValidTime()
```
for future use - set Global Caching time

Returns:
the global cache valid time

setGlobalCacheValidTime

public void setGlobalCacheValidTime(int globalCacheValidTime)

getDatabase
```
public String getDatabase()
```

setDatabase

public void setDatabase(String database)

getHousekeepingTimeout
```
public int getHousekeepingTimeout()
```

setHousekeepingTimeout

public void setHousekeepingTimeout(int housekeepingTimeout)

getValidTime
```
public long getValidTime()
```

setValidTime
```
public void setValidTime(int tm)
```

toString
```
public String toString()
```
returns json representation of this object containing all values

Overrides:

toString in class Object

Returns:
json string

getIteratorClass

public Class<? extends MorphiumIterator> getIteratorClass()

setIteratorClass

public void setIteratorClass(Class<? extends MorphiumIterator> iteratorClass)

getAsyncWriter

public MorphiumWriter getAsyncWriter()

setAsyncWriter

public void setAsyncWriter(MorphiumWriter asyncWriter)

getMaximumRetriesBufferedWriter

public int getMaximumRetriesBufferedWriter()

setMaximumRetriesBufferedWriter

public void setMaximumRetriesBufferedWriter(int maximumRetriesBufferedWriter)

getMaximumRetriesWriter
```
public int getMaximumRetriesWriter()
```

setMaximumRetriesWriter

public void setMaximumRetriesWriter(int maximumRetriesWriter)

getMaximumRetriesAsyncWriter

public int getMaximumRetriesAsyncWriter()

setMaximumRetriesAsyncWriter

public void setMaximumRetriesAsyncWriter(int maximumRetriesAsyncWriter)

getRetryWaitTimeBufferedWriter

public int getRetryWaitTimeBufferedWriter()

setRetryWaitTimeBufferedWriter

public void setRetryWaitTimeBufferedWriter(int retryWaitTimeBufferedWriter)

getRetryWaitTimeWriter
```
public int getRetryWaitTimeWriter()
```

setRetryWaitTimeWriter

public void setRetryWaitTimeWriter(int retryWaitTimeWriter)

getRetryWaitTimeAsyncWriter

public int getRetryWaitTimeAsyncWriter()

setRetryWaitTimeAsyncWriter

public void setRetryWaitTimeAsyncWriter(int retryWaitTimeAsyncWriter)

asProperties
```
public Properties asProperties()
```
returns a property set only containing non-default values set

Returns:

fromProperties

public static MorphiumConfig fromProperties(Properties p)
                                     throws ClassNotFoundException,
                                            NoSuchFieldException,
                                            InstantiationException,
                                            IllegalAccessException,
                                            UnknownHostException

Throws:: ClassNotFoundException; NoSuchFieldException; InstantiationException; IllegalAccessException; UnknownHostException

isReadCacheEnabled
```
public boolean isReadCacheEnabled()
```

setReadCacheEnabled

public void setReadCacheEnabled(boolean readCacheEnabled)

disableReadCache
```
public void disableReadCache()
```

enableReadCache
```
public void enableReadCache()
```

isAsyncWritesEnabled
```
public boolean isAsyncWritesEnabled()
```

setAsyncWritesEnabled

public void setAsyncWritesEnabled(boolean asyncWritesEnabled)

disableAsyncWrites
```
public void disableAsyncWrites()
```

enableAsyncWrites
```
public void enableAsyncWrites()
```

isBufferedWritesEnabled

public boolean isBufferedWritesEnabled()

setBufferedWritesEnabled

public void setBufferedWritesEnabled(boolean bufferedWritesEnabled)

disableBufferedWrites
```
public void disableBufferedWrites()
```

enableBufferedWrites
```
public void enableBufferedWrites()
```

setAutoValuesEnabled

public void setAutoValuesEnabled(boolean enabled)

isAutoValuesEnabled
```
public boolean isAutoValuesEnabled()
```

enableAutoValues
```
public void enableAutoValues()
```

disableAutoValues
```
public void disableAutoValues()
```

getAcceptableLatencyDifference

public int getAcceptableLatencyDifference()

setAcceptableLatencyDifference

public void setAcceptableLatencyDifference(int acceptableLatencyDifference)

isCamelCaseConversionEnabled

public boolean isCamelCaseConversionEnabled()

setCamelCaseConversionEnabled

public void setCamelCaseConversionEnabled(boolean camelCaseConversionEnabled)

Class MorphiumConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MorphiumConfig

MorphiumConfig

MorphiumConfig

MorphiumConfig

MorphiumConfig

Method Detail

isCheckForNew

setCheckForNew

getLoggingConfigFile

setLoggingConfigFile

configureLogging

createFromJson

getRetriesOnNetworkError

setRetriesOnNetworkError

getSleepBetweenNetworkErrorRetries

setSleepBetweenNetworkErrorRetries

getReplicaSetMonitoringTimeout

setReplicaSetMonitoringTimeout

getWriteBufferTimeGranularity

setWriteBufferTimeGranularity

getCache

setCache

getWriteBufferTime

setWriteBufferTime

getOmClass

setOmClass

getWriteTimeout

setWriteTimeout

getGlobalW

setGlobalW

isGlobalJ

setGlobalJ

getQueryClass

setQueryClass

getQueryFact

setQueryFact

getAggregatorFactory

setAggregatorFactory

getAggregatorClass

setAggregatorClass

isGlobalFsync

setGlobalFsync

isSafeMode

setSafeMode

getBlockingThreadsMultiplier

setBlockingThreadsMultiplier

getBufferedWriter

setBufferedWriter

getDb

setDb

getWriter

setWriter

getConnectionTimeout

setConnectionTimeout

getSocketTimeout

setSocketTimeout

getFieldImplClass

setFieldImplClass

getMaxWaitTime

setMaxWaitTime

isAutoreconnect

setAutoreconnect

getMaxAutoReconnectTime

setMaxAutoReconnectTime

isSocketKeepAlive

setSocketKeepAlive

getMongoLogin

setMongoLogin

getMongoPassword

setMongoPassword

getDefaultReadPreference

setDefaultReadPreference

getMongoAdminUser

setMongoAdminUser

getMongoAdminPwd