org.apache.jackrabbit.mongomk.impl

Class MongoNodeStore

java.lang.Object

org.apache.jackrabbit.mongomk.impl.MongoNodeStore

All Implemented Interfaces:

NodeStore

public class MongoNodeStore
extends Object
implements NodeStore

Implementation of NodeStore for the MongoDB.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLLECTION_COMMITS
static String	COLLECTION_NODES
static String	COLLECTION_SYNC
static String	INITIAL_COMMIT_DIFF
static String	INITIAL_COMMIT_MESSAGE
static String	INITIAL_COMMIT_PATH

Constructor Summary

Constructors

Constructor and Description
MongoNodeStore(com.mongodb.DB db) Constructs a new NodeStoreMongo.

Method Summary

Methods

Modifier and Type	Method and Description
void	cache(Commit commit) Caches the commit.
void	cache(MongoNode node) Caches the node.
String	commit(Commit commit)
String	diff(String fromRevision, String toRevision, String path, int depth)
void	evict(MongoCommit commit) Evicts the commit from the commitCache.
com.mongodb.DBCollection	getCommitCollection() Returns the commit DBCollection.
MongoCommit	getFromCache(long revisionId) Returns the commit from the cache or null if the commit is not in the cache.
MongoNode	getFromCache(String path, String branchId, long revisionId) Returns the node from the cache or null if the node is not in the cache.
String	getHeadRevision()
String	getJournal(String fromRevisionId, String toRevisionId, String path)
com.mongodb.DBCollection	getNodeCollection() Returns the node DBCollection.
Node	getNodes(String path, String revisionId, int depth, long offset, int maxChildNodes, String filter)
String	getRevisionHistory(long since, int maxEntries, String path)
com.mongodb.DBCollection	getSyncCollection() Returns the sync DBCollection.
String	merge(String branchRevisionId, String message)
boolean	nodeExists(String path, String revisionId)
String	waitForCommit(String oldHeadRevisionId, long timeout)

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL_COMMIT_MESSAGE

public static final String INITIAL_COMMIT_MESSAGE

See Also:

Constant Field Values

INITIAL_COMMIT_PATH

public static final String INITIAL_COMMIT_PATH

See Also:

Constant Field Values

INITIAL_COMMIT_DIFF

public static final String INITIAL_COMMIT_DIFF

See Also:

Constant Field Values

COLLECTION_COMMITS

public static final String COLLECTION_COMMITS

See Also:

Constant Field Values

COLLECTION_NODES

public static final String COLLECTION_NODES

See Also:

Constant Field Values

COLLECTION_SYNC

public static final String COLLECTION_SYNC

See Also:

Constant Field Values

Constructor Detail

MongoNodeStore

public MongoNodeStore(com.mongodb.DB db)

Constructs a new NodeStoreMongo.

Parameters:

db - Mongo DB.

Method Detail

commit

public String commit(Commit commit)
              throws Exception

Specified by:

commit in interface NodeStore

Parameters:

commit - The Commit object to store in the back-end.

Returns:

The revision id of this commit.

Throws:

Exception - If an error occurred while committing.

See Also:

MicroKernel.commit(String, String, String, String)

diff

public String diff(String fromRevision,
          String toRevision,
          String path,
          int depth)
            throws Exception

Specified by:

diff in interface NodeStore

Parameters:

fromRevision - a revision id, if null the current head revision is assumed

toRevision - another revision id, if null the current head revision is assumed

path - optional path filter; if null or "". The default ("/") will be assumed, i.e. no filter will be applied

depth - Depth limit; if -1 no limit will be applied

Returns:

JSON diff representation of the changes

Throws:

org.apache.jackrabbit.mk.api.MicroKernelException - if any of the specified revisions doesn't exist or if another error occurs

Exception

See Also:

MicroKernel.diff(String, String, String, int)

getHeadRevision

public String getHeadRevision()
                       throws Exception

Specified by:

getHeadRevision in interface NodeStore

Returns:

The revision id of the head revision.

Throws:

Exception - If an error occurred while retrieving the head revision.

See Also:

MicroKernel.getHeadRevision()

getNodes

public Node getNodes(String path,
            String revisionId,
            int depth,
            long offset,
            int maxChildNodes,
            String filter)
              throws Exception

