/*
* eXist Open Source Native XML Database
* Copyright (C) 2001-2009 The eXist Project
* http://exist-db.org
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $Id$
*/
package org.exist.xquery.functions.xmldb;
import org.apache.log4j.Logger;
import org.exist.dom.QName;
import org.exist.xmldb.UserManagementService;
import org.exist.xquery.Cardinality;
import org.exist.xquery.FunctionSignature;
import org.exist.xquery.XPathException;
import org.exist.xquery.XQueryContext;
import org.exist.xquery.value.AnyURIValue;
import org.exist.xquery.value.FunctionReturnSequenceType;
import org.exist.xquery.value.FunctionParameterSequenceType;
import org.exist.xquery.value.Sequence;
import org.exist.xquery.value.SequenceType;
import org.exist.xquery.value.StringValue;
import org.exist.xquery.value.Type;
import org.xmldb.api.base.Collection;
import org.xmldb.api.base.Resource;
import org.xmldb.api.base.XMLDBException;
/**
* @author Wolfgang Meier (wolfgang@exist-db.org)
*
*/
public class XMLDBHasLock extends XMLDBAbstractCollectionManipulator {
protected static final Logger logger = Logger.getLogger(XMLDBHasLock.class);
public final static FunctionSignature signature[] = {
new FunctionSignature(
new QName("document-has-lock", XMLDBModule.NAMESPACE_URI, XMLDBModule.PREFIX),
"Returns the user-id of the user that holds a write lock on the " +
"resource $resource in the collection $collection-uri. " +
"If no lock is in place, the empty sequence is returned. " +
XMLDBModule.COLLECTION_URI,
new SequenceType[] {
new FunctionParameterSequenceType("collection-uri", Type.STRING, Cardinality.EXACTLY_ONE, "The collection URI"),
new FunctionParameterSequenceType("resource", Type.STRING, Cardinality.EXACTLY_ONE, "The resource")
},
new FunctionReturnSequenceType(Type.STRING, Cardinality.ZERO_OR_ONE, "the user id of the lock owner, otherwise if not locked the empty sequence")
),
new FunctionSignature(
new QName("clear-lock", XMLDBModule.NAMESPACE_URI, XMLDBModule.PREFIX),
"Returns the user-id of the user that holds a write lock on the " +
"resource $resource in the collection $collection-uri. " +
"If no lock is in place, the empty sequence is returned. " +
XMLDBModule.COLLECTION_URI,
new SequenceType[] {
new FunctionParameterSequenceType("collection-uri", Type.STRING, Cardinality.EXACTLY_ONE, "The collection URI"),
new FunctionParameterSequenceType("resource", Type.STRING, Cardinality.EXACTLY_ONE, "The resource")
},
new FunctionReturnSequenceType(Type.STRING, Cardinality.ZERO_OR_ONE, "the user id of the lock owner, otherwise if not locked the empty sequence")
)
};
public XMLDBHasLock(XQueryContext context, FunctionSignature signature) {
super(context, signature);
}
/**
*
* @param contextSequence
* @param collection
* @param args
* @throws XPathException
*/
public Sequence evalWithCollection(Collection collection, Sequence[] args, Sequence contextSequence)
throws XPathException {
try {
final UserManagementService ums = (UserManagementService) collection.getService("UserManagementService", "1.0");
final Resource res = collection.getResource(new AnyURIValue(args[1].getStringValue()).toXmldbURI().toString());
if (res != null) {
final String lockUser = ums.hasUserLock(res);
if (lockUser != null && isCalledAs("clear-lock")) {
ums.unlockResource(res);
}
return lockUser == null ? Sequence.EMPTY_SEQUENCE : new StringValue(lockUser);
} else {
logger.error("Unable to locate resource " + args[1].getStringValue());
throw new XPathException(this, "Unable to locate resource " + args[1].getStringValue());
}
} catch (final XMLDBException e) {
logger.error("Failed to retrieve user lock");
throw new XPathException(this, "Failed to retrieve user lock", e);
}
}
}