/*
* 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.session;
import java.util.Enumeration;
//import org.apache.log4j.Logger;
import org.exist.dom.QName;
import org.exist.http.servlets.SessionWrapper;
import org.exist.xquery.BasicFunction;
import org.exist.xquery.Cardinality;
import org.exist.xquery.FunctionSignature;
import org.exist.xquery.Variable;
import org.exist.xquery.XPathException;
import org.exist.xquery.XQueryContext;
import org.exist.xquery.value.JavaObjectValue;
import org.exist.xquery.value.Sequence;
import org.exist.xquery.value.SequenceType;
import org.exist.xquery.value.Type;
/**
* @author Adam Retter (adam.retter@devon.gov.uk)
* @author Loren Cahlander
*/
public class Clear extends BasicFunction {
// private static final Logger logger = Logger.getLogger(Clear.class);
public final static FunctionSignature signature =
new FunctionSignature(
new QName("clear", SessionModule.NAMESPACE_URI, SessionModule.PREFIX),
"Removes all attributes from the current HTTP session. Does NOT invalidate the session.",
null,
new SequenceType(Type.STRING, Cardinality.EMPTY));
/**
* @param context
*/
public Clear(XQueryContext context) {
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
{
final SessionModule myModule = (SessionModule) context.getModule(SessionModule.NAMESPACE_URI);
//session object is read from global variable $session
final Variable var = myModule.resolveVariable(SessionModule.SESSION_VAR);
if(var == null || var.getValue() == null)
{throw new XPathException(this, "Session not set");}
if (var.getValue().getItemType() != Type.JAVA_OBJECT)
{throw new XPathException(this, "Variable $session is not bound to an Java object.");}
final JavaObjectValue session = (JavaObjectValue) var.getValue().itemAt(0);
if(session.getObject() instanceof SessionWrapper)
{
final SessionWrapper sessionWrapper = (SessionWrapper)session.getObject();
for(final Enumeration<String> e = sessionWrapper.getAttributeNames(); e.hasMoreElements();)
{
final String attribName = (String) e.nextElement();
sessionWrapper.removeAttribute(attribName);
}
return Sequence.EMPTY_SEQUENCE;
}
else
{throw new XPathException(this, "Type error: variable $session is not bound to a session object");}
}
}