org.apache.jackrabbit.mongomk.api

Interface NodeStore

All Known Implementing Classes:

MongoNodeStore

public interface NodeStore

The NodeStore interface deals with all node related operations of the MicroKernel.

Since binary storage and node storage most likely use different back-end technologies two separate interfaces for these operations are provided.

This interface is not only a partly MicroKernel but also provides a different layer of abstraction by converting the String parameters into higher level objects to ease the development for implementors of the MicroKernel.

See Also:

BlobStore}

Method Summary

Methods

Modifier and Type	Method and Description
String	commit(Commit commit)
String	diff(String fromRevisionId, String toRevisionId, String path, int depth)
String	getHeadRevision()
String	getJournal(String fromRevisionId, String toRevisionId, String path)
Node	getNodes(String path, String revisionId, int depth, long offset, int maxChildNodes, String filter)
String	getRevisionHistory(long since, int maxEntries, String path)
String	merge(String branchRevisionId, String message)
boolean	nodeExists(String path, String revisionId)
String	waitForCommit(String oldHeadRevisionId, long timeout)

Method Detail

commit

String commit(Commit commit)
              throws Exception

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

String diff(String fromRevisionId,
          String toRevisionId,
          String path,
          int depth)
            throws Exception

Parameters:

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

toRevisionId - 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

String getHeadRevision()
                       throws Exception

Returns:

The revision id of the head revision.

Throws:

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

See Also:

MicroKernel.getHeadRevision()

getJournal

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

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

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

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)

getNodes

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

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

String merge(String branchRevisionId,
           String message)
             throws Exception

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

boolean nodeExists(String path,
                 String revisionId)
                   throws Exception

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)

waitForCommit

String waitForCommit(String oldHeadRevisionId,
                   long timeout)
                     throws Exception

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)