/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jackrabbit.core.lock;
import org.apache.jackrabbit.core.SessionImpl;
import org.apache.jackrabbit.core.NodeImpl;
import org.apache.jackrabbit.core.security.authorization.Permission;
import javax.jcr.Node;
import javax.jcr.RepositoryException;
import javax.jcr.lock.LockException;
/**
* Implementation of a <code>Lock</code> that gets returned to clients asking
* for a lock.
*/
class LockImpl implements javax.jcr.lock.Lock {
/**
* Lock info containing latest information
*/
protected final LockInfo info;
/**
* Node holding lock
*/
protected final Node node;
/**
* Create a new instance of this class.
*
* @param info lock information
* @param node node holding lock
*/
public LockImpl(LockInfo info, Node node) {
this.info = info;
this.node = node;
}
//-----------------------------------------------------------------< Lock >
/**
* {@inheritDoc}
*/
public String getLockOwner() {
return info.getLockOwner();
}
/**
* {@inheritDoc}
*/
public boolean isDeep() {
return info.isDeep();
}
/**
* {@inheritDoc}
*/
public Node getNode() {
return node;
}
/**
* {@inheritDoc}
*/
public String getLockToken() {
if (info.isSessionScoped()) {
return null;
}
try {
return info.getLockToken(node.getSession());
} catch (RepositoryException e) {
return null;
}
}
/**
* {@inheritDoc}
*/
public boolean isLive() throws RepositoryException {
return info.isLive();
}
/**
* {@inheritDoc}
*/
public boolean isSessionScoped() {
return info.isSessionScoped();
}
/**
* {@inheritDoc}
* @throws LockException if this <code>Session</code> is not the lock holder
* or if this <code>Lock</code> is not alive.
*/
public void refresh() throws LockException, RepositoryException {
if (!isLive()) {
throw new LockException("Lock is not live any more.");
}
if (!isLockOwningSession()) {
throw new LockException("Session does not hold lock.");
}
// make sure the current session has sufficient privileges to refresh
// the lock.
SessionImpl s = (SessionImpl) node.getSession();
s.getAccessManager().checkPermission(((NodeImpl) node).getPrimaryPath(), Permission.LOCK_MNGMT);
// TODO: TOBEFIXED for 2.0
// TODO - add refresh if timeout is supported -> see #getSecondsRemaining
// since a lock has no expiration date no other action is required
}
//--------------------------------------------------< new JSR 283 methods >
/**
* @see javax.jcr.lock.Lock#getSecondsRemaining()
*/
public long getSecondsRemaining() {
return info.getSecondsRemaining();
}
/**
* @see javax.jcr.lock.Lock#isLockOwningSession()
*/
public boolean isLockOwningSession() {
try {
return info.isLockHolder(node.getSession());
} catch (RepositoryException e) {
return false;
}
}
}