org.apache.jackrabbit.rmi.remote

Interface RemoteSession

All Superinterfaces:

java.rmi.Remote

All Known Subinterfaces:

RemoteXASession

All Known Implementing Classes:

ServerSession, ServerXASession

public interface RemoteSession
extends java.rmi.Remote

Remote version of the JCR Session interface. Used by the ServerSession and ClientSession adapters to provide transparent RMI access to remote sessions.

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

See Also:

javax.jcr.Session, ClientSession, ServerSession

Method Summary

Modifier and Type	Method and Description
void	addLockToken(java.lang.String name) Remote version of the Session.addLockToken(String) method.
byte[]	exportDocumentView(java.lang.String path, boolean skipBinary, boolean noRecurse) Exports the identified repository subtree as a document view XML stream.
byte[]	exportSystemView(java.lang.String path, boolean skipBinary, boolean noRecurse) Exports the identified repository subtree as a system view XML stream.
RemoteAccessControlManager	getAccessControlManager() Remote version of the Session.getAccessControlManager() method.
java.lang.Object	getAttribute(java.lang.String name) Returns the named attribute.
java.lang.String[]	getAttributeNames() Remote version of the Session.getAttributeNames() method.
RemoteItem	getItem(java.lang.String path) Remote version of the Session.getItem(String) method.
java.lang.String[]	getLockTokens() Remote version of the Session.getLockTokens() method.
java.lang.String	getNamespacePrefix(java.lang.String uri) Remote version of the Session.getNamespacePrefix(String) method.
java.lang.String[]	getNamespacePrefixes() Remote version of the Session.getNamespacePrefixes() method.
java.lang.String	getNamespaceURI(java.lang.String prefix) Remote version of the Session.getNamespaceURI(String) method.
RemoteNode	getNode(java.lang.String path) Remote version of the Session.getNode(String) method.
RemoteNode	getNodeByIdentifier(java.lang.String id) Remote version of the Session.getNodeByIdentifier(String) method.
RemoteNode	getNodeByUUID(java.lang.String uuid) Remote version of the Session.getNodeByUUID(String) method.
RemoteProperty	getProperty(java.lang.String path) Remote version of the Session.getProperty(String) method.
RemoteNode	getRootNode() Remote version of the Session.getRootNode() method.
java.lang.String	getUserID() Remote version of the Session.getUserID() method.
RemoteWorkspace	getWorkspace() Remote version of the Session.getWorkspace() method.
boolean	hasPendingChanges() Remote version of the Session.hasPendingChanges() method.
boolean	hasPermission(java.lang.String path, java.lang.String actions) Remote version of the Session.hasPermission(String,String) method.
RemoteSession	impersonate(Credentials credentials) Remote version of the Session.impersonate(Credentials) method.
void	importXML(java.lang.String path, byte[] xml, int uuidBehaviour) Imports the system or document view XML data into a subtree of the identified node.
boolean	isLive() Remote version of the Session.isLive() method.
boolean	itemExists(java.lang.String path) Remote version of the Session.itemExists(String) method.
void	logout() Remote version of the Session.logout() method.
void	move(java.lang.String from, java.lang.String to) Remote version of the Session.move(String,String) method.
boolean	nodeExists(java.lang.String path) Remote version of the Session.nodeExists(String) method.
boolean	propertyExists(java.lang.String path) Remote version of the Session.propertyExists(String) method.
void	refresh(boolean keepChanges) Remote version of the Session.refresh(boolean) method.
void	removeItem(java.lang.String path) Remote version of the Session.removeItem(String) method.
void	removeLockToken(java.lang.String name) Remote version of the Session.removeLockToken(String) method.
void	save() Remote version of the Session.save() method.
void	setNamespacePrefix(java.lang.String prefix, java.lang.String uri) Remote version of the Session.setNamespacePrefix(String,String) method.

Method Detail

getUserID

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

Remote version of the Session.getUserID() method.

Returns:

user id

Throws:

java.rmi.RemoteException - on RMI errors

See Also:

javax.jcr.Session#getUserID()

getAttribute

java.lang.Object getAttribute(java.lang.String name)
                       throws java.rmi.RemoteException

Returns the named attribute. Note that only serializable attribute values can be transmitted over the network and that the client should have (or be able to fetch) the object class to access the returned value. Failures to meet these conditions are signalled with RemoteExceptions.

Parameters:

name - attribute name

Returns:

attribute value

Throws:

java.rmi.RemoteException - on RMI errors

See Also:

