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

26.42

/exist-core/src/main/java/org/exist/xquery/functions/system/Shutdown.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.Timer;
import java.util.TimerTask;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.exist.dom.QName;
import org.exist.storage.BrokerPool;
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.NumericValue;
import org.exist.xquery.value.Sequence;
import org.exist.xquery.value.SequenceType;
import org.exist.xquery.value.Type;

/**
 * Shutdown the eXist server (must be dba)
 * 
 * @author Adam Retter (adam.retter@devon.gov.uk)
 */
public class Shutdown extends BasicFunction
{
        protected final static Logger logger = LogManager.getLogger(Shutdown.class);

        public final static FunctionSignature[] signatures = {
                new FunctionSignature(
                        new QName("shutdown", SystemModule.NAMESPACE_URI, SystemModule.PREFIX),
                        "Shutdown eXist immediately.  This method is only available to the DBA role.",
                        null,
                        new SequenceType(Type.EMPTY_SEQUENCE, Cardinality.EMPTY_SEQUENCE)
                ),
                
                new FunctionSignature(
                        new QName("shutdown", SystemModule.NAMESPACE_URI, SystemModule.PREFIX),
                        "Shutdown eXist.  This method is only available to the DBA role.",
                        new SequenceType[] {
                                        new FunctionParameterSequenceType("delay", Type.LONG, Cardinality.EXACTLY_ONE, "The delay in milliseconds before eXist starts to shutdown.")
                        },
                        new SequenceType(Type.EMPTY_SEQUENCE, Cardinality.EMPTY_SEQUENCE)
                )
        };
                

        public Shutdown(XQueryContext context, FunctionSignature signature)
        {
                super(context, signature);
        }

        /* (non-Javadoc)
         * @see org.exist.xquery.BasicFunction#eval(org.exist.xquery.value.Sequence[], org.exist.xquery.value.Sequence)
         */
        public Sequence eval(Sequence[] args, Sequence contextSequence) throws XPathException
        {
                if(context.getSubject().hasDbaRole())
                {
                        //determine the shutdown delay
                        long delay = 0;
                        if(args.length == 1)
                        {
                                if(!args[0].isEmpty())
                                {
                                        delay = ((NumericValue)args[0].itemAt(0)).getLong();
                                }
                        }
                        
                        //get the broker pool and shutdown
                        final BrokerPool pool = context.getBroker().getBrokerPool();
                                
                        if(delay > 0)
                        {
                                logger.info("Shutdown in {} milliseconds.", delay);
                                final Timer timer = new Timer("Elemental shutdown schedule", true);
                                final TimerTask task = new DelayedShutdownTask(timer, pool);
                                timer.schedule(task, delay);
                        }
                        else
                        {
                                logger.info("Shutting down now.");
                                pool.shutdown();
                        }
                }
                else
                {
                        final XPathException xPathException = new XPathException(this, "Permission denied, calling user '" + context.getSubject().getName() + "' must be a DBA to shutdown the database");
                        logger.error("Invalid user", xPathException);
                        throw xPathException;
                }
                        
                return Sequence.EMPTY_SEQUENCE;
        }
        
        private static class DelayedShutdownTask extends TimerTask {
                private Timer timer;
                private BrokerPool pool;
                
                public DelayedShutdownTask(final Timer timer, final BrokerPool pool) {
                        this.timer = timer;
                        this.pool = pool;
                }

