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 signalled with RemoteExceptions.

Author:

Jukka Zitting

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.
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

public String getLockOwner()
                    throws RemoteException

Remote version of the Lock.getLockOwner() method.

Returns:

lock owner

Throws:

RemoteException - on RMI errors

isDeep

public 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

public String getLockToken()
                    throws RemoteException

Remote version of the Lock.getLockToken() method.

Returns:

lock token

Throws:

RemoteException - on RMI errors

isLive

public 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

public void refresh()
             throws RepositoryException,
                    RemoteException

Remote version of the Lock.refresh() method.

Throws:

RepositoryException - on repository errors

RemoteException - on RMI errors

isSessionScoped

public 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