javax.jcr.Session#getAttribute(java.lang.String)

getAttributeNames

java.lang.String[] getAttributeNames()
                              throws java.rmi.RemoteException

Remote version of the Session.getAttributeNames() method.

Returns:

attribute names

Throws:

java.rmi.RemoteException - on RMI errors

getWorkspace

RemoteWorkspace getWorkspace()
                      throws java.rmi.RemoteException

Remote version of the Session.getWorkspace() method.

Returns:

workspace

Throws:

java.rmi.RemoteException - on RMI errors

See Also:

javax.jcr.Session#getWorkspace()

impersonate

RemoteSession impersonate(Credentials credentials)
                   throws RepositoryException,
                          java.rmi.RemoteException

Remote version of the Session.impersonate(Credentials) method.

Parameters:

credentials - credentials for the new session

Returns:

new session

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

getNodeByIdentifier

RemoteNode getNodeByIdentifier(java.lang.String id)
                        throws RepositoryException,
                               java.rmi.RemoteException

Remote version of the Session.getNodeByIdentifier(String) method.

Parameters:

id - node identifier

Returns:

node

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

getNodeByUUID

RemoteNode getNodeByUUID(java.lang.String uuid)
                  throws RepositoryException,
                         java.rmi.RemoteException

Remote version of the Session.getNodeByUUID(String) method.

Parameters:

uuid - node uuid

Returns:

node

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

getItem

RemoteItem getItem(java.lang.String path)
            throws RepositoryException,
                   java.rmi.RemoteException

Remote version of the Session.getItem(String) method.

Parameters:

path - item path

Returns:

item

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

getNode

RemoteNode getNode(java.lang.String path)
            throws RepositoryException,
                   java.rmi.RemoteException

Remote version of the Session.getNode(String) method.

Parameters:

path - node path

Returns:

node

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

getProperty

RemoteProperty getProperty(java.lang.String path)
                    throws RepositoryException,
                           java.rmi.RemoteException

Remote version of the Session.getProperty(String) method.

Parameters:

path - property path

Returns:

property

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

itemExists

boolean itemExists(java.lang.String path)
            throws RepositoryException,
                   java.rmi.RemoteException

Remote version of the Session.itemExists(String) method.

Parameters:

path - item path

Returns:

true if the item exists, false otherwise

Throws:

RepositoryException - on repository exception

java.rmi.RemoteException - on RMI errors

nodeExists

boolean nodeExists(java.lang.String path)
            throws RepositoryException,
                   java.rmi.RemoteException

Remote version of the Session.nodeExists(String) method.

Parameters:

path - node path

Returns:

true if the node exists, false otherwise

Throws:

RepositoryException - on repository exception

java.rmi.RemoteException - on RMI errors

propertyExists

boolean propertyExists(java.lang.String path)
                throws RepositoryException,
                       java.rmi.RemoteException

Remote version of the Session.propertyExists(String) method.

Parameters:

path - property path

Returns:

true if the property exists, false otherwise

Throws:

RepositoryException - on repository exception

java.rmi.RemoteException - on RMI errors

removeItem

void removeItem(java.lang.String path)
         throws RepositoryException,
                java.rmi.RemoteException

Remote version of the Session.removeItem(String) method.

Parameters:

path - item path

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

move

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

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

Parameters:

from - source path

to - destination path

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

save

void save()
   throws RepositoryException,
          java.rmi.RemoteException

Remote version of the Session.save() method.

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

refresh

void refresh(boolean keepChanges)
      throws RepositoryException,
             java.rmi.RemoteException

Remote version of the Session.refresh(boolean) method.

Parameters:

keepChanges - flag to keep transient changes

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

logout

void logout()
     throws java.rmi.RemoteException

Remote version of the Session.logout() method.

Throws:

java.rmi.RemoteException - on RMI errors

isLive

boolean isLive()
        throws java.rmi.RemoteException

Remote version of the Session.isLive() method.

Returns:

true if the session is live, false otherwise

Throws:

java.rmi.RemoteException - on RMI errors

getRootNode

RemoteNode getRootNode()
                throws RepositoryException,
                       java.rmi.RemoteException

Remote version of the Session.getRootNode() method.

Returns:

root node

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

hasPendingChanges

boolean hasPendingChanges()
                   throws RepositoryException,
                          java.rmi.RemoteException

Remote version of the Session.hasPendingChanges() method.

Returns:

true if the session has pending changes, false otherwise

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

hasPermission