                @Override
                public void run() {
                        logger.info("Shutting down now.");
                        pool.shutdown();

                        // make sure to stop the timer thread!
                        timer.cancel();

                        timer = null;
                        pool = null;
                }
        }
}

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
52	import java.util.Timer;
53	import java.util.TimerTask;
54
55	import org.apache.logging.log4j.LogManager;
56	import org.apache.logging.log4j.Logger;
57	import org.exist.dom.QName;
58	import org.exist.storage.BrokerPool;
59	import org.exist.xquery.BasicFunction;
60	import org.exist.xquery.Cardinality;
61	import org.exist.xquery.FunctionSignature;
62	import org.exist.xquery.XPathException;
63	import org.exist.xquery.XQueryContext;
64	import org.exist.xquery.value.FunctionParameterSequenceType;
65	import org.exist.xquery.value.NumericValue;
66	import org.exist.xquery.value.Sequence;
67	import org.exist.xquery.value.SequenceType;
68	import org.exist.xquery.value.Type;
69
70	/**
71	* Shutdown the eXist server (must be dba)
72	*
73	* @author Adam Retter (adam.retter@devon.gov.uk)
74	*/
75	public class Shutdown extends BasicFunction
76	{
77	protected final static Logger logger = LogManager.getLogger(Shutdown.class);	1✔
78
79	public final static FunctionSignature[] signatures = {	1✔
80	new FunctionSignature(	1✔
81	new QName("shutdown", SystemModule.NAMESPACE_URI, SystemModule.PREFIX),	1✔
82	"Shutdown eXist immediately. This method is only available to the DBA role.",	1✔
83	null,	1✔
84	new SequenceType(Type.EMPTY_SEQUENCE, Cardinality.EMPTY_SEQUENCE)	1✔
85	),
86
87	new FunctionSignature(	1✔
88	new QName("shutdown", SystemModule.NAMESPACE_URI, SystemModule.PREFIX),	1✔
89	"Shutdown eXist. This method is only available to the DBA role.",	1✔
90	new SequenceType[] {	1✔
91	new FunctionParameterSequenceType("delay", Type.LONG, Cardinality.EXACTLY_ONE, "The delay in milliseconds before eXist starts to shutdown.")	1✔
92	},
93	new SequenceType(Type.EMPTY_SEQUENCE, Cardinality.EMPTY_SEQUENCE)	1✔
94	)
95	};	1✔
96
97
98	public Shutdown(XQueryContext context, FunctionSignature signature)
99	{
100	super(context, signature);	×
101	}	×
102
103	/* (non-Javadoc)
104	* @see org.exist.xquery.BasicFunction#eval(org.exist.xquery.value.Sequence[], org.exist.xquery.value.Sequence)
105	*/
106	public Sequence eval(Sequence[] args, Sequence contextSequence) throws XPathException
107	{
108	if(context.getSubject().hasDbaRole())	×
109	{
110	//determine the shutdown delay
111	long delay = 0;	×
112	if(args.length == 1)	×
113	{
114	if(!args[0].isEmpty())	×
115	{
116	delay = ((NumericValue)args[0].itemAt(0)).getLong();	×
117	}
118	}
119
120	//get the broker pool and shutdown
121	final BrokerPool pool = context.getBroker().getBrokerPool();	×
122
123	if(delay > 0)	×
124	{
125	logger.info("Shutdown in {} milliseconds.", delay);	×
126	final Timer timer = new Timer("Elemental shutdown schedule", true);	×
127	final TimerTask task = new DelayedShutdownTask(timer, pool);	×
128	timer.schedule(task, delay);	×
129	}	×
130	else
131	{
132	logger.info("Shutting down now.");	×
133	pool.shutdown();	×
134	}
135	}	×
136	else
137	{
138	final XPathException xPathException = new XPathException(this, "Permission denied, calling user '" + context.getSubject().getName() + "' must be a DBA to shutdown the database");	×
139	logger.error("Invalid user", xPathException);	×
140	throw xPathException;	×
141	}
142
143	return Sequence.EMPTY_SEQUENCE;	×
144	}
145
146	private static class DelayedShutdownTask extends TimerTask {
147	private Timer timer;
148	private BrokerPool pool;
149
150	public DelayedShutdownTask(final Timer timer, final BrokerPool pool) {	×
151	this.timer = timer;	×
152	this.pool = pool;	×
153	}	×
154
155	@Override
156	public void run() {
157	logger.info("Shutting down now.");	×
158	pool.shutdown();	×
159
160	// make sure to stop the timer thread!
161	timer.cancel();	×
162
163	timer = null;	×
164	pool = null;	×
165	}	×
166	}
167	}

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