java.lang.Object
- com.github.ddth.queue.impl.AbstractQueueFactory<T,ID,DATA>
- - com.github.ddth.queue.impl.MongodbQueueFactory<T,ID,DATA>

All Implemented Interfaces:

IQueueFactory<ID,DATA>, AutoCloseable

Direct Known Subclasses:

UniversalMongodbQueueFactory, UniversalMongodbQueueFactory
```
public abstract class MongodbQueueFactory<T extends MongodbQueue<ID,DATA>,ID,DATA>
extends AbstractQueueFactory<T,ID,DATA>
```
Factory to create MongodbQueue instances.

Since:

0.7.1

Author:

Thanh Ba Nguyen

Field Summary

Fields
Modifier and Type Field Description

static String SPEC_FIELD_COLLECTION_NAME

static String SPEC_FIELD_CONNECTION_STRING

static String SPEC_FIELD_DATABASE_NAME

Constructor Summary

Constructors
Constructor Description

MongodbQueueFactory()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`destroy()`
`String`	`getDefaultCollectionName()`	Default name of MongoDB collection to store queue messages, passed to all queues created by this factory.
`String`	`getDefaultConnectionString()`	Default MongoDB's connection string (see http://mongodb.github.io/mongo-java-driver/3.10/driver/getting-started/quick-start/), passed to all queues created by this factory.
`String`	`getDefaultDatabaseName()`	Default name of MongoDB database to store data, passed to all queues created by this factory.
`protected com.mongodb.client.MongoClient`	`getDefaultMongoClient()`	If all `MongodbQueue` instances are connecting to one MongoDB server or cluster, it's a good idea to pre-create a `MongoClient` instance and share it amongst `MongodbQueue` instances created from this factory by assigning it to `defaultMongoClient` (see `setDefaultMongoClient(MongoClient)`).
`protected void`	`initQueue(T queue, QueueSpec spec)`	Initialize a newly created queue instance.
`MongodbQueueFactory<T,ID,DATA>`	`setDefaultCollectionName(String defaultCollectionName)`	Default name of MongoDB collection to store queue messages, passed to all queues created by this factory.
`MongodbQueueFactory<T,ID,DATA>`	`setDefaultConnectionString(String defaultConnectionString)`	Default MongoDB's connection string (see http://mongodb.github.io/mongo-java-driver/3.10/driver/getting-started/quick-start/), passed to all queues created by this factory.
`MongodbQueueFactory<T,ID,DATA>`	`setDefaultDatabaseName(String defaultDatabaseName)`	Default name of MongoDB database to store data, passed to all queues created by this factory.
`MongodbQueueFactory<T,ID,DATA>`	`setDefaultMongoClient(com.mongodb.client.MongoClient mongoClient)`	If all `MongodbQueue` instances are connecting to one MongoDB server or cluster, it's a good idea to pre-create a `MongoClient` instance and share it amongst `MongodbQueue` instances created from this factory by assigning it to `defaultMongoClient` (see `setDefaultMongoClient(MongoClient)`).
`protected MongodbQueueFactory<T,ID,DATA>`	`setDefaultMongoClient(com.mongodb.client.MongoClient mongoClient, boolean setMyOwnMongoClient)`	If all `MongodbQueue` instances are connecting to one MongoDB server or cluster, it's a good idea to pre-create a `MongoClient` instance and share it amongst `MongodbQueue` instances created from this factory by assigning it to `defaultMongoClient` (see `setDefaultMongoClient(MongoClient)`).

Methods inherited from class com.github.ddth.queue.impl.AbstractQueueFactory
close, createAndInitQueue, createQueueInstance, getDefaultEphemeralDisabled, getDefaultEphemeralMaxSize, getDefaultMaxSize, getQueue, init, isDefaultEphemeralDisabled, setDefaultEphemeralDisabled, setDefaultEphemeralMaxSize, setDefaultMaxSize

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

- Field Detail
  - SPEC_FIELD_CONNECTION_STRING
```
public static final String SPEC_FIELD_CONNECTION_STRING
```
    See Also:
    
    Constant Field Values
  - SPEC_FIELD_DATABASE_NAME
```
public static final String SPEC_FIELD_DATABASE_NAME
```
    See Also:
    
    Constant Field Values
  - SPEC_FIELD_COLLECTION_NAME
