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

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

ServerLock

public interface RemoteLock
extends java.rmi.Remote

Remote version of the JCR Lock interface. Used by the ServerLock and ClientLock adapter classes to provide transparent RMI access to remote locks.

The methods in this interface are documented only with a reference to a corresponding Lock method. The remote object will simply forward the method call to the underlying Lock instance. Return values and possible exceptions are copied over the network. RMI errors are signalled with RemoteExceptions.

See Also:

Lock, ClientLock, ServerLock

Method Summary

java.lang.String	getLockOwner() Remote version of the Lock.getLockOwner() method.
java.lang.String	getLockToken() Remote version of the Lock.getLockToken() method.
RemoteNode	getNode() Remote version of the Lock.getNode() method.
boolean	isDeep() Remote version of the Lock.isDeep() method.
boolean	isLive() Remote version of the Lock.isLive() method.
boolean	isSessionScoped() Remote version of the Lock.isSessionScoped() () Lock.isSessionScoped()} method.
void	refresh() Remote version of the Lock.refresh() method.

Method Detail

getLockOwner

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

Remote version of the Lock.getLockOwner() method.

Returns:

lock owner

Throws:

java.rmi.RemoteException - on RMI errors

isDeep

boolean isDeep()
               throws java.rmi.RemoteException

Remote version of the Lock.isDeep() method.

Returns:

true if the lock is deep, false otherwise

Throws:

java.rmi.RemoteException - on RMI errors

getLockToken

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

Remote version of the Lock.getLockToken() method.

Returns:

lock token

Throws:

java.rmi.RemoteException - on RMI errors

isLive

boolean isLive()
               throws javax.jcr.RepositoryException,
                      java.rmi.RemoteException

Remote version of the Lock.isLive() method.

Returns:

true if the lock is live, false otherwise

Throws:

javax.jcr.RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

refresh

void refresh()
             throws javax.jcr.RepositoryException,
                    java.rmi.RemoteException

Remote version of the Lock.refresh() method.

Throws:

javax.jcr.RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

isSessionScoped

boolean isSessionScoped()
                        throws java.rmi.RemoteException

Remote version of the Lock.isSessionScoped() () Lock.isSessionScoped()} method.

Returns:

true if the lock is live, false otherwise

Throws:

java.rmi.RemoteException - on RMI errors

getNode

RemoteNode getNode()
                   throws java.rmi.RemoteException

Remote version of the Lock.getNode() method. Returns the lock holding node. Note that N.getLock().getNode() (where N is a locked node) will only return N if N is the lock holder. If N is in the subtree of the lock holder, H, then this call will return H.

Returns:

an Node.

Throws:

java.rmi.RemoteException