public interface NodeStore
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.
BlobStore}| 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) |
String diff(String fromRevisionId, String toRevisionId, String path, int depth) throws Exception
fromRevisionId - a revision id, if null the current head revision is assumedtoRevisionId - another revision id, if null the current head revision is assumedpath - optional path filter; if null or "".
The default ("/") will be assumed, i.e. no filter will be applieddepth - Depth limit; if -1 no limit will be appliedorg.apache.jackrabbit.mk.api.MicroKernelException - if any of the specified revisions doesn't exist or if another error occursExceptionMicroKernel.diff(String, String, String, int)String getHeadRevision() throws Exception
Exception - If an error occurred while retrieving the head revision.MicroKernel.getHeadRevision()String getJournal(String fromRevisionId, String toRevisionId, String path) throws Exception
fromRevisionId - id of first revision to be returned in journaltoRevisionId - id of last revision to be returned in journal,
if null the current head revision is assumedpath - optional path filter; if null or ""
the default ("/") will be assumed, i.e. no filter will be appliedException - if an error occurred while getting the journal.MicroKernel.getJournal(String, String, String)String getRevisionHistory(long since, int maxEntries, String path) throws Exception
since - timestamp (ms) of earliest revision to be returnedmaxEntries - 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 appliedException - if an error occurred while getting the revision history.MicroKernel.getRevisionHistory(long, int, String)Node getNodes(String path, String revisionId, int depth, long offset, int maxChildNodes, String filter) throws Exception
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.Node of the root node.Exception - If an error occurred while retrieving the nodes.MicroKernel.getNodes(String, String, int, long, int, String)String merge(String branchRevisionId, String message) throws Exception
branchRevisionId - Branch revision id to merge.message - Merge message.Exception - If an error occurred while merging.MicroKernel.merge(String, String)boolean nodeExists(String path, String revisionId) throws Exception
path - The path of the node to test.revisionId - The revision id of the node or null for the head revision.true if the node for the specific revision exists else false.Exception - If an error occurred while testing the node.MicroKernel.nodeExists(String, String)String waitForCommit(String oldHeadRevisionId, long timeout) throws Exception
oldHeadRevisionId - id of earlier head revisiontimeout - the maximum time to wait in millisecondsException - if an error occurred while waiting.MicroKernel.waitForCommit(String, long)Copyright © 2012-2013 The Apache Software Foundation. All Rights Reserved.