org.apache.jackrabbit.rmi.remote
Interface RemoteWorkspace

All Superinterfaces:
Remote
All Known Implementing Classes:
ServerWorkspace

public interface RemoteWorkspace
extends 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 signaled with RemoteExceptions.

See Also:
Workspace, ClientWorkspace, ServerWorkspace

Method Summary
 void clone(String workspace, String from, String to, boolean removeExisting)
          Remote version of the Workspace.clone(String,String,String,boolean) method.
 void copy(String from, String to)
          Remote version of the Workspace.copy(String,String) method.
 void copy(String workspace, String from, String to)
          Remote version of the Workspace.copy(String,String,String) method.
 void createWorkspace(String name, String source)
           
 void deleteWorkspace(String name)
           
 String[] getAccessibleWorkspaceNames()
          Remote version of the Workspace.getAccessibleWorkspaceNames() method.
 RemoteLockManager getLockManager()
           
 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.
 RemoteVersionManager getVersionManager()
           
 void importXML(String path, byte[] xml, int uuidBehaviour)
          Remote version of the Workspace.importXML(String,InputStream,int) method.
 void move(String from, String to)
          Remote version of the Workspace.move(String,String) method.
 

Method Detail

getName

String getName()
               throws RemoteException
Remote version of the Workspace.getName() method.

Returns:
workspace name
Throws:
RemoteException - on RMI errors

copy

void copy(String from,
          String to)
          throws RepositoryException,
                 RemoteException
Remote version of the Workspace.copy(String,String) method.

Parameters:
from - source path
to - destination path
Throws:
RepositoryException - on repository errors
RemoteException - on RMI errors

copy

void copy(String workspace,
          String from,
          String to)
          throws RepositoryException,
                 RemoteException
Remote version of the Workspace.copy(String,String,String) method.

Parameters:
workspace - source workspace
from - source path
to - destination path
Throws:
RepositoryException - on repository errors
RemoteException - on RMI errors

clone

void clone(String workspace,
           String from,
           String to,
           boolean removeExisting)
           throws RepositoryException,
                  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:
RepositoryException - on repository errors
RemoteException - on RMI errors

move

void move(String from,
          String to)
          throws RepositoryException,
                 RemoteException
Remote version of the Workspace.move(String,String) method.

Parameters:
from - source path
to - destination path
Throws:
RepositoryException - on repository errors
RemoteException - on RMI errors

getNodeTypeManager

RemoteNodeTypeManager getNodeTypeManager()
                                         throws RepositoryException,
                                                RemoteException
Remote version of the Workspace.getNodeTypeManager() method.

Returns:
node type manager
Throws:
RepositoryException - on repository errors
RemoteException - on RMI errors

getNamespaceRegistry

RemoteNamespaceRegistry getNamespaceRegistry()
                                             throws RepositoryException,
                                                    RemoteException
Remote version of the Workspace.getNamespaceRegistry() method.

Returns:
namespace registry
Throws:
RepositoryException - on repository errors
RemoteException - on RMI errors

getQueryManager

RemoteQueryManager getQueryManager()
                                   throws RepositoryException,
                                          RemoteException
Remote version of the Workspace.getQueryManager() method.

Returns:
query manager
Throws:
RepositoryException - on repository errors
RemoteException - on RMI errors

getObservationManager

RemoteObservationManager getObservationManager()
                                               throws RepositoryException,
                                                      RemoteException
Remote version of the Workspace.getObservationManager() method.

Returns:
observation manager
Throws:
RepositoryException - on repository errors
RemoteException - on RMI errors

getAccessibleWorkspaceNames

String[] getAccessibleWorkspaceNames()
                                     throws RepositoryException,
                                            RemoteException
Remote version of the Workspace.getAccessibleWorkspaceNames() method.

Returns:
accessible workspace names
Throws:
RepositoryException - on repository errors
RemoteException - on RMI errors

importXML

void importXML(String path,
               byte[] xml,
               int uuidBehaviour)
               throws IOException,
                      RepositoryException,
                      RemoteException
Remote version of the Workspace.importXML(String,InputStream,int) method.

Parameters:
path - node path
xml - imported XML document
uuidBehaviour - uuid behaviour flag
Throws:
IOException - on IO errors
RepositoryException - on repository errors
RemoteException - on RMI errors

createWorkspace

void createWorkspace(String name,
                     String source)
                     throws RepositoryException,
                            RemoteException
Throws:
RepositoryException
RemoteException

deleteWorkspace

void deleteWorkspace(String name)
                     throws RepositoryException,
                            RemoteException
Throws:
RepositoryException
RemoteException

getLockManager

RemoteLockManager getLockManager()
                                 throws RepositoryException,
                                        RemoteException
Throws:
RepositoryException
RemoteException

getVersionManager

RemoteVersionManager getVersionManager()
                                       throws RepositoryException,
                                              RemoteException
Throws:
RepositoryException
RemoteException


Copyright © 2011-2013 Adobe Systems Incorporated. All Rights Reserved.