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

12.5

/exist-core/src/main/java/org/exist/xquery/functions/system/TriggerSystemTask.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.
 *
 * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
 *       The original license header is included below.
 *
 * =====================================================================
 *
 * eXist-db Open Source Native XML Database
 * Copyright (C) 2001 The eXist-db Authors
 *
 * info@exist-db.org
 * http://www.exist-db.org
 *
 * This library 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.1 of the License, or (at your option) any later version.
 *
 * This library 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 library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package org.exist.xquery.functions.system;

import java.util.Properties;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.exist.EXistException;
import org.exist.dom.QName;
import org.exist.storage.SystemTask;
import org.exist.xquery.BasicFunction;
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.FunctionParameterSequenceType;
import org.exist.xquery.value.NodeValue;
import org.exist.xquery.value.Sequence;
import org.exist.xquery.value.SequenceType;
import org.exist.xquery.value.Type;
import org.w3c.dom.Element;
import org.w3c.dom.Node;

/**
 * 
 */
public class TriggerSystemTask extends BasicFunction {

        protected final static Logger logger = LogManager.getLogger(TriggerSystemTask.class);

    public final static FunctionSignature signature =
                new FunctionSignature(
                        new QName("trigger-system-task", SystemModule.NAMESPACE_URI, SystemModule.PREFIX),
                        "Trigger a system task.",
                        new SequenceType[]{
                new FunctionParameterSequenceType("java-classname", Type.STRING, Cardinality.EXACTLY_ONE, "The full name of the Java class to execute.  It must implement org.exist.storage.SystemTask"),
                new FunctionParameterSequenceType("task-parameters", Type.NODE, Cardinality.ZERO_OR_ONE, "The XML fragment with the following structure: <parameters><param name=\"param-name1\" value=\"param-value1\"/></parameters>")
            },
                        new SequenceType(Type.EMPTY_SEQUENCE, Cardinality.EMPTY_SEQUENCE));


    public TriggerSystemTask(XQueryContext context) {
        super(context, signature);
    }

    public Sequence eval(Sequence[] args, Sequence contextSequence) throws XPathException {
        final String className = args[0].getStringValue();
        final Properties properties = new Properties();
        if (args[1].hasOne()) {
            parseParameters(((NodeValue) args[1].itemAt(0)).getNode(), properties);
        }
        
        try {
            final Class<?> clazz = Class.forName(className);
            final Object taskObject = clazz.newInstance();

            if (!(taskObject instanceof SystemTask task)) {
                final XPathException xPathException = new XPathException(this, className + " is not an instance of org.exist.storage.SystemTask");
                logger.error("Java classname is not a SystemTask", xPathException);
                                throw xPathException;
            }

            task.configure(context.getBroker().getConfiguration(), properties);
            LOG.info("Triggering SystemTask: {}", className);
            context.getBroker().getBrokerPool().triggerSystemTask(task);

        } catch (final ClassNotFoundException e) {
            final String message = "system task class '" + className + "' not found";
            logger.error(message, e);
                        throw new XPathException(this, message);

        } catch (final InstantiationException e) {
            final String message = "system task '" + className + "' can not be instantiated";
            logger.error(message, e);
                        throw new XPathException(this, message);

        } catch (final IllegalAccessException e) {
            final String message = "system task '" + className + "' can not be accessed";
            logger.error(message, e);
                        throw new XPathException(this, message);

        } catch (final EXistException e) {
            final String message = "system task " + className + " reported an error during initialization: ";
            logger.error(message, e);
                        throw new XPathException(this, message + e.getMessage(), e);
        }
        return Sequence.EMPTY_SEQUENCE;
    }

    private void parseParameters(Node options, Properties properties) throws XPathException {
                if(options.getNodeType() == Node.ELEMENT_NODE && "parameters".equals(options.getLocalName())) {
                        Node child = options.getFirstChild();
                        while(child != null) {
                                if(child.getNodeType() == Node.ELEMENT_NODE && "param".equals(child.getLocalName())) {
                                        final Element elem = (Element)child;
                                        final String name = elem.getAttribute("name");
                                        final String value = elem.getAttribute("value");
                    logger.trace("parseParameters: name[{}] value[{}]", name, value);
                                        if (name.isEmpty() || value.isEmpty()) {
                        throw new XPathException(this, "Name or value attribute missing for stylesheet parameter");
                    }
                                        properties.setProperty(name, value);
                                }
                                child = child.getNextSibling();
                        }
                }
        }
}

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	* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
25	* The original license header is included below.
26	*
27	* =====================================================================
28	*
29	* eXist-db Open Source Native XML Database
30	* Copyright (C) 2001 The eXist-db Authors
31	*
32	* info@exist-db.org
33	* http://www.exist-db.org
34	*
35	* This library is free software; you can redistribute it and/or
36	* modify it under the terms of the GNU Lesser General Public
37	* License as published by the Free Software Foundation; either
38	* version 2.1 of the License, or (at your option) any later version.
39	*
40	* This library is distributed in the hope that it will be useful,
41	* but WITHOUT ANY WARRANTY; without even the implied warranty of
42	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
43	* Lesser General Public License for more details.
44	*
45	* You should have received a copy of the GNU Lesser General Public
46	* License along with this library; if not, write to the Free Software
47	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
48	*/
49	package org.exist.xquery.functions.system;
50
51	import java.util.Properties;
52
53	import org.apache.logging.log4j.LogManager;
54	import org.apache.logging.log4j.Logger;
55	import org.exist.EXistException;
56	import org.exist.dom.QName;
57	import org.exist.storage.SystemTask;
58	import org.exist.xquery.BasicFunction;
59	import org.exist.xquery.Cardinality;
60	import org.exist.xquery.FunctionSignature;
61	import org.exist.xquery.XPathException;
62	import org.exist.xquery.XQueryContext;
63	import org.exist.xquery.value.FunctionParameterSequenceType;
64	import org.exist.xquery.value.NodeValue;
65	import org.exist.xquery.value.Sequence;
66	import org.exist.xquery.value.SequenceType;
67	import org.exist.xquery.value.Type;
68	import org.w3c.dom.Element;
69	import org.w3c.dom.Node;
70
71	/**
72	*
73	*/
74	public class TriggerSystemTask extends BasicFunction {
75
76	protected final static Logger logger = LogManager.getLogger(TriggerSystemTask.class);	1✔
77
78	public final static FunctionSignature signature =	1✔
79	new FunctionSignature(	1✔
80	new QName("trigger-system-task", SystemModule.NAMESPACE_URI, SystemModule.PREFIX),	1✔
81	"Trigger a system task.",	1✔
82	new SequenceType[]{	1✔
83	new FunctionParameterSequenceType("java-classname", Type.STRING, Cardinality.EXACTLY_ONE, "The full name of the Java class to execute. It must implement org.exist.storage.SystemTask"),	1✔
84	new FunctionParameterSequenceType("task-parameters", Type.NODE, Cardinality.ZERO_OR_ONE, "The XML fragment with the following structure: <parameters><param name=\"param-name1\" value=\"param-value1\"/></parameters>")	1✔
85	},
86	new SequenceType(Type.EMPTY_SEQUENCE, Cardinality.EMPTY_SEQUENCE));	1✔
87
88
89	public TriggerSystemTask(XQueryContext context) {
90	super(context, signature);	×
91	}	×
92
93	public Sequence eval(Sequence[] args, Sequence contextSequence) throws XPathException {
94	final String className = args[0].getStringValue();	×
95	final Properties properties = new Properties();	×
96	if (args[1].hasOne()) {	×
97	parseParameters(((NodeValue) args[1].itemAt(0)).getNode(), properties);	×
98	}
99
100	try {
101	final Class<?> clazz = Class.forName(className);	×
102	final Object taskObject = clazz.newInstance();	×
103
104	if (!(taskObject instanceof SystemTask task)) {	×
105	final XPathException xPathException = new XPathException(this, className + " is not an instance of org.exist.storage.SystemTask");	×
106	logger.error("Java classname is not a SystemTask", xPathException);	×
107	throw xPathException;	×
108	}
109
110	task.configure(context.getBroker().getConfiguration(), properties);	×
111	LOG.info("Triggering SystemTask: {}", className);	×
112	context.getBroker().getBrokerPool().triggerSystemTask(task);	×
113
114	} catch (final ClassNotFoundException e) {	×
115	final String message = "system task class '" + className + "' not found";	×
116	logger.error(message, e);	×
117	throw new XPathException(this, message);	×
118
119	} catch (final InstantiationException e) {	×
120	final String message = "system task '" + className + "' can not be instantiated";	×
121	logger.error(message, e);	×
122	throw new XPathException(this, message);	×
123
124	} catch (final IllegalAccessException e) {	×
125	final String message = "system task '" + className + "' can not be accessed";	×
126	logger.error(message, e);	×
127	throw new XPathException(this, message);	×
128
129	} catch (final EXistException e) {	×
130	final String message = "system task " + className + " reported an error during initialization: ";	×
131	logger.error(message, e);	×
132	throw new XPathException(this, message + e.getMessage(), e);	×
133	}
134	return Sequence.EMPTY_SEQUENCE;	×
135	}
136
137	private void parseParameters(Node options, Properties properties) throws XPathException {
138	if(options.getNodeType() == Node.ELEMENT_NODE && "parameters".equals(options.getLocalName())) {	×
139	Node child = options.getFirstChild();	×
140	while(child != null) {	×
141	if(child.getNodeType() == Node.ELEMENT_NODE && "param".equals(child.getLocalName())) {	×
142	final Element elem = (Element)child;	×
143	final String name = elem.getAttribute("name");	×
144	final String value = elem.getAttribute("value");	×
145	logger.trace("parseParameters: name[{}] value[{}]", name, value);	×
146	if (name.isEmpty() \|\| value.isEmpty()) {	×
147	throw new XPathException(this, "Name or value attribute missing for stylesheet parameter");	×
148	}
149	properties.setProperty(name, value);	×
150	}
151	child = child.getNextSibling();	×
152	}
153	}
154	}	×
155	}

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