/*
* eXist Open Source Native XML Database
* Copyright (C) 2001-2015 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.
*/
package org.exist.xmldb.function;
import org.exist.dom.persistent.DocumentImpl;
import org.exist.security.PermissionDeniedException;
import org.exist.storage.DBBroker;
import org.exist.storage.txn.Txn;
import org.exist.util.LockException;
import org.exist.util.SyntaxException;
import com.evolvedbinary.j8fu.function.TriFunctionE;
import org.xmldb.api.base.ErrorCodes;
import org.xmldb.api.base.XMLDBException;
import java.io.IOException;
/**
* Specialisation of FunctionE which deals with
* local XMLDB operations; Predominantly converts exceptions
* from the database into XMLDBException types
*
* @author Adam Retter <adam.retter@googlemail.com>
*/
@FunctionalInterface
public interface LocalXmldbDocumentFunction<R> extends TriFunctionE<DocumentImpl, DBBroker, Txn, R, XMLDBException> {
@Override
default R apply(final DocumentImpl document, final DBBroker broker, final Txn transaction) throws XMLDBException {
try {
return applyXmldb(document, broker, transaction);
} catch(final PermissionDeniedException e) {
throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, e.getMessage(), e);
} catch(final LockException e) {
throw new XMLDBException(ErrorCodes.COLLECTION_CLOSED, e.getMessage(), e);
} catch(final IOException | SyntaxException e) {
throw new XMLDBException(ErrorCodes.UNKNOWN_ERROR, e.getMessage(), e);
}
}
/**
* Signature for lambda function which takes a document
*
* @param document The database collection
*/
R applyXmldb(final DocumentImpl document, final DBBroker broker, final Txn transaction) throws XMLDBException, PermissionDeniedException, LockException, IOException, SyntaxException;
}