org.apache.jackrabbit.rmi.remote
Interface RemoteLock

All Superinterfaces:
Remote
All Known Implementing Classes:
ServerLock

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

See Also:
Lock, ClientLock, ServerLock

Method Summary
 String getLockOwner()
          Remote version of the Lock.getLockOwner() method.
 String getLockToken()
          Remote version of the Lock.getLockToken() method.
 RemoteNode getNode()
          Remote version of the Lock.getNode() method.
 long getSecondsRemaining()
          Remote version of the Lock.getSecondsRemaining() () Lock.getSecondsRemaining()} method.
 boolean isDeep()
          Remote version of the Lock.isDeep() method.
 boolean isLive()
          Remote version of the Lock.isLive() method.
 boolean isLockOwningSession()
          Remote version of the Lock.isLockOwningSession() () Lock.isLockOwningSession()} method.
 boolean isSessionScoped()
          Remote version of the Lock.isSessionScoped() () Lock.isSessionScoped()} method.
 void refresh()
          Remote version of the Lock.refresh() method.
 

Method Detail

getNode

RemoteNode getNode()
                   throws RepositoryException,
                          RemoteException
Remote version of the Lock.getNode() method.

Returns:
remote node
Throws:
RepositoryException - on repository errors
RemoteException - on RMI errors
Since:
JCR-RMI 2.0

getLockOwner

String getLockOwner()
                    throws RemoteException
Remote version of the Lock.getLockOwner() method.

Returns:
lock owner
Throws:
RemoteException - on RMI errors

isDeep

boolean isDeep()
               throws RemoteException
Remote version of the Lock.isDeep() method.

Returns:
true if the lock is deep, false otherwise
Throws:
RemoteException - on RMI errors

getLockToken

String getLockToken()
                    throws RemoteException
Remote version of the Lock.getLockToken() method.

Returns:
lock token
Throws:
RemoteException - on RMI errors

isLive

boolean isLive()
               throws RepositoryException,
                      RemoteException
Remote version of the Lock.isLive() method.

Returns:
true if the lock is live, false otherwise
Throws:
RepositoryException - on repository errors
RemoteException - on RMI errors

refresh

void refresh()
             throws RepositoryException,
                    RemoteException
Remote version of the Lock.refresh() method.

Throws:
RepositoryException - on repository errors
RemoteException - on RMI errors

isSessionScoped

boolean isSessionScoped()
                        throws RemoteException
Remote version of the Lock.isSessionScoped() () Lock.isSessionScoped()} method.

Returns:
true if the lock is live, false otherwise
Throws:
RemoteException - on RMI errors

getSecondsRemaining

long getSecondsRemaining()
                         throws RepositoryException,
                                RemoteException
Remote version of the Lock.getSecondsRemaining() () Lock.getSecondsRemaining()} method.

Returns:
the number of seconds remaining until this lock times out.
Throws:
RepositoryException - on repository errors
RemoteException - on RMI errors

isLockOwningSession

boolean isLockOwningSession()
                            throws RemoteException
Remote version of the Lock.isLockOwningSession() () Lock.isLockOwningSession()} method.

Returns:
a boolean.
Throws:
RemoteException - on RMI errors


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