|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RemoteNode
Remote version of the JCR Node
interface.
Used by the ServerNode
and ClientNode
adapters to provide transparent RMI access to remote nodes.
The methods in this interface are documented only with a reference to a corresponding Node method. The remote object will simply forward the method call to the underlying Node instance. Argument and return values, as well as possible exceptions, are copied over the network. Complex return values (like Nodes and Properties) are returned as remote references to the corresponding remote interfaces. Iterator values are transmitted as object arrays. RMI errors are signaled with RemoteExceptions.
Note that only two generic setProperty methods are included in this
interface. Clients should implement the type-specific setProperty
methods by wrapping the argument values into generic Value objects
and calling the generic setProperty methods. Note also that the
Value objects must be serializable and implemented using classes
available on both the client and server side. The
SerialValueFactory
class provides two convenience methods to satisfy these requirements.
Node
,
ClientNode
,
ServerNode
Method Summary | |
---|---|
void |
addMixin(String name)
Remote version of the Node.addMixin(String) method. |
RemoteNode |
addNode(String path)
Remote version of the Node.addNode(Sring) method. |
RemoteNode |
addNode(String path,
String type)
Remote version of the Node.addNode(String,String)
method. |
boolean |
canAddMixin(String name)
Remote version of the Node.canAddMixin(String)
method. |
void |
cancelMerge(String versionUUID)
Remote version of the Node.cancelMerge(Version)
method. |
RemoteVersion |
checkin()
Remote version of the Node.checkin() method. |
void |
checkout()
Remote version of the Node.checkout() method. |
void |
doneMerge(String versionUUID)
Remote version of the Node.doneMerge(Version)
method. |
RemoteVersion |
getBaseVersion()
Remote version of the Node.getBaseVersion() method. |
String |
getCorrespondingNodePath(String workspace)
Remote version of the Node.getCorrespondingNodePath(String)
method. |
RemoteNodeDefinition |
getDefinition()
Remote version of the Node.getDefinition() method. |
String |
getIdentifier()
Remote version of the Node.getIdentifier() method. |
int |
getIndex()
Remote version of the Node.getIndex() method. |
RemoteLock |
getLock()
Remote version of the Node.getLock() method. |
RemoteNodeType[] |
getMixinNodeTypes()
Remote version of the Node.getMixinNodeTypes()
method. |
RemoteNode |
getNode(String path)
Remote version of the Node.getNode(String) method. |
RemoteIterator |
getNodes()
Remote version of the Node.getNodes() method. |
RemoteIterator |
getNodes(String pattern)
Remote version of the Node.getNodes(String) method. |
RemoteIterator |
getNodes(String[] globs)
Remote version of the Node.getNodes(String[]) method. |
RemoteItem |
getPrimaryItem()
Remote version of the Node.getPrimaryItem() method. |
RemoteNodeType |
getPrimaryNodeType()
Remote version of the Node.getPrimaryNodeType()
method. |
RemoteIterator |
getProperties()
Remote version of the Node.getProperties() method. |
RemoteIterator |
getProperties(String pattern)
Remote version of the Node.getProperties(String)
method. |
RemoteIterator |
getProperties(String[] globs)
Remote version of the Node.getProperties(String[])
method. |
RemoteProperty |
getProperty(String path)
Remote version of the Node.getProperty(String)
method. |
RemoteIterator |
getReferences()
Remote version of the Node.getReferences() method. |
RemoteIterator |
getReferences(String name)
Remote version of the Node.getReferences(String) method. |
String |
getUUID()
Remote version of the Node.getUUID() method. |
RemoteVersionHistory |
getVersionHistory()
Remote version of the Node.getVersionHistory() method. |
boolean |
hasNode(String path)
Remote version of the Node.hasNode(String) method. |
boolean |
hasNodes()
Remote version of the Node.hasNodes() method. |
boolean |
hasProperties()
Remote version of the Node.hasProperties() method. |
boolean |
hasProperty(String path)
Remote version of the Node.hasProperty() method. |
boolean |
holdsLock()
Remote version of the Node.holdsLock() method. |
boolean |
isCheckedOut()
Remote version of the Node.isCheckedOut() method. |
boolean |
isLocked()
Remote version of the Node.isLocked() method. |
boolean |
isNodeType(String type)
Remote version of the Node.isNodeType(String) method. |
RemoteLock |
lock(boolean isDeep,
boolean isSessionScoped)
Remote version of the Node.lock(boolean,boolean)
method. |
RemoteIterator |
merge(String workspace,
boolean bestEffort)
Remote version of the Node.merge(String,boolean)
method. |
void |
orderBefore(String src,
String dst)
Remote version of the Node.orderBefore(String,String)
method. |
void |
removeMixin(String name)
Remote version of the Node.removeMixin(String)
method. |
void |
restore(String version,
boolean removeExisting)
Remote version of the Node.restore(String,boolean)
method. |
void |
restore(String versionUUID,
String path,
boolean removeExisting)
Remote version of the Node.restore(Version,String,boolean)
method. |
void |
restoreByLabel(String label,
boolean removeExisting)
Remote version of the Node.restoreByLabel(String,boolean)
method. |
void |
restoreByUUID(String versionUUID,
boolean removeExisting)
Remote version of the Node.restore(Version,boolean)
method. |
RemoteProperty |
setProperty(String name,
Value value)
Remote version of the Node.setProperty(String,Value)
method. |
RemoteProperty |
setProperty(String name,
Value[] values)
Remote version of the Node.setProperty(String,Value[])
method. |
RemoteProperty |
setProperty(String name,
Value[] values,
int type)
Remote version of the Node.setProperty(String,Value[],int)
method. |
RemoteProperty |
setProperty(String name,
Value value,
int type)
Remote version of the Node.setProperty(String,Value)
method. |
void |
unlock()
Remote version of the Node.unlock() method. |
void |
update(String workspace)
Remote version of the Node.update(String) method. |
Methods inherited from interface org.apache.jackrabbit.rmi.remote.RemoteItem |
---|
getAncestor, getDepth, getName, getParent, getPath, isModified, isNew, refresh, remove, save |
Method Detail |
---|
RemoteNode addNode(String path) throws RepositoryException, RemoteException
Node.addNode(Sring)
method.
path
- relative path
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteNode addNode(String path, String type) throws RepositoryException, RemoteException
Node.addNode(String,String)
method.
path
- relative pathtype
- node type name
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteProperty getProperty(String path) throws RepositoryException, RemoteException
Node.getProperty(String)
method.
path
- relative path
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteIterator getProperties() throws RepositoryException, RemoteException
Node.getProperties()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteIterator getProperties(String pattern) throws RepositoryException, RemoteException
Node.getProperties(String)
method.
pattern
- property name pattern
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteIterator getProperties(String[] globs) throws RepositoryException, RemoteException
Node.getProperties(String[])
method.
globs
- property name globs
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteItem getPrimaryItem() throws RepositoryException, RemoteException
Node.getPrimaryItem()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsString getIdentifier() throws RepositoryException, RemoteException
Node.getIdentifier()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsString getUUID() throws RepositoryException, RemoteException
Node.getUUID()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteIterator getReferences() throws RepositoryException, RemoteException
Node.getReferences()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteIterator getReferences(String name) throws RepositoryException, RemoteException
Node.getReferences(String)
method.
name
- reference property name
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteIterator getNodes() throws RepositoryException, RemoteException
Node.getNodes()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteIterator getNodes(String pattern) throws RepositoryException, RemoteException
Node.getNodes(String)
method.
pattern
- node name pattern
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteIterator getNodes(String[] globs) throws RepositoryException, RemoteException
Node.getNodes(String[])
method.
globs
- node name globs
RepositoryException
- on repository errors
RemoteException
- on RMI errorsboolean hasNode(String path) throws RepositoryException, RemoteException
Node.hasNode(String)
method.
path
- relative path
true
if the identified node exists,
false
otherwise
RepositoryException
- on repository errors
RemoteException
- on RMI errorsboolean hasProperty(String path) throws RepositoryException, RemoteException
Node.hasProperty()
method.
path
- relative path
true
if the identified property exists,
false
otherwise
RepositoryException
- on repository errors
RemoteException
- on RMI errorsboolean hasNodes() throws RepositoryException, RemoteException
Node.hasNodes()
method.
true
if this node has child nodes,
false
otherwise
RepositoryException
- on repository errors
RemoteException
- on RMI errorsboolean hasProperties() throws RepositoryException, RemoteException
Node.hasProperties()
method.
true
if this node has properties,
false
otherwise
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteNodeType getPrimaryNodeType() throws RepositoryException, RemoteException
Node.getPrimaryNodeType()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteNodeType[] getMixinNodeTypes() throws RepositoryException, RemoteException
Node.getMixinNodeTypes()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsboolean isNodeType(String type) throws RepositoryException, RemoteException
Node.isNodeType(String)
method.
type
- node type name
true
if this node is an instance of the
identified type, false
otherwise
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteNode getNode(String path) throws RepositoryException, RemoteException
Node.getNode(String)
method.
path
- relative path
RepositoryException
- on repository errors
RemoteException
- on RMI errorsvoid orderBefore(String src, String dst) throws RepositoryException, RemoteException
Node.orderBefore(String,String)
method.
src
- source pathdst
- destination path
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteProperty setProperty(String name, Value value) throws RepositoryException, RemoteException
Node.setProperty(String,Value)
method.
name
- property namevalue
- property value
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteProperty setProperty(String name, Value value, int type) throws RepositoryException, RemoteException
Node.setProperty(String,Value)
method.
name
- property namevalue
- property valuetype
- property type
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteProperty setProperty(String name, Value[] values) throws RepositoryException, RemoteException
Node.setProperty(String,Value[])
method.
name
- property namevalues
- property values
RepositoryException
- on repository errors
RemoteException
- on RMI errorsvoid addMixin(String name) throws RepositoryException, RemoteException
Node.addMixin(String)
method.
name
- mixin type name
RepositoryException
- on repository errors
RemoteException
- on RMI errorsvoid removeMixin(String name) throws RepositoryException, RemoteException
Node.removeMixin(String)
method.
name
- mixin type name
RepositoryException
- on repository errors
RemoteException
- on RMI errorsboolean canAddMixin(String name) throws RepositoryException, RemoteException
Node.canAddMixin(String)
method.
name
- mixin type name
true
if the mixin type can be added,
false
otherwise
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteNodeDefinition getDefinition() throws RepositoryException, RemoteException
Node.getDefinition()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteVersion checkin() throws RepositoryException, RemoteException
Node.checkin()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsvoid checkout() throws RepositoryException, RemoteException
Node.checkout()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsvoid update(String workspace) throws RepositoryException, RemoteException
Node.update(String)
method.
workspace
- source workspace name
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteIterator merge(String workspace, boolean bestEffort) throws RepositoryException, RemoteException
Node.merge(String,boolean)
method.
workspace
- source workspace namebestEffort
- best effort flag
RepositoryException
- on repository errors
RemoteException
- on RMI errorsvoid cancelMerge(String versionUUID) throws RepositoryException, RemoteException
Node.cancelMerge(Version)
method.
versionUUID
- The UUID of the version whose labels are to be returned.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsvoid doneMerge(String versionUUID) throws RepositoryException, RemoteException
Node.doneMerge(Version)
method.
versionUUID
- The UUID of the version whose labels are to be returned.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsString getCorrespondingNodePath(String workspace) throws RepositoryException, RemoteException
Node.getCorrespondingNodePath(String)
method.
workspace
- workspace name
RepositoryException
- on repository errors
RemoteException
- on RMI errorsint getIndex() throws RepositoryException, RemoteException
Node.getIndex()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsvoid restore(String version, boolean removeExisting) throws RepositoryException, RemoteException
Node.restore(String,boolean)
method.
version
- version nameremoveExisting
- flag to remove conflicting nodes
RepositoryException
- on repository errors
RemoteException
- on RMI errorsvoid restoreByUUID(String versionUUID, boolean removeExisting) throws RepositoryException, RemoteException
Node.restore(Version,boolean)
method.
This method has been rename to prevent a naming clash with
restore(String, boolean)
.
versionUUID
- The UUID of the version whose labels are to be returned.removeExisting
- flag to remove conflicting nodes
RepositoryException
- on repository errors
RemoteException
- on RMI errorsvoid restore(String versionUUID, String path, boolean removeExisting) throws RepositoryException, RemoteException
Node.restore(Version,String,boolean)
method.
versionUUID
- The UUID of the version whose labels are to be returned.path
- the path to which the version is to be restoredremoveExisting
- flag to remove conflicting nodes
RepositoryException
- on repository errors
RemoteException
- on RMI errorsvoid restoreByLabel(String label, boolean removeExisting) throws RepositoryException, RemoteException
Node.restoreByLabel(String,boolean)
method.
label
- version labelremoveExisting
- flag to remove conflicting nodes
RepositoryException
- on repository errors
RemoteException
- on RMI errorsvoid unlock() throws RepositoryException, RemoteException
Node.unlock()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsboolean holdsLock() throws RepositoryException, RemoteException
Node.holdsLock()
method.
true
if this node holds a lock,
false
otherwise
RepositoryException
- on repository errors
RemoteException
- on RMI errorsboolean isLocked() throws RepositoryException, RemoteException
Node.isLocked()
method.
true
if this node is locked,
false
otherwise
RepositoryException
- on repository errors
RemoteException
- on RMI errorsboolean isCheckedOut() throws RepositoryException, RemoteException
Node.isCheckedOut()
method.
true
if this node is checked out,
false
otherwise
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteVersionHistory getVersionHistory() throws RepositoryException, RemoteException
Node.getVersionHistory()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteVersion getBaseVersion() throws RepositoryException, RemoteException
Node.getBaseVersion()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteProperty setProperty(String name, Value[] values, int type) throws RepositoryException, RemoteException
Node.setProperty(String,Value[],int)
method.
name
- property namevalues
- property valuestype
- property type
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteLock lock(boolean isDeep, boolean isSessionScoped) throws RepositoryException, RemoteException
Node.lock(boolean,boolean)
method.
isDeep
- flag to create a deep lockisSessionScoped
- flag to create a session-scoped lock
RepositoryException
- on repository errors
RemoteException
- on RMI errorsRemoteLock getLock() throws RepositoryException, RemoteException
Node.getLock()
method.
RepositoryException
- on repository errors
RemoteException
- on RMI errors
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |