evolvedbinary / elemental / 982

Committed 29 Apr 2025 08:34PM UTC coverage: 56.409% (+0.007%) from 56.402%

Build # 982

Build Type

push

circleci

Committed by

adamretter

Commit Message

[feature] Improve README.md badges

Run Details

28451 of 55847 branches covered (50.94%)

Branch coverage included in aggregate %.

77468 of 131924 relevant lines covered (58.72%)

0.59 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

42.86

/exist-core/src/main/java/org/exist/xmldb/function/LocalXmldbDocumentFunction.java

/*
 * Elemental
 * Copyright (C) 2024, Evolved Binary Ltd
 *
 * admin@evolvedbinary.com
 * https://www.evolvedbinary.com | https://www.elemental.xyz
 *
 * Use of this software is governed by the Business Source License 1.1
 * included in the LICENSE file and at www.mariadb.com/bsl11.
 *
 * Change Date: 2028-04-27
 *
 * On the date above, in accordance with the Business Source License, use
 * of this software will be governed by the Apache License, Version 2.0.
 *
 * Additional Use Grant: Production use of the Licensed Work for a permitted
 * purpose. A Permitted Purpose is any purpose other than a Competing Use.
 * A Competing Use means making the Software available to others in a commercial
 * product or service that: substitutes for the Software; substitutes for any
 * other product or service we offer using the Software that exists as of the
 * date we make the Software available; or offers the same or substantially
 * similar functionality as the Software.
 */
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 <a href="mailto:adam.retter@googlemail.com">Adam Retter</a>
 */
@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
     * @param broker the database broker
     * @param transaction the database transaction
     *
     * @return the result of apply the function.
     *
     * @throws XMLDBException if an error occurs whilst applying the function
     * @throws PermissionDeniedException if the user has insufficient permissions
     * @throws LockException if an error occurs whilst locking a collection or document
     * @throws IOException if an IO error occurs
     * @throws SyntaxException if a syntax error occurs
     */
    R applyXmldb(final DocumentImpl document, final DBBroker broker, final Txn transaction)
            throws XMLDBException, PermissionDeniedException, LockException, IOException, SyntaxException;
}

1	/*
2	* Elemental
3	* Copyright (C) 2024, Evolved Binary Ltd
4	*
5	* admin@evolvedbinary.com
6	* https://www.evolvedbinary.com \| https://www.elemental.xyz
7	*
8	* Use of this software is governed by the Business Source License 1.1
9	* included in the LICENSE file and at www.mariadb.com/bsl11.
10	*
11	* Change Date: 2028-04-27
12	*
13	* On the date above, in accordance with the Business Source License, use
14	* of this software will be governed by the Apache License, Version 2.0.
15	*
16	* Additional Use Grant: Production use of the Licensed Work for a permitted
17	* purpose. A Permitted Purpose is any purpose other than a Competing Use.
18	* A Competing Use means making the Software available to others in a commercial
19	* product or service that: substitutes for the Software; substitutes for any
20	* other product or service we offer using the Software that exists as of the
21	* date we make the Software available; or offers the same or substantially
22	* similar functionality as the Software.
23	*/
24	package org.exist.xmldb.function;
25
26	import org.exist.dom.persistent.DocumentImpl;
27	import org.exist.security.PermissionDeniedException;
28	import org.exist.storage.DBBroker;
29	import org.exist.storage.txn.Txn;
30	import org.exist.util.LockException;
31	import org.exist.util.SyntaxException;
32	import com.evolvedbinary.j8fu.function.TriFunctionE;
33	import org.xmldb.api.base.ErrorCodes;
34	import org.xmldb.api.base.XMLDBException;
35
36	import java.io.IOException;
37
38	/**
39	* Specialisation of FunctionE which deals with
40	* local XMLDB operations; Predominantly converts exceptions
41	* from the database into XMLDBException types
42	*
43	* @author <a href="mailto:adam.retter@googlemail.com">Adam Retter</a>
44	*/
45	@FunctionalInterface
46	public interface LocalXmldbDocumentFunction<R> extends TriFunctionE<DocumentImpl, DBBroker, Txn, R, XMLDBException> {
47
48	@Override
49	default R apply(final DocumentImpl document, final DBBroker broker, final Txn transaction) throws XMLDBException {
50	try {
51	return applyXmldb(document, broker, transaction);	1✔
52	} catch(final PermissionDeniedException e) {	1✔
53	throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, e.getMessage(), e);	1✔
54	} catch(final LockException e) {	×
55	throw new XMLDBException(ErrorCodes.COLLECTION_CLOSED, e.getMessage(), e);	×
56	} catch(final IOException \| SyntaxException e) {	×
57	throw new XMLDBException(ErrorCodes.UNKNOWN_ERROR, e.getMessage(), e);	×
58	}
59	}
60
61	/**
62	* Signature for lambda function which takes a document.
63	*
64	* @param document The database collection
65	* @param broker the database broker
66	* @param transaction the database transaction
67	*
68	* @return the result of apply the function.
69	*
70	* @throws XMLDBException if an error occurs whilst applying the function
71	* @throws PermissionDeniedException if the user has insufficient permissions
72	* @throws LockException if an error occurs whilst locking a collection or document
73	* @throws IOException if an IO error occurs
74	* @throws SyntaxException if a syntax error occurs
75	*/
76	R applyXmldb(final DocumentImpl document, final DBBroker broker, final Txn transaction)
77	throws XMLDBException, PermissionDeniedException, LockException, IOException, SyntaxException;
78	}

evolvedbinary / elemental / 982

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous