org.exoplatform.services.jcr.rmi.api.remote
Interface RemoteWorkspace

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

ServerWorkspace

public interface RemoteWorkspace
extends java.rmi.Remote

Remote version of the JCR Workspace interface. Used by the ServerWorkspace and ClientWorkspace adapters to provide transparent RMI access to remote workspaces.

Most of the methods in this interface are documented only with a reference to a corresponding Workspace method. In these cases the remote object will simply forward the method call to the underlying Workspace instance. Complex return values like namespace registries and other objects are returned as remote references to the corresponding remote interface. Simple return values and possible exceptions are copied over the network to the client. RMI errors are signalled with RemoteExceptions.

See Also:

Workspace, ClientWorkspace, ServerWorkspace

Method Summary

void	clone(java.lang.String workspace, java.lang.String from, java.lang.String to, boolean removeExisting) Remote version of the Workspace.clone(String,String,String,boolean) method.
void	copy(java.lang.String from, java.lang.String to) Remote version of the Workspace.copy(String,String) method.
void	copy(java.lang.String workspace, java.lang.String from, java.lang.String to) Remote version of the Workspace.copy(String,String,String) method.
java.lang.String[]	getAccessibleWorkspaceNames() Remote version of the Workspace.getAccessibleWorkspaceNames() method.
java.lang.String	getName() Remote version of the Workspace.getName() method.
RemoteNamespaceRegistry	getNamespaceRegistry() Remote version of the Workspace.getNamespaceRegistry() method.
RemoteNodeTypeManager	getNodeTypeManager() Remote version of the Workspace.getNodeTypeManager() method.
RemoteObservationManager	getObservationManager() Remote version of the Workspace.getObservationManager() method.
RemoteQueryManager	getQueryManager() Remote version of the Workspace.getQueryManager() method.
void	importXML(java.lang.String path, byte[] xml, int uuidBehaviour) Remote version of the Workspace.importXML(String,InputStream,int) method.
void	move(java.lang.String from, java.lang.String to) Remote version of the Workspace.move(String,String) method.
void	restore(java.lang.String[] versionUuids, boolean removeExisting) * Remote version of the Workspace.restore(String[] versionuuids, boolean removeExisting) method.

Method Detail

getName

java.lang.String getName()
                         throws java.rmi.RemoteException

Remote version of the Workspace.getName() method.

Returns:

workspace name

Throws:

java.rmi.RemoteException - on RMI errors

copy

void copy(java.lang.String from,
          java.lang.String to)
          throws javax.jcr.RepositoryException,
                 java.rmi.RemoteException

Remote version of the Workspace.copy(String,String) method.

Parameters:

from - source path

to - destination path

Throws:

javax.jcr.RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

copy

void copy(java.lang.String workspace,
          java.lang.String from,
          java.lang.String to)
          throws javax.jcr.RepositoryException,
                 java.rmi.RemoteException

Remote version of the Workspace.copy(String,String,String) method.

Parameters:

workspace - source workspace

from - source path

to - destination path

Throws:

javax.jcr.RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

clone

void clone(java.lang.String workspace,
           java.lang.String from,
           java.lang.String to,
           boolean removeExisting)
           throws javax.jcr.RepositoryException,
                  java.rmi.RemoteException

Remote version of the Workspace.clone(String,String,String,boolean) method.

Parameters:

workspace - source workspace

from - source path

to - destination path

removeExisting - flag to remove existing items

Throws:

javax.jcr.RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

move

void move(java.lang.String from,
          java.lang.String to)
          throws javax.jcr.RepositoryException,
                 java.rmi.RemoteException

Remote version of the Workspace.move(String,String) method.

Parameters:

from - source path

to - destination path

Throws:

javax.jcr.RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

getNodeTypeManager

RemoteNodeTypeManager getNodeTypeManager()
                                         throws javax.jcr.RepositoryException,
                                                java.rmi.RemoteException

Remote version of the Workspace.getNodeTypeManager() method.

Returns:

node type manager

Throws:

javax.jcr.RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

getNamespaceRegistry

RemoteNamespaceRegistry getNamespaceRegistry()
                                             throws javax.jcr.RepositoryException,
                                                    java.rmi.RemoteException

Remote version of the Workspace.getNamespaceRegistry() method.

Returns:

namespace registry

Throws:

javax.jcr.RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

getQueryManager

RemoteQueryManager getQueryManager()
                                   throws javax.jcr.RepositoryException,
                                          java.rmi.RemoteException

Remote version of the Workspace.getQueryManager() method.

Returns:

query manager

Throws:

javax.jcr.RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

getObservationManager

RemoteObservationManager getObservationManager()
                                               throws javax.jcr.RepositoryException,
                                                      java.rmi.RemoteException

Remote version of the Workspace.getObservationManager() method.

Returns:

observation manager

Throws:

javax.jcr.RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

getAccessibleWorkspaceNames

java.lang.String[] getAccessibleWorkspaceNames()
                                               throws javax.jcr.RepositoryException,
                                                      java.rmi.RemoteException

Remote version of the Workspace.getAccessibleWorkspaceNames() method.

Returns:

accessible workspace names

Throws:

javax.jcr.RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

importXML

void importXML(java.lang.String path,
               byte[] xml,
               int uuidBehaviour)
               throws java.io.IOException,
                      javax.jcr.RepositoryException,
                      java.rmi.RemoteException

Remote version of the Workspace.importXML(String,InputStream,int) method.

Parameters:

path - node path

xml - imported XML document

uuidBehaviour - uuid behaviour flag

Throws:

java.io.IOException - on IO errors

javax.jcr.RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

restore

void restore(java.lang.String[] versionUuids,
             boolean removeExisting)
             throws javax.jcr.ItemExistsException,
                    javax.jcr.UnsupportedRepositoryOperationException,
                    javax.jcr.version.VersionException,
                    javax.jcr.lock.LockException,
                    javax.jcr.InvalidItemStateException,
                    javax.jcr.RepositoryException,
                    java.rmi.RemoteException

* Remote version of the Workspace.restore(String[] versionuuids, boolean removeExisting) method.

Parameters:

versions - The set of versionuudis to be restored

removeExisting - governs what happens on UUID collision.

Throws:

javax.jcr.ItemExistsException - if removeExisting is false and a UUID collision occurs with a node being restored.

javax.jcr.UnsupportedRepositoryOperationException - if one or more of the nodes to be restored is not versionable.

javax.jcr.version.VersionException - if the set of versions to be restored is such that the original path location of one or more of the versions cannot be determined or if the restore would change the state of a existing verisonable node that is currently checked-in or if a root version (jcr:rootVersion) is among those being restored.

javax.jcr.lock.LockException - if a lock prevents the restore.

javax.jcr.InvalidItemStateException - if this Session (not necessarily this Node) has pending unsaved changes.

javax.jcr.RepositoryException - if another error occurs.

java.rmi.RemoteException