public interface RemoteNode extends RemoteItem
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
getAncestor, getDepth, getName, getParent, getPath, isModified, isNew, refresh, remove, save
RemoteNode addNode(String path) throws RepositoryException, RemoteException
Node.addNode(Sring)
method.path
- relative pathRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteNode addNode(String path, String type) throws RepositoryException, RemoteException
Node.addNode(String,String)
method.path
- relative pathtype
- node type nameRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteProperty getProperty(String path) throws RepositoryException, RemoteException
Node.getProperty(String)
method.path
- relative pathRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteIterator getProperties() throws RepositoryException, RemoteException
Node.getProperties()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteIterator getProperties(String pattern) throws RepositoryException, RemoteException
Node.getProperties(String)
method.pattern
- property name patternRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteIterator getProperties(String[] globs) throws RepositoryException, RemoteException
Node.getProperties(String[])
method.globs
- property name globsRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteItem getPrimaryItem() throws RepositoryException, RemoteException
Node.getPrimaryItem()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsString getIdentifier() throws RepositoryException, RemoteException
Node.getIdentifier()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsString getUUID() throws RepositoryException, RemoteException
Node.getUUID()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteIterator getReferences() throws RepositoryException, RemoteException
Node.getReferences()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteIterator getReferences(String name) throws RepositoryException, RemoteException
Node.getReferences(String)
method.name
- reference property nameRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteIterator getNodes() throws RepositoryException, RemoteException
Node.getNodes()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteIterator getNodes(String pattern) throws RepositoryException, RemoteException
Node.getNodes(String)
method.pattern
- node name patternRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteIterator getNodes(String[] globs) throws RepositoryException, RemoteException
Node.getNodes(String[])
method.globs
- node name globsRepositoryException
- on repository errorsRemoteException
- on RMI errorsboolean hasNode(String path) throws RepositoryException, RemoteException
Node.hasNode(String)
method.path
- relative pathtrue
if the identified node exists,
false
otherwiseRepositoryException
- on repository errorsRemoteException
- on RMI errorsboolean hasProperty(String path) throws RepositoryException, RemoteException
Node.hasProperty()
method.path
- relative pathtrue
if the identified property exists,
false
otherwiseRepositoryException
- on repository errorsRemoteException
- on RMI errorsboolean hasNodes() throws RepositoryException, RemoteException
Node.hasNodes()
method.true
if this node has child nodes,
false
otherwiseRepositoryException
- on repository errorsRemoteException
- on RMI errorsboolean hasProperties() throws RepositoryException, RemoteException
Node.hasProperties()
method.true
if this node has properties,
false
otherwiseRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteNodeType getPrimaryNodeType() throws RepositoryException, RemoteException
Node.getPrimaryNodeType()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteNodeType[] getMixinNodeTypes() throws RepositoryException, RemoteException
Node.getMixinNodeTypes()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsboolean isNodeType(String type) throws RepositoryException, RemoteException
Node.isNodeType(String)
method.type
- node type nametrue
if this node is an instance of the
identified type, false
otherwiseRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteNode getNode(String path) throws RepositoryException, RemoteException
Node.getNode(String)
method.path
- relative pathRepositoryException
- on repository errorsRemoteException
- on RMI errorsvoid orderBefore(String src, String dst) throws RepositoryException, RemoteException
Node.orderBefore(String,String)
method.src
- source pathdst
- destination pathRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteProperty setProperty(String name, Value value) throws RepositoryException, RemoteException
Node.setProperty(String,Value)
method.name
- property namevalue
- property valueRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteProperty setProperty(String name, Value value, int type) throws RepositoryException, RemoteException
Node.setProperty(String,Value)
method.name
- property namevalue
- property valuetype
- property typeRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteProperty setProperty(String name, Value[] values) throws RepositoryException, RemoteException
Node.setProperty(String,Value[])
method.name
- property namevalues
- property valuesRepositoryException
- on repository errorsRemoteException
- on RMI errorsvoid addMixin(String name) throws RepositoryException, RemoteException
Node.addMixin(String)
method.name
- mixin type nameRepositoryException
- on repository errorsRemoteException
- on RMI errorsvoid removeMixin(String name) throws RepositoryException, RemoteException
Node.removeMixin(String)
method.name
- mixin type nameRepositoryException
- on repository errorsRemoteException
- on RMI errorsboolean canAddMixin(String name) throws RepositoryException, RemoteException
Node.canAddMixin(String)
method.name
- mixin type nametrue
if the mixin type can be added,
false
otherwiseRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteNodeDefinition getDefinition() throws RepositoryException, RemoteException
Node.getDefinition()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteVersion checkin() throws RepositoryException, RemoteException
Node.checkin()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsvoid checkout() throws RepositoryException, RemoteException
Node.checkout()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsvoid update(String workspace) throws RepositoryException, RemoteException
Node.update(String)
method.workspace
- source workspace nameRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteIterator merge(String workspace, boolean bestEffort) throws RepositoryException, RemoteException
Node.merge(String,boolean)
method.workspace
- source workspace namebestEffort
- best effort flagRepositoryException
- on repository errorsRemoteException
- 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 errorsRemoteException
- 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 errorsRemoteException
- on RMI errorsString getCorrespondingNodePath(String workspace) throws RepositoryException, RemoteException
Node.getCorrespondingNodePath(String)
method.workspace
- workspace nameRepositoryException
- on repository errorsRemoteException
- on RMI errorsint getIndex() throws RepositoryException, RemoteException
Node.getIndex()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsvoid restore(String version, boolean removeExisting) throws RepositoryException, RemoteException
Node.restore(String,boolean)
method.version
- version nameremoveExisting
- flag to remove conflicting nodesRepositoryException
- on repository errorsRemoteException
- 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 nodesRepositoryException
- on repository errorsRemoteException
- 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 nodesRepositoryException
- on repository errorsRemoteException
- on RMI errorsvoid restoreByLabel(String label, boolean removeExisting) throws RepositoryException, RemoteException
Node.restoreByLabel(String,boolean)
method.label
- version labelremoveExisting
- flag to remove conflicting nodesRepositoryException
- on repository errorsRemoteException
- on RMI errorsvoid unlock() throws RepositoryException, RemoteException
Node.unlock()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsboolean holdsLock() throws RepositoryException, RemoteException
Node.holdsLock()
method.true
if this node holds a lock,
false
otherwiseRepositoryException
- on repository errorsRemoteException
- on RMI errorsboolean isLocked() throws RepositoryException, RemoteException
Node.isLocked()
method.true
if this node is locked,
false
otherwiseRepositoryException
- on repository errorsRemoteException
- on RMI errorsboolean isCheckedOut() throws RepositoryException, RemoteException
Node.isCheckedOut()
method.true
if this node is checked out,
false
otherwiseRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteVersionHistory getVersionHistory() throws RepositoryException, RemoteException
Node.getVersionHistory()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteVersion getBaseVersion() throws RepositoryException, RemoteException
Node.getBaseVersion()
method.RepositoryException
- on repository errorsRemoteException
- 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 typeRepositoryException
- on repository errorsRemoteException
- 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 lockRepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteLock getLock() throws RepositoryException, RemoteException
Node.getLock()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteIterator getSharedSet() throws RepositoryException, RemoteException
Node.getSharedSet()
method.NodeIterator
.RepositoryException
- on repository errorsRemoteException
- on RMI errorsvoid followLifecycleTransition(String transition) throws RepositoryException, RemoteException
Node.followLifecycleTransition(String)
method.transition
- a state transitionRepositoryException
- on repository errorsRemoteException
- on RMI errorsString[] getAllowedLifecycleTransistions() throws RepositoryException, RemoteException
Node.getAllowedLifecycleTransistions()
method.String
array.RepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteIterator getWeakReferences() throws RepositoryException, RemoteException
Node.getWeakReferences()
method.PropertyIterator
.RepositoryException
- on repository errorsRemoteException
- on RMI errorsRemoteIterator getWeakReferences(String name) throws RepositoryException, RemoteException
Node.getWeakReferences(String)
method.name
- name of referring WEAKREFERENCE
properties to be
returned; if null
then all referring
WEAKREFERENCE
s are returned.PropertyIterator
.RepositoryException
- on repository errorsRemoteException
- on RMI errorsvoid removeShare() throws RepositoryException, RemoteException
Node.removeShare()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsvoid removeSharedSet() throws RepositoryException, RemoteException
Node.removeSharedSet()
method.RepositoryException
- on repository errorsRemoteException
- on RMI errorsvoid setPrimaryType(String nodeTypeName) throws RepositoryException, RemoteException
Node.setPrimaryType(String)
method.nodeTypeName
- the node type nameRepositoryException
- on repository errorsRemoteException
- on RMI errorsCopyright © 2004–2021 The Apache Software Foundation. All rights reserved.