```
public static final String SPEC_FIELD_COLLECTION_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MongodbQueueFactory
```
public MongodbQueueFactory()
```
- Method Detail
  - getDefaultConnectionString
```
public String getDefaultConnectionString()
```
    Default MongoDB's connection string (see http://mongodb.github.io/mongo-java-driver/3.10/driver/getting-started/quick-start/), passed to all queues created by this factory.
    
    Returns:
  - setDefaultConnectionString
```
public MongodbQueueFactory<T,ID,DATA> setDefaultConnectionString(String defaultConnectionString)
```
    Default MongoDB's connection string (see http://mongodb.github.io/mongo-java-driver/3.10/driver/getting-started/quick-start/), passed to all queues created by this factory.
    
    Parameters:
    
    defaultConnectionString -
    
    Returns:
  - getDefaultDatabaseName
```
public String getDefaultDatabaseName()
```
    Default name of MongoDB database to store data, passed to all queues created by this factory.
    
    Returns:
  - setDefaultDatabaseName
```
public MongodbQueueFactory<T,ID,DATA> setDefaultDatabaseName(String defaultDatabaseName)
```
    Default name of MongoDB database to store data, passed to all queues created by this factory.
    
    Parameters:
    
    defaultDatabaseName -
    
    Returns:
  - getDefaultCollectionName
```
public String getDefaultCollectionName()
```
    Default name of MongoDB collection to store queue messages, passed to all queues created by this factory.
    
    Returns:
  - setDefaultCollectionName
```
public MongodbQueueFactory<T,ID,DATA> setDefaultCollectionName(String defaultCollectionName)
```
    Default name of MongoDB collection to store queue messages, passed to all queues created by this factory.
    
    Parameters:
    
    defaultCollectionName -
    
    Returns:
  - getDefaultMongoClient
```
protected com.mongodb.client.MongoClient getDefaultMongoClient()
```
    If all MongodbQueue instances are connecting to one MongoDB server or cluster, it's a good idea to pre-create a MongoClient instance and share it amongst MongodbQueue instances created from this factory by assigning it to defaultMongoClient (see setDefaultMongoClient(MongoClient)).
    
    Returns:
  - setDefaultMongoClient
```
public MongodbQueueFactory<T,ID,DATA> setDefaultMongoClient(com.mongodb.client.MongoClient mongoClient)
```
    If all MongodbQueue instances are connecting to one MongoDB server or cluster, it's a good idea to pre-create a MongoClient instance and share it amongst MongodbQueue instances created from this factory by assigning it to defaultMongoClient (see setDefaultMongoClient(MongoClient)).
    
    Parameters:
    
    mongoClient -
    
    Returns:
  - setDefaultMongoClient
```
protected MongodbQueueFactory<T,ID,DATA> setDefaultMongoClient(com.mongodb.client.MongoClient mongoClient,
                                                                           boolean setMyOwnMongoClient)
```
    If all MongodbQueue instances are connecting to one MongoDB server or cluster, it's a good idea to pre-create a MongoClient instance and share it amongst MongodbQueue instances created from this factory by assigning it to defaultMongoClient (see setDefaultMongoClient(MongoClient)).
    
    Parameters:
    
    mongoClient -
    
    setMyOwnMongoClient -
    
    Returns:
  - destroy
```
public void destroy()
```
    Overrides:
    
    destroy in class AbstractQueueFactory<T extends MongodbQueue<ID,DATA>,ID,DATA>
  - initQueue
```
protected void initQueue(T queue,
                         QueueSpec spec)
                  throws Exception
```
    Initialize a newly created queue instance.
    Called by AbstractQueueFactory.createAndInitQueue(QueueSpec). Sub-class may override this method to implement its own business logic.
    
    Overrides:
    
    initQueue in class AbstractQueueFactory<T extends MongodbQueue<ID,DATA>,ID,DATA>
    
    Throws:
    
    Exception

Modifier and Type	Field	Description
`static String`	`SPEC_FIELD_COLLECTION_NAME`
`static String`	`SPEC_FIELD_CONNECTION_STRING`
`static String`	`SPEC_FIELD_DATABASE_NAME`

Class MongodbQueueFactory<T extends MongodbQueue<ID,​DATA>,​ID,​DATA>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.github.ddth.queue.impl.AbstractQueueFactory

Methods inherited from class java.lang.Object

Field Detail

SPEC_FIELD_CONNECTION_STRING

SPEC_FIELD_DATABASE_NAME

SPEC_FIELD_COLLECTION_NAME

Constructor Detail

MongodbQueueFactory

Method Detail

getDefaultConnectionString

setDefaultConnectionString

getDefaultDatabaseName

setDefaultDatabaseName

getDefaultCollectionName

setDefaultCollectionName

getDefaultMongoClient

setDefaultMongoClient

setDefaultMongoClient

destroy

initQueue

Class MongodbQueueFactory<T extends MongodbQueue<ID,DATA>,ID,DATA>