|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RemoteSession
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.
Session
,
ClientSession
,
ServerSession
Method Summary | |
---|---|
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(javax.jcr.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 |
---|
java.lang.String getUserID() throws java.rmi.RemoteException
Session.getUserID()
method.
java.rmi.RemoteException
- on RMI errorsSession.getUserID()
java.lang.Object getAttribute(java.lang.String name) throws java.rmi.RemoteException
name
- attribute name
java.rmi.RemoteException
- on RMI errorsSession.getAttribute(java.lang.String)
java.lang.String[] getAttributeNames() throws java.rmi.RemoteException
Session.getAttributeNames()
method.
java.rmi.RemoteException
- on RMI errorsRemoteWorkspace getWorkspace() throws java.rmi.RemoteException
Session.getWorkspace()
method.
java.rmi.RemoteException
- on RMI errorsSession.getWorkspace()
RemoteSession impersonate(javax.jcr.Credentials credentials) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.impersonate(Credentials)
method.
credentials
- credentials for the new session
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsRemoteNode getNodeByIdentifier(java.lang.String id) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.getNodeByIdentifier(String)
method.
id
- node identifier
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsRemoteNode getNodeByUUID(java.lang.String uuid) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.getNodeByUUID(String)
method.
uuid
- node uuid
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsRemoteItem getItem(java.lang.String path) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.getItem(String)
method.
path
- item path
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsRemoteNode getNode(java.lang.String path) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.getNode(String)
method.
path
- node path
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsRemoteProperty getProperty(java.lang.String path) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.getProperty(String)
method.
path
- property path
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsboolean itemExists(java.lang.String path) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.itemExists(String)
method.
path
- item path
true
if the item exists,
false
otherwise
javax.jcr.RepositoryException
- on repository exception
java.rmi.RemoteException
- on RMI errorsboolean nodeExists(java.lang.String path) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.nodeExists(String)
method.
path
- node path
true
if the node exists,
false
otherwise
javax.jcr.RepositoryException
- on repository exception
java.rmi.RemoteException
- on RMI errorsboolean propertyExists(java.lang.String path) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.propertyExists(String)
method.
path
- property path
true
if the property exists,
false
otherwise
javax.jcr.RepositoryException
- on repository exception
java.rmi.RemoteException
- on RMI errorsvoid removeItem(java.lang.String path) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.removeItem(String)
method.
path
- item path
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsvoid move(java.lang.String from, java.lang.String to) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.move(String,String)
method.
from
- source pathto
- destination path
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsvoid save() throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.save()
method.
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsvoid refresh(boolean keepChanges) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.refresh(boolean)
method.
keepChanges
- flag to keep transient changes
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsvoid logout() throws java.rmi.RemoteException
Session.logout()
method.
java.rmi.RemoteException
- on RMI errorsboolean isLive() throws java.rmi.RemoteException
Session.isLive()
method.
true
if the session is live,
false
otherwise
java.rmi.RemoteException
- on RMI errorsRemoteNode getRootNode() throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.getRootNode()
method.
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsboolean hasPendingChanges() throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.hasPendingChanges()
method.
true
if the session has pending changes,
false
otherwise
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsboolean hasPermission(java.lang.String path, java.lang.String actions) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.hasPermission(String,String)
method.
path
- item pathactions
- actions
true
if permission is granted,
false
otherwise
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsvoid importXML(java.lang.String path, byte[] xml, int uuidBehaviour) throws java.io.IOException, javax.jcr.RepositoryException, java.rmi.RemoteException
ByteArrayInputStream
and feed
it to the normal importXML method.
path
- node pathxml
- imported XML documentuuidBehaviour
- UUID handling mode
java.io.IOException
- on IO errors
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsSession.importXML(java.lang.String, java.io.InputStream, int)
void setNamespacePrefix(java.lang.String prefix, java.lang.String uri) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.setNamespacePrefix(String,String)
method.
prefix
- namespace prefixuri
- namespace uri
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsjava.lang.String[] getNamespacePrefixes() throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.getNamespacePrefixes()
method.
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsjava.lang.String getNamespaceURI(java.lang.String prefix) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.getNamespaceURI(String)
method.
prefix
- namespace prefix
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsjava.lang.String getNamespacePrefix(java.lang.String uri) throws javax.jcr.RepositoryException, java.rmi.RemoteException
Session.getNamespacePrefix(String)
method.
uri
- namespace uri
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsvoid addLockToken(java.lang.String name) throws java.rmi.RemoteException
Session.addLockToken(String)
method.
name
- lock token
java.rmi.RemoteException
- on RMI errorsjava.lang.String[] getLockTokens() throws java.rmi.RemoteException
Session.getLockTokens()
method.
java.rmi.RemoteException
- on RMI errorsvoid removeLockToken(java.lang.String name) throws java.rmi.RemoteException
Session.removeLockToken(String)
method.
name
- lock token
java.rmi.RemoteException
- on RMI errorsbyte[] exportSystemView(java.lang.String path, boolean skipBinary, boolean noRecurse) throws java.io.IOException, javax.jcr.RepositoryException, java.rmi.RemoteException
ByteArrayOutputStream
to capture
the XML data written by the normal exportSysView method.
path
- node pathskipBinary
- binary skip flagnoRecurse
- no recursion flag
java.io.IOException
- on IO errors
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsSession.exportSystemView(java.lang.String, org.xml.sax.ContentHandler, boolean, boolean)
byte[] exportDocumentView(java.lang.String path, boolean skipBinary, boolean noRecurse) throws java.io.IOException, javax.jcr.RepositoryException, java.rmi.RemoteException
ByteArrayOutputStream
to capture
the XML data written by the normal exportDocView method.
path
- node pathskipBinary
- skip binary flagnoRecurse
- no recursion flag
java.io.IOException
- on IO errors
javax.jcr.RepositoryException
- on repository errors
java.rmi.RemoteException
- on RMI errorsSession.exportDocumentView(java.lang.String, org.xml.sax.ContentHandler, boolean, boolean)
RemoteAccessControlManager getAccessControlManager() throws javax.jcr.UnsupportedRepositoryOperationException, javax.jcr.RepositoryException, java.rmi.RemoteException
Session.getAccessControlManager()
method.
javax.jcr.UnsupportedRepositoryOperationException
- if the remote session
does not support this method
javax.jcr.RepositoryException
- if an error occurred getting the access
control manager
java.rmi.RemoteException
- on RMI errors
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |