org.apache.jackrabbit.mongomk

Class MongoDocumentStore

java.lang.Object

org.apache.jackrabbit.mongomk.MongoDocumentStore

All Implemented Interfaces:

DocumentStore

public class MongoDocumentStore
extends Object
implements DocumentStore

A document store that uses MongoDB as the backend.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jackrabbit.mongomk.DocumentStore

DocumentStore.Collection

Constructor Summary

Constructors

Constructor and Description
MongoDocumentStore(com.mongodb.DB db)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	create(DocumentStore.Collection collection, List<UpdateOp> updateOps) Try to create a list of documents.
Map<String,Object>	createOrUpdate(DocumentStore.Collection collection, UpdateOp update) Create or update a document.
void	dispose() Dispose this instance.
void	finalize()
Map<String,Object>	find(DocumentStore.Collection collection, String key) Get a document.
Map<String,Object>	find(DocumentStore.Collection collection, String key, int maxCacheAge) Get a document, ignoring the cache if the cached entry is older than the specified time.
Map<String,Object>	findAndUpdate(DocumentStore.Collection collection, UpdateOp update) Performs a conditional update (e.g.
void	invalidateCache() Invalidate the document cache.
void	invalidateCache(DocumentStore.Collection collection, String key) Invalidate the document cache for the given key.
boolean	isCached(DocumentStore.Collection collection, String key) Check whether the given document is in the cache.
List<Map<String,Object>>	query(DocumentStore.Collection collection, String fromKey, String toKey, int limit) Get a list of documents where the key is greater than a start value and less than an end value.
void	remove(DocumentStore.Collection collection, String key) Remove a document.

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoDocumentStore

public MongoDocumentStore(com.mongodb.DB db)

Method Detail

finalize

public void finalize()
              throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

invalidateCache

public void invalidateCache()

Description copied from interface: DocumentStore

Invalidate the document cache.

Specified by:

invalidateCache in interface DocumentStore

invalidateCache

public void invalidateCache(DocumentStore.Collection collection,
                   String key)

Description copied from interface: DocumentStore

Invalidate the document cache for the given key.

Specified by:

invalidateCache in interface DocumentStore

Parameters:

collection - the collection

key - the key

find

public Map<String,Object> find(DocumentStore.Collection collection,
                      String key)

Description copied from interface: DocumentStore

Get a document.

The returned map is a clone (the caller can modify it without affecting the stored version).

Specified by:

find in interface DocumentStore

Parameters:

collection - the collection

key - the key

Returns:

the map, or null if not found

find

public Map<String,Object> find(DocumentStore.Collection collection,
                      String key,
                      int maxCacheAge)

Description copied from interface: DocumentStore

Get a document, ignoring the cache if the cached entry is older than the specified time.

The returned map is a clone (the caller can modify it without affecting the stored version).

Specified by:

find in interface DocumentStore

Parameters:

collection - the collection

key - the key

maxCacheAge - the maximum age of the cached document

Returns:

the map, or null if not found

query

@Nonnull
public List<Map<String,Object>> query(DocumentStore.Collection collection,
                                     String fromKey,
                                     String toKey,
                                     int limit)

Description copied from interface: DocumentStore

Get a list of documents where the key is greater than a start value and less than an end value.

Specified by:

query in interface DocumentStore

Parameters:

collection - the collection

fromKey - the start value (excluding)

toKey - the end value (excluding)

limit - the maximum number of entries to return

Returns:

the list (possibly empty)

remove

public void remove(DocumentStore.Collection collection,
          String key)

Description copied from interface: DocumentStore

Remove a document.

Specified by:

remove in interface DocumentStore

Parameters:

collection - the collection

key - the key

createOrUpdate

@Nonnull
public Map<String,Object> createOrUpdate(DocumentStore.Collection collection,
                                        UpdateOp update)
                                  throws org.apache.jackrabbit.mk.api.MicroKernelException

Description copied from interface: DocumentStore

Create or update a document. For MongoDb, this is using "findAndModify" with the "upsert" flag (insert or update).

Specified by:

createOrUpdate in interface DocumentStore

Parameters:

collection - the collection

update - the update operation

Returns:

the old document

Throws:

org.apache.jackrabbit.mk.api.MicroKernelException - if the operation failed.

findAndUpdate

public Map<String,Object> findAndUpdate(DocumentStore.Collection collection,
                               UpdateOp update)
                                 throws org.apache.jackrabbit.mk.api.MicroKernelException

Description copied from interface: DocumentStore

Performs a conditional update (e.g. using UpdateOp.Operation.Type.CONTAINS_MAP_ENTRY and only updates the document if the condition is true.

Specified by:

findAndUpdate in interface DocumentStore

Parameters:

collection - the collection

update - the update operation with the condition

Returns:

the old document or null if the condition is not met.

Throws:

org.apache.jackrabbit.mk.api.MicroKernelException - if the operation failed.

create

public boolean create(DocumentStore.Collection collection,
             List<UpdateOp> updateOps)

Description copied from interface: DocumentStore

Try to create a list of documents.

Specified by:

create in interface DocumentStore

Parameters:

collection - the collection

updateOps - the list of documents to add

Returns:

true if this worked (if none of the documents already existed)

dispose

public void dispose()

Description copied from interface: DocumentStore

Dispose this instance.

Specified by:

dispose in interface DocumentStore

isCached

public boolean isCached(DocumentStore.Collection collection,
               String key)

Description copied from interface: DocumentStore

Check whether the given document is in the cache.

Specified by:

isCached in interface DocumentStore

Parameters:

collection - the collection

key - the key

Returns:

true if yes