boolean hasPermission(java.lang.String path,
                      java.lang.String actions)
               throws RepositoryException,
                      java.rmi.RemoteException

Remote version of the Session.hasPermission(String,String) method.

Parameters:

path - item path

actions - actions

Returns:

true if permission is granted, false otherwise

Throws:

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,
               RepositoryException,
               java.rmi.RemoteException

Imports the system or document view XML data into a subtree of the identified node. Note that the entire XML stream is transferred as a single byte array over the network. This may cause problems with large XML streams. The remote server will wrap the XML data into a ByteArrayInputStream and feed it to the normal importXML method.

Parameters:

path - node path

xml - imported XML document

uuidBehaviour - UUID handling mode

Throws:

java.io.IOException - on IO errors

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

See Also:

javax.jcr.Session#importXML(java.lang.String, java.io.InputStream, int)

setNamespacePrefix

void setNamespacePrefix(java.lang.String prefix,
                        java.lang.String uri)
                 throws RepositoryException,
                        java.rmi.RemoteException

Remote version of the Session.setNamespacePrefix(String,String) method.

Parameters:

prefix - namespace prefix

uri - namespace uri

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

getNamespacePrefixes

java.lang.String[] getNamespacePrefixes()
                                 throws RepositoryException,
                                        java.rmi.RemoteException

Remote version of the Session.getNamespacePrefixes() method.

Returns:

namespace prefixes

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

getNamespaceURI

java.lang.String getNamespaceURI(java.lang.String prefix)
                          throws RepositoryException,
                                 java.rmi.RemoteException

Remote version of the Session.getNamespaceURI(String) method.

Parameters:

prefix - namespace prefix

Returns:

namespace uri

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

getNamespacePrefix

java.lang.String getNamespacePrefix(java.lang.String uri)
                             throws RepositoryException,
                                    java.rmi.RemoteException

Remote version of the Session.getNamespacePrefix(String) method.

Parameters:

uri - namespace uri

Returns:

namespace prefix

Throws:

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

addLockToken

void addLockToken(java.lang.String name)
           throws java.rmi.RemoteException

Remote version of the Session.addLockToken(String) method.

Parameters:

name - lock token

Throws:

java.rmi.RemoteException - on RMI errors

getLockTokens

java.lang.String[] getLockTokens()
                          throws java.rmi.RemoteException

Remote version of the Session.getLockTokens() method.

Returns:

lock tokens

Throws:

java.rmi.RemoteException - on RMI errors

removeLockToken

void removeLockToken(java.lang.String name)
              throws java.rmi.RemoteException

Remote version of the Session.removeLockToken(String) method.

Parameters:

name - lock token

Throws:

java.rmi.RemoteException - on RMI errors

exportSystemView

byte[] exportSystemView(java.lang.String path,
                        boolean skipBinary,
                        boolean noRecurse)
                 throws java.io.IOException,
                        RepositoryException,
                        java.rmi.RemoteException

Exports the identified repository subtree as a system view XML stream. Note that the entire XML stream is transferred as a single byte array over the network. This may cause problems with large exports. The remote server uses a ByteArrayOutputStream to capture the XML data written by the normal exportSysView method.

Parameters:

path - node path

skipBinary - binary skip flag

noRecurse - no recursion flag

Returns:

exported XML document

Throws:

java.io.IOException - on IO errors

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

See Also:

javax.jcr.Session#exportSystemView

exportDocumentView

byte[] exportDocumentView(java.lang.String path,
                          boolean skipBinary,
                          boolean noRecurse)
                   throws java.io.IOException,
                          RepositoryException,
                          java.rmi.RemoteException

Exports the identified repository subtree as a document view XML stream. Note that the entire XML stream is transferred as a single byte array over the network. This may cause problems with large exports. The remote server uses a ByteArrayOutputStream to capture the XML data written by the normal exportDocView method.

Parameters:

path - node path

skipBinary - skip binary flag

noRecurse - no recursion flag

Returns:

exported XML document

Throws:

java.io.IOException - on IO errors

RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

See Also:

javax.jcr.Session#exportDocumentView

getAccessControlManager

RemoteAccessControlManager getAccessControlManager()
                                            throws UnsupportedRepositoryOperationException,
                                                   RepositoryException,
                                                   java.rmi.RemoteException

Remote version of the Session.getAccessControlManager() method.

Throws:

UnsupportedRepositoryOperationException - if the remote session does not support this method

RepositoryException - if an error occurred getting the access control manager

java.rmi.RemoteException - on RMI errors