Package org.apache.jackrabbit.rmi.remote
Interface RemoteSession
-
- All Superinterfaces:
Remote
- All Known Subinterfaces:
RemoteXASession
- All Known Implementing Classes:
ServerSession
,ServerXASession
@Deprecated(forRemoval=true) public interface RemoteSession extends Remote
Deprecated, for removal: This API element is subject to removal in a future version.RMI support is deprecated and will be removed in a future version of Jackrabbit; see Jira ticket JCR-4972 for more information.Remote version of the JCR
Session
interface. Used by theServerSession
andClientSession
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:
Session
,ClientSession
,ServerSession
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
addLockToken(String name)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.addLockToken(String)
method.byte[]
exportDocumentView(String path, boolean skipBinary, boolean noRecurse)
Deprecated, for removal: This API element is subject to removal in a future version.Exports the identified repository subtree as a document view XML stream.byte[]
exportSystemView(String path, boolean skipBinary, boolean noRecurse)
Deprecated, for removal: This API element is subject to removal in a future version.Exports the identified repository subtree as a system view XML stream.RemoteAccessControlManager
getAccessControlManager()
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getAccessControlManager()
method.Object
getAttribute(String name)
Deprecated, for removal: This API element is subject to removal in a future version.Returns the named attribute.String[]
getAttributeNames()
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getAttributeNames()
method.RemoteItem
getItem(String path)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getItem(String)
method.String[]
getLockTokens()
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getLockTokens()
method.String
getNamespacePrefix(String uri)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getNamespacePrefix(String)
method.String[]
getNamespacePrefixes()
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getNamespacePrefixes()
method.String
getNamespaceURI(String prefix)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getNamespaceURI(String)
method.RemoteNode
getNode(String path)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getNode(String)
method.RemoteNode
getNodeByIdentifier(String id)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getNodeByIdentifier(String)
method.RemoteNode
getNodeByUUID(String uuid)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getNodeByUUID(String)
method.RemoteProperty
getProperty(String path)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getProperty(String)
method.RemoteNode
getRootNode()
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getRootNode()
method.String
getUserID()
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getUserID()
method.RemoteWorkspace
getWorkspace()
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getWorkspace()
method.boolean
hasPendingChanges()
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.hasPendingChanges()
method.boolean
hasPermission(String path, String actions)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.hasPermission(String,String)
method.RemoteSession
impersonate(Credentials credentials)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.impersonate(Credentials)
method.void
importXML(String path, byte[] xml, int uuidBehaviour)
Deprecated, for removal: This API element is subject to removal in a future version.Imports the system or document view XML data into a subtree of the identified node.boolean
isLive()
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.isLive()
method.boolean
itemExists(String path)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.itemExists(String)
method.void
logout()
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.logout()
method.void
move(String from, String to)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.move(String,String)
method.boolean
nodeExists(String path)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.nodeExists(String)
method.boolean
propertyExists(String path)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.propertyExists(String)
method.void
refresh(boolean keepChanges)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.refresh(boolean)
method.void
removeItem(String path)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.removeItem(String)
method.void
removeLockToken(String name)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.removeLockToken(String)
method.void
save()
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.save()
method.void
setNamespacePrefix(String prefix, String uri)
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.setNamespacePrefix(String,String)
method.
-
-
-
Method Detail
-
getUserID
String getUserID() throws RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getUserID()
method.- Returns:
- user id
- Throws:
RemoteException
- on RMI errors- See Also:
Session.getUserID()
-
getAttribute
Object getAttribute(String name) throws RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.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:
RemoteException
- on RMI errors- See Also:
Session.getAttribute(java.lang.String)
-
getAttributeNames
String[] getAttributeNames() throws RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getAttributeNames()
method.- Returns:
- attribute names
- Throws:
RemoteException
- on RMI errors
-
getWorkspace
RemoteWorkspace getWorkspace() throws RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getWorkspace()
method.- Returns:
- workspace
- Throws:
RemoteException
- on RMI errors- See Also:
Session.getWorkspace()
-
impersonate
RemoteSession impersonate(Credentials credentials) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.impersonate(Credentials)
method.- Parameters:
credentials
- credentials for the new session- Returns:
- new session
- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
getNodeByIdentifier
RemoteNode getNodeByIdentifier(String id) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getNodeByIdentifier(String)
method.- Parameters:
id
- node identifier- Returns:
- node
- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
getNodeByUUID
RemoteNode getNodeByUUID(String uuid) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getNodeByUUID(String)
method.- Parameters:
uuid
- node uuid- Returns:
- node
- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
getItem
RemoteItem getItem(String path) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getItem(String)
method.- Parameters:
path
- item path- Returns:
- item
- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
getNode
RemoteNode getNode(String path) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getNode(String)
method.- Parameters:
path
- node path- Returns:
- node
- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
getProperty
RemoteProperty getProperty(String path) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getProperty(String)
method.- Parameters:
path
- property path- Returns:
- property
- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
itemExists
boolean itemExists(String path) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.itemExists(String)
method.- Parameters:
path
- item path- Returns:
true
if the item exists,false
otherwise- Throws:
RepositoryException
- on repository exceptionRemoteException
- on RMI errors
-
nodeExists
boolean nodeExists(String path) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.nodeExists(String)
method.- Parameters:
path
- node path- Returns:
true
if the node exists,false
otherwise- Throws:
RepositoryException
- on repository exceptionRemoteException
- on RMI errors
-
propertyExists
boolean propertyExists(String path) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.propertyExists(String)
method.- Parameters:
path
- property path- Returns:
true
if the property exists,false
otherwise- Throws:
RepositoryException
- on repository exceptionRemoteException
- on RMI errors
-
removeItem
void removeItem(String path) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.removeItem(String)
method.- Parameters:
path
- item path- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
move
void move(String from, String to) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.move(String,String)
method.- Parameters:
from
- source pathto
- destination path- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
save
void save() throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.save()
method.- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
refresh
void refresh(boolean keepChanges) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.refresh(boolean)
method.- Parameters:
keepChanges
- flag to keep transient changes- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
logout
void logout() throws RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.logout()
method.- Throws:
RemoteException
- on RMI errors
-
isLive
boolean isLive() throws RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.isLive()
method.- Returns:
true
if the session is live,false
otherwise- Throws:
RemoteException
- on RMI errors
-
getRootNode
RemoteNode getRootNode() throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getRootNode()
method.- Returns:
- root node
- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
hasPendingChanges
boolean hasPendingChanges() throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.hasPendingChanges()
method.- Returns:
true
if the session has pending changes,false
otherwise- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
hasPermission
boolean hasPermission(String path, String actions) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.hasPermission(String,String)
method.- Parameters:
path
- item pathactions
- actions- Returns:
true
if permission is granted,false
otherwise- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
importXML
void importXML(String path, byte[] xml, int uuidBehaviour) throws IOException, RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.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 aByteArrayInputStream
and feed it to the normal importXML method.- Parameters:
path
- node pathxml
- imported XML documentuuidBehaviour
- UUID handling mode- Throws:
IOException
- on IO errorsRepositoryException
- on repository errorsRemoteException
- on RMI errors- See Also:
Session.importXML(java.lang.String, java.io.InputStream, int)
-
setNamespacePrefix
void setNamespacePrefix(String prefix, String uri) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.setNamespacePrefix(String,String)
method.- Parameters:
prefix
- namespace prefixuri
- namespace uri- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
getNamespacePrefixes
String[] getNamespacePrefixes() throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getNamespacePrefixes()
method.- Returns:
- namespace prefixes
- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
getNamespaceURI
String getNamespaceURI(String prefix) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getNamespaceURI(String)
method.- Parameters:
prefix
- namespace prefix- Returns:
- namespace uri
- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
getNamespacePrefix
String getNamespacePrefix(String uri) throws RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getNamespacePrefix(String)
method.- Parameters:
uri
- namespace uri- Returns:
- namespace prefix
- Throws:
RepositoryException
- on repository errorsRemoteException
- on RMI errors
-
addLockToken
void addLockToken(String name) throws RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.addLockToken(String)
method.- Parameters:
name
- lock token- Throws:
RemoteException
- on RMI errors
-
getLockTokens
String[] getLockTokens() throws RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getLockTokens()
method.- Returns:
- lock tokens
- Throws:
RemoteException
- on RMI errors
-
removeLockToken
void removeLockToken(String name) throws RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.removeLockToken(String)
method.- Parameters:
name
- lock token- Throws:
RemoteException
- on RMI errors
-
exportSystemView
byte[] exportSystemView(String path, boolean skipBinary, boolean noRecurse) throws IOException, RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.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 aByteArrayOutputStream
to capture the XML data written by the normal exportSysView method.- Parameters:
path
- node pathskipBinary
- binary skip flagnoRecurse
- no recursion flag- Returns:
- exported XML document
- Throws:
IOException
- on IO errorsRepositoryException
- on repository errorsRemoteException
- on RMI errors- See Also:
Session.exportSystemView(java.lang.String, org.xml.sax.ContentHandler, boolean, boolean)
-
exportDocumentView
byte[] exportDocumentView(String path, boolean skipBinary, boolean noRecurse) throws IOException, RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.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 aByteArrayOutputStream
to capture the XML data written by the normal exportDocView method.- Parameters:
path
- node pathskipBinary
- skip binary flagnoRecurse
- no recursion flag- Returns:
- exported XML document
- Throws:
IOException
- on IO errorsRepositoryException
- on repository errorsRemoteException
- on RMI errors- See Also:
Session.exportDocumentView(java.lang.String, org.xml.sax.ContentHandler, boolean, boolean)
-
getAccessControlManager
RemoteAccessControlManager getAccessControlManager() throws UnsupportedRepositoryOperationException, RepositoryException, RemoteException
Deprecated, for removal: This API element is subject to removal in a future version.Remote version of theSession.getAccessControlManager()
method.- Throws:
UnsupportedRepositoryOperationException
- if the remote session does not support this methodRepositoryException
- if an error occurred getting the access control managerRemoteException
- on RMI errors
-
-