java.lang.Object
- com.github.ddth.pubsub.impl.AbstractPubSubHub<ID,DATA>
- - com.github.ddth.pubsub.impl.MongodbPubSubHub<ID,DATA>

All Implemented Interfaces:

IPubSubHub<ID,DATA>, AutoCloseable

Direct Known Subclasses:

UniversalMongodbPubSubHub, UniversalMongodbPubSubHub
```
public class MongodbPubSubHub<ID,DATA>
extends AbstractPubSubHub<ID,DATA>
```
(Experimental) MongoDB implementation of IPubSubHub.

Since:

0.7.1

Author:

Thanh Ba Nguyen

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`COLLECTION_FIELD_DATA`
`static String`	`COLLECTION_FIELD_ID`
`static String`	`COLLECTION_FIELD_TIME`
`static String`	`DEFAULT_CONN_STR`
`static String`	`DEFAULT_DATABASE_NAME`
`static long`	`DEFAULT_MAX_COLLECTION_SIZE`
`static long`	`DEFAULT_MAX_DOCUMENTS`

Constructor Summary

Constructors
Constructor Description

MongodbPubSubHub()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected com.mongodb.client.MongoClient`	`buildMongoClient()`	Build a new `MongoClient` instance.
`void`	`destroy()`	Clean-up method.
`protected IMessage<ID,DATA>`	`fromDocument(org.bson.Document doc)`
`String`	`getConnectionString()`	Getter for `connectionString` (see http://mongodb.github.io/mongo-java-driver/3.7/driver/getting-started/quick-start/).
`protected com.mongodb.client.MongoDatabase`	`getDatabase()`
`String`	`getDatabaseName()`	Getter for `databaseName`.
`long`	`getMaxCollectionSize()`	Max collection's size in bytes.
`long`	`getMaxDocuments()`	Max number of document per pub/sub collection.
`protected com.mongodb.client.MongoClient`	`getMongoClient()`	Getter for `mongoClient`.
`MongodbPubSubHub<ID,DATA>`	`init()`	Initializing method.
`boolean`	`publish(String channel, IMessage<ID,DATA> msg)`	Publish a message to a channel.
`MongodbPubSubHub<ID,DATA>`	`setConnectionString(String connectionString)`	Setter for `connectionString` (see http://mongodb.github.io/mongo-java-driver/3.7/driver/getting-started/quick-start/).
`MongodbPubSubHub<ID,DATA>`	`setDatabaseName(String databaseName)`	Setter for `databaseName`.
`MongodbPubSubHub<ID,DATA>`	`setMaxCollectionSize(long maxCollectionSize)`	Max number of document per pub/sub collection.
`MongodbPubSubHub<ID,DATA>`	`setMaxDocuments(long maxDocuments)`	Max number of document per pub/sub collection.
`MongodbPubSubHub<ID,DATA>`	`setMongoClient(com.mongodb.client.MongoClient mongoClient)`	Setter for `mongoClient`.
`protected MongodbPubSubHub<ID,DATA>`	`setMongoClient(com.mongodb.client.MongoClient mongoClient, boolean setMyOwnMongoClient)`	Setter for `mongoClient`.
`void`	`subscribe(String channel, ISubscriber<ID,DATA> subscriber)`	Subscribe to a channel for messages.
`protected org.bson.Document`	`toDocument(IMessage<ID,DATA> msg)`
`void`	`unsubscribe(String channel, ISubscriber<ID,DATA> subscriber)`	Unsubscribe from a channel.

Methods inherited from class com.github.ddth.pubsub.impl.AbstractPubSubHub
close, createMessage, createMessage, createMessage, deserialize, deserialize, getMessageFactory, getSerDeser, serialize, setMessageFactory, setSerDeser

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

- Field Detail
  - DEFAULT_CONN_STR
```
public static final String DEFAULT_CONN_STR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DATABASE_NAME
```
public static final String DEFAULT_DATABASE_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_DOCUMENTS
```
public static final long DEFAULT_MAX_DOCUMENTS
```
  - DEFAULT_MAX_COLLECTION_SIZE
```
public static final long DEFAULT_MAX_COLLECTION_SIZE
```
  - COLLECTION_FIELD_ID
```
public static final String COLLECTION_FIELD_ID
```
    See Also:
    
    Constant Field Values
  - COLLECTION_FIELD_TIME
```
public static final String COLLECTION_FIELD_TIME
```
    See Also:
    
    Constant Field Values
  - COLLECTION_FIELD_DATA
```
public static final String COLLECTION_FIELD_DATA
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MongodbPubSubHub
```
public MongodbPubSubHub()
```
- Method Detail
  - getMaxDocuments
```
public long getMaxDocuments()
```
    Max number of document per pub/sub collection.
    To allow pub/sub, the collection must be capped with a max number of documents.
    
    Returns:
    
    See Also:
    
    DEFAULT_MAX_DOCUMENTS
  - setMaxDocuments
