MongoClientFactory (Crafter Commons Mongo 4.0.5 API)

java.lang.Object
- org.springframework.beans.factory.config.AbstractFactoryBean<com.mongodb.MongoClient>
- - org.craftercms.commons.mongo.MongoClientFactory

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<com.mongodb.MongoClient>, org.springframework.beans.factory.InitializingBean
```
public class MongoClientFactory
extends org.springframework.beans.factory.config.AbstractFactoryBean<com.mongodb.MongoClient>
```
Creates a Mongo Client based on a connection String

Connection String format host:PORT,[host1:port1],[hostN,portN] the port portion is optional default one 27017 will be use.

If connection String is null or empty or whitespace only, this factory will use as if connection String value is "127.0.0.1:27017"

Will throw IllegalArgumentException if port number is not valid

Field Summary

Fields
Modifier and Type Field Description

static String DEFAULT_MONGO_HOST

static int DEFAULT_MONGO_PORT
- Fields inherited from interface org.springframework.beans.factory.FactoryBean
  OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors
Constructor Description

MongoClientFactory()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected com.mongodb.MongoClient`	`createInstance()`
`Class<?>`	`getObjectType()`
`void`	`setConnectionString(String connectionString)`
`void`	`setOptions(com.mongodb.MongoClientOptions options)`
`void`	`setPassword(String password)`
`void`	`setUsername(String username)`

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean
afterPropertiesSet, destroy, destroyInstance, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

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

- Field Detail
  - DEFAULT_MONGO_HOST
```
public static final String DEFAULT_MONGO_HOST
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MONGO_PORT
```
public static final int DEFAULT_MONGO_PORT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MongoClientFactory
```
public MongoClientFactory()
```
- Method Detail
  - getObjectType
```
public Class<?> getObjectType()
```
    Specified by:
    
    getObjectType in interface org.springframework.beans.factory.FactoryBean<com.mongodb.MongoClient>
    
    Specified by:
    
    getObjectType in class org.springframework.beans.factory.config.AbstractFactoryBean<com.mongodb.MongoClient>
  - createInstance
```
protected com.mongodb.MongoClient createInstance()
                                          throws Exception
```
    Specified by:
    
    createInstance in class org.springframework.beans.factory.config.AbstractFactoryBean<com.mongodb.MongoClient>
    
    Throws:
    
    Exception
  - setConnectionString
```
public void setConnectionString(String connectionString)
```
  - setOptions
```
public void setOptions(com.mongodb.MongoClientOptions options)
```
  - setUsername
```
public void setUsername(String username)
```
  - setPassword
```
public void setPassword(String password)
```