/*
* eXist Open Source Native XML Database
* Copyright (C) 2001-09 Wolfgang M. Meier
* wolfgang@exist-db.org
* http://exist.sourceforge.net
*
* 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., 675 Mass Ave, Cambridge, MA 02139, USA.
*
* $Id:
*/
package org.exist.xquery.functions.system;
import java.util.Date;
import org.apache.log4j.Logger;
import org.exist.dom.QName;
import org.exist.memtree.MemTreeBuilder;
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.XQueryWatchDog;
import org.exist.xquery.value.DateTimeValue;
import org.exist.xquery.value.FunctionReturnSequenceType;
import org.exist.xquery.value.NodeValue;
import org.exist.xquery.value.Sequence;
import org.exist.xquery.value.Type;
/**
* Return a list of the currently running XQueries (must be dba)
*
* @author Andrzej Taramina (andrzej@chaeron.com)
*/
public class GetRunningXQueries extends BasicFunction
{
protected final static Logger logger = Logger.getLogger(GetRunningXQueries.class);
final static String NAMESPACE_URI = SystemModule.NAMESPACE_URI;
final static String PREFIX = SystemModule.PREFIX;
public final static FunctionSignature signature =
new FunctionSignature(
new QName( "get-running-xqueries", SystemModule.NAMESPACE_URI, SystemModule.PREFIX ),
"Get a list of running XQueries (dba role only).",
null,
new FunctionReturnSequenceType( Type.ITEM, Cardinality.EXACTLY_ONE, "a node containing the list of running XQueries" )
);
public GetRunningXQueries( 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() ) {
final XPathException xPathException = new XPathException( this, "Permission denied, calling user '" + context.getSubject().getName() + "' must be a DBA to get the list of running xqueries" );
logger.error("Invalid user " + SystemModule.PREFIX + ":get-scheduled-xqueries", xPathException);
throw xPathException;
}
return( getRunningXQueries() );
}
private Sequence getRunningXQueries() throws XPathException
{
Sequence xmlResponse = null;
final MemTreeBuilder builder = context.getDocumentBuilder();
builder.startDocument();
builder.startElement( new QName( "xqueries", NAMESPACE_URI, PREFIX ), null );
//Add all the running xqueries
final XQueryWatchDog watchdogs[] = getContext().getBroker().getBrokerPool().getProcessMonitor().getRunningXQueries();
for (int i = 0; i < watchdogs.length; i++) {
final XQueryContext context = watchdogs[i].getContext();
getRunningXQuery( builder, context, watchdogs[i] );
}
builder.endElement();
xmlResponse = (NodeValue)builder.getDocument().getDocumentElement();
return( xmlResponse );
}
private void getRunningXQuery( MemTreeBuilder builder, XQueryContext context, XQueryWatchDog watchdog ) throws XPathException
{
builder.startElement( new QName( "xquery", NAMESPACE_URI, PREFIX ), null );
builder.addAttribute( new QName( "id", null, null ), "" + context.hashCode() );
builder.addAttribute( new QName( "sourceType", null, null ), context.getXacmlSource().getType() );
builder.addAttribute( new QName( "started", null, null), new DateTimeValue(new Date(watchdog.getStartTime())).getStringValue());
builder.addAttribute( new QName( "terminating", null, null ), ( watchdog.isTerminating() ? "true" : "false" ) );
builder.startElement( new QName( "sourceKey", NAMESPACE_URI, PREFIX ), null );
builder.characters( context.getXacmlSource().getKey() );
builder.endElement();
builder.startElement( new QName( "xqueryExpression", NAMESPACE_URI, PREFIX ), null );
builder.characters( context.getRootExpression().toString() );
builder.endElement();
builder.endElement();
}
}