```
public MongodbPubSubHub<ID,DATA> setMaxDocuments(long maxDocuments)
```
    Max number of document per pub/sub collection.
    To allow pub/sub, the collection must be capped with a max number of documents.
    
    Parameters:
    
    maxDocuments -
    
    Returns:
    
    See Also:
    
    DEFAULT_MAX_DOCUMENTS
  - getMaxCollectionSize
```
public long getMaxCollectionSize()
```
    Max collection's size in bytes.
    To allow pub/sub, the collection must be capped with a max size.
    
    Returns:
    
    See Also:
    
    DEFAULT_MAX_COLLECTION_SIZE
  - setMaxCollectionSize
```
public MongodbPubSubHub<ID,DATA> setMaxCollectionSize(long maxCollectionSize)
```
    Max number of document per pub/sub collection.
    To allow pub/sub, the collection must be capped with a max size.
    
    Parameters:
    
    maxCollectionSize -
    
    Returns:
    
    See Also:
    
    DEFAULT_MAX_COLLECTION_SIZE
  - getConnectionString
```
public String getConnectionString()
```
    Getter for connectionString (see http://mongodb.github.io/mongo-java-driver/3.7/driver/getting-started/quick-start/).
    
    Returns:
  - setConnectionString
```
public MongodbPubSubHub<ID,DATA> setConnectionString(String connectionString)
```
    Setter for connectionString (see http://mongodb.github.io/mongo-java-driver/3.7/driver/getting-started/quick-start/).
    
    Parameters:
    
    connectionString -
    
    Returns:
  - getDatabaseName
```
public String getDatabaseName()
```
    Getter for databaseName.
    
    Returns:
  - setDatabaseName
```
public MongodbPubSubHub<ID,DATA> setDatabaseName(String databaseName)
```
    Setter for databaseName.
    
    Parameters:
    
    databaseName -
    
    Returns:
  - getMongoClient
```
protected com.mongodb.client.MongoClient getMongoClient()
```
    Getter for mongoClient.
    
    Returns:
  - setMongoClient
```
public MongodbPubSubHub<ID,DATA> setMongoClient(com.mongodb.client.MongoClient mongoClient)
```
    Setter for mongoClient.
    
    Parameters:
    
    mongoClient -
    
    Returns:
  - setMongoClient
```
protected MongodbPubSubHub<ID,DATA> setMongoClient(com.mongodb.client.MongoClient mongoClient,
                                                         boolean setMyOwnMongoClient)
```
    Setter for mongoClient.
    
    Parameters:
    
    mongoClient -
    
    setMyOwnMongoClient -
    
    Returns:
  - getDatabase
```
protected com.mongodb.client.MongoDatabase getDatabase()
```
  - toDocument
```
protected org.bson.Document toDocument(IMessage<ID,DATA> msg)
```
  - fromDocument
```
protected IMessage<ID,DATA> fromDocument(org.bson.Document doc)
```
  - buildMongoClient
```
protected com.mongodb.client.MongoClient buildMongoClient()
```
    Build a new MongoClient instance.
    
    Returns:
  - init
```
public MongodbPubSubHub<ID,DATA> init()
```
    Initializing method.
    
    Overrides:
    
    init in class AbstractPubSubHub<ID,DATA>
    
    Returns:
  - destroy
```
public void destroy()
```
    Clean-up method.
    
    Overrides:
    
    destroy in class AbstractPubSubHub<ID,DATA>
  - publish
```
public boolean publish(String channel,
                       IMessage<ID,DATA> msg)
```
    Publish a message to a channel.
    
    Returns:
  - subscribe
```
public void subscribe(String channel,
                      ISubscriber<ID,DATA> subscriber)
```
    Subscribe to a channel for messages.
  - unsubscribe
```
public void unsubscribe(String channel,
                        ISubscriber<ID,DATA> subscriber)
```
    Unsubscribe from a channel.

Class MongodbPubSubHub<ID,​DATA>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.github.ddth.pubsub.impl.AbstractPubSubHub

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CONN_STR

DEFAULT_DATABASE_NAME

DEFAULT_MAX_DOCUMENTS

DEFAULT_MAX_COLLECTION_SIZE

COLLECTION_FIELD_ID

COLLECTION_FIELD_TIME

COLLECTION_FIELD_DATA

Constructor Detail

MongodbPubSubHub

Method Detail

getMaxDocuments

setMaxDocuments

getMaxCollectionSize

setMaxCollectionSize

getConnectionString

setConnectionString

getDatabaseName

setDatabaseName

getMongoClient

setMongoClient

setMongoClient

getDatabase

toDocument

fromDocument

buildMongoClient

init

destroy

publish

subscribe

unsubscribe

Class MongodbPubSubHub<ID,DATA>