Specified by:

getNodes in interface NodeStore

Parameters:

path - The path of the root of nodes to retrieve.

revisionId - The revision id of the nodes or null if the latest head revision should be retrieved.

depth - The maximum depth of the retrieved node tree or -1 to retrieve all nodes.

offset - The offset of the child list to retrieve.

maxChildNodes - The count of children to retrieve or -1 to retrieve all children.

filter - An optional filter for the retrieved nodes.

Returns:

The Node of the root node.

Throws:

Exception - If an error occurred while retrieving the nodes.

See Also:

MicroKernel.getNodes(String, String, int, long, int, String)

merge

public String merge(String branchRevisionId,
           String message)
             throws Exception

Specified by:

merge in interface NodeStore

Parameters:

branchRevisionId - Branch revision id to merge.

message - Merge message.

Returns:

The revision id after merge.

Throws:

Exception - If an error occurred while merging.

See Also:

MicroKernel.merge(String, String)

nodeExists

public boolean nodeExists(String path,
                 String revisionId)
                   throws Exception

Specified by:

nodeExists in interface NodeStore

Parameters:

path - The path of the node to test.

revisionId - The revision id of the node or null for the head revision.

Returns:

true if the node for the specific revision exists else false.

Throws:

Exception - If an error occurred while testing the node.

See Also:

MicroKernel.nodeExists(String, String)

getJournal

public String getJournal(String fromRevisionId,
                String toRevisionId,
                String path)
                  throws Exception

Specified by:

getJournal in interface NodeStore

Parameters:

fromRevisionId - id of first revision to be returned in journal

toRevisionId - id of last revision to be returned in journal, if null the current head revision is assumed

path - optional path filter; if null or "" the default ("/") will be assumed, i.e. no filter will be applied

Returns:

a chronological list of revisions in JSON format

Throws:

Exception - if an error occurred while getting the journal.

See Also:

MicroKernel.getJournal(String, String, String)

getRevisionHistory

public String getRevisionHistory(long since,
                        int maxEntries,
                        String path)
                          throws Exception

Specified by:

getRevisionHistory in interface NodeStore

Parameters:

since - timestamp (ms) of earliest revision to be returned

maxEntries - maximum #entries to be returned; if < 0, no limit will be applied.

path - optional path filter; if null or "" the default ("/") will be assumed, i.e. no filter will be applied

Returns:

a list of revisions in chronological order in JSON format.

Throws:

Exception - if an error occurred while getting the revision history.

See Also:

MicroKernel.getRevisionHistory(long, int, String)

waitForCommit

public String waitForCommit(String oldHeadRevisionId,
                   long timeout)
                     throws Exception

Specified by:

waitForCommit in interface NodeStore

Parameters:

oldHeadRevisionId - id of earlier head revision

timeout - the maximum time to wait in milliseconds

Returns:

the id of the head revision

Throws:

Exception - if an error occurred while waiting.

See Also:

MicroKernel.waitForCommit(String, long)

getCommitCollection

public com.mongodb.DBCollection getCommitCollection()

Returns the commit DBCollection.

Returns:

The commit DBCollection.

getSyncCollection

public com.mongodb.DBCollection getSyncCollection()

Returns the sync DBCollection.

Returns:

The sync DBCollection.

getNodeCollection

public com.mongodb.DBCollection getNodeCollection()

Returns the node DBCollection.

Returns:

The node DBCollection.

cache

public void cache(Commit commit)

Caches the commit.

Parameters:

commit - Commit to cache.

evict

public void evict(MongoCommit commit)

Evicts the commit from the commitCache.

Parameters:

commit - the commit.

getFromCache

public MongoCommit getFromCache(long revisionId)

Returns the commit from the cache or null if the commit is not in the cache.

Parameters:

revisionId - Commit revision id.

Returns:

Commit from cache or null if commit is not in the cache.

cache

public void cache(MongoNode node)

Caches the node.

Parameters:

node - Node to cache.

getFromCache

public MongoNode getFromCache(String path,
                     String branchId,
                     long revisionId)

Returns the node from the cache or null if the node is not in the cache.

Parameters:

path - Path

branchId - Branch id

revisionId - Revision id

Returns: