/*
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Apache Cocoon" and "Apache Software Foundation" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
apache@apache.org.
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals
on behalf of the Apache Software Foundation and was originally created by
Stefano Mazzocchi <stefano@apache.org>. For more information on the Apache
Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.cocoon.components.xscript;
import org.apache.avalon.framework.component.Component;
import org.apache.avalon.framework.component.ComponentException;
import org.apache.avalon.framework.component.ComponentManager;
import org.apache.avalon.framework.component.Composable;
import org.apache.avalon.framework.logger.AbstractLoggable;
import org.apache.avalon.framework.parameters.ParameterException;
import org.apache.avalon.framework.parameters.Parameterizable;
import org.apache.avalon.framework.parameters.Parameters;
import org.apache.avalon.framework.thread.ThreadSafe;
import org.apache.avalon.framework.context.Contextualizable;
import org.apache.avalon.framework.context.ContextException;
import org.apache.cocoon.environment.Request;
import org.apache.cocoon.environment.ObjectModelHelper;
import org.apache.cocoon.environment.Context;
import org.apache.cocoon.environment.Session;
import org.apache.cocoon.Constants;
import java.util.Map;
/**
* The actual implementation of the <code>XScriptManager</code> interface.
*
* @author <a href="mailto:ovidiu@cup.hp.com">Ovidiu Predescu</a>
* @version CVS $Id: XScriptManagerImpl.java,v 1.6.2.3 2002/07/30 01:17:49 vgritsenko Exp $
* @since August 4, 2001
*/
public class XScriptManagerImpl
extends AbstractLoggable
implements XScriptManager, Composable, Component, Parameterizable, Contextualizable, ThreadSafe
{
public static final String CONTEXT = "org.apache.cocoon.components.xscript.scope";
/**
* The <code>ComponentManager</code> instance.
*/
protected ComponentManager manager = null;
/**
* The <code>Context</code> instance.
*/
protected Context context = null;
public void contextualize(org.apache.avalon.framework.context.Context context)
throws ContextException
{
this.context = (Context)context.get(Constants.CONTEXT_ENVIRONMENT_CONTEXT);
}
public void compose(ComponentManager manager)
throws ComponentException
{
this.manager = manager;
}
public void register(XScriptObject object) {
try {
object.compose(manager);
} catch (ComponentException ignored) { }
}
public void parameterize(Parameters params)
throws ParameterException
{
String[] names = params.getNames();
XScriptVariableScope s = new XScriptVariableScope();
context.setAttribute(CONTEXT, s);
for (int i = 0; i < names.length; i++) {
String resourceString = params.getParameter(names[i]);
XScriptObject resource = new XScriptObjectFromURL(this, resourceString);
s.put(names[i], resource);
}
}
private IllegalArgumentException
createAccessException(String msg, String name, int scope)
{
StringBuffer message = new StringBuffer("Cannot ").append(msg)
.append(" variable named '").append(name)
.append("' in ");
if (scope == XScriptManager.GLOBAL_SCOPE)
message.append("global scope");
else if (scope == XScriptManager.SESSION_SCOPE)
message.append("session scope");
else if (scope == XScriptManager.PAGE_SCOPE)
message.append("page scope");
else if (scope == XScriptManager.REQUEST_SCOPE)
message.append("request scope");
else if (scope == XScriptManager.ALL_SCOPES)
message.append("any scope");
else
message.append("unknown scope (").append(scope).append(")");
return new IllegalArgumentException(message.toString());
}
public XScriptObject get(XScriptVariableScope pageScope,
Map objectModel,
String name,
int scope)
throws IllegalArgumentException
{
XScriptObject o;
XScriptVariableScope s = null;
if (scope == XScriptManager.GLOBAL_SCOPE) {
s = (XScriptVariableScope) ObjectModelHelper.getContext(objectModel).getAttribute(CONTEXT);
} else if (scope == XScriptManager.SESSION_SCOPE) {
Request request = ObjectModelHelper.getRequest(objectModel);
s = (XScriptVariableScope) request.getSession().getAttribute(CONTEXT);
} else if (scope == XScriptManager.REQUEST_SCOPE) {
Request request = ObjectModelHelper.getRequest(objectModel);
s = (XScriptVariableScope) request.getAttribute(CONTEXT);
} else if (scope == XScriptManager.PAGE_SCOPE) {
s = pageScope;
} else if (scope == XScriptManager.ALL_SCOPES) {
Request request = ObjectModelHelper.getRequest(objectModel);
// Lookup in the request scope first.
s = (XScriptVariableScope) request.getAttribute(CONTEXT);
if (s != null) {
o = s.get(name);
if (o != null) {
return o;
}
}
// No luck finding `name' in request scope, try in session scope.
s = (XScriptVariableScope) request.getSession().getAttribute(CONTEXT);
if (s != null) {
o = s.get(name);
if (o != null) {
return o;
}
}
// No luck finding `name' in session scope, try in page scope.
o = pageScope.get(name);
if (o != null) {
return o;
}
// No luck finding `name' in the page scope, try the global scope.
s = (XScriptVariableScope) ObjectModelHelper.getContext(objectModel).getAttribute(CONTEXT);
if (s != null) {
o = s.get(name);
if (o != null) {
return o;
}
}
// Not found, throw exception
s = null;
}
if (s != null) {
o = s.get(name);
if (o != null) {
return o;
}
}
throw createAccessException("find", name, scope);
}
public XScriptObject getFirst(XScriptVariableScope pageScope,
Map objectModel,
String name)
throws IllegalArgumentException
{
return get(pageScope, objectModel, name, ALL_SCOPES);
}
public void put(XScriptVariableScope pageScope,
Map objectModel,
String name,
XScriptObject value,
int scope)
{
XScriptVariableScope s;
if (scope == XScriptManager.GLOBAL_SCOPE) {
Context context = ObjectModelHelper.getContext(objectModel);
synchronized (context) {
s = (XScriptVariableScope) context.getAttribute(CONTEXT);
if (s == null) {
context.setAttribute(CONTEXT, s = new XScriptVariableScope());
}
}
} else if (scope == XScriptManager.SESSION_SCOPE) {
Session session = ObjectModelHelper.getRequest(objectModel).getSession();
synchronized (session) {
s = (XScriptVariableScope) session.getAttribute(CONTEXT);
if (s == null) {
session.setAttribute(CONTEXT, s = new XScriptVariableScope());
}
}
} else if (scope == XScriptManager.REQUEST_SCOPE) {
Request request = ObjectModelHelper.getRequest(objectModel);
synchronized (request) {
s = (XScriptVariableScope) request.getAttribute(CONTEXT);
if (s == null) {
request.setAttribute(CONTEXT, s = new XScriptVariableScope());
}
}
} else if (scope == XScriptManager.PAGE_SCOPE) {
s = pageScope;
} else {
throw createAccessException("create", name, scope);
}
s.put(name, value);
}
public XScriptObject remove(XScriptVariableScope pageScope,
Map objectModel,
String name,
int scope)
throws IllegalArgumentException
{
XScriptObject o;
XScriptVariableScope s = null;
if (scope == XScriptManager.GLOBAL_SCOPE) {
s = (XScriptVariableScope) ObjectModelHelper.getContext(objectModel).getAttribute(CONTEXT);
} else if (scope == XScriptManager.SESSION_SCOPE) {
Request request = ObjectModelHelper.getRequest(objectModel);
s = (XScriptVariableScope) request.getSession().getAttribute(CONTEXT);
} else if (scope == XScriptManager.REQUEST_SCOPE) {
Request request = ObjectModelHelper.getRequest(objectModel);
s = (XScriptVariableScope) request.getAttribute(CONTEXT);
} else if (scope == XScriptManager.PAGE_SCOPE) {
s = pageScope;
} else if (scope == XScriptManager.ALL_SCOPES) {
Request request = ObjectModelHelper.getRequest(objectModel);
// Lookup in the request scope first.
s = (XScriptVariableScope) request.getAttribute(CONTEXT);
if (s != null) {
o = s.remove(name);
if (o != null) {
return o;
}
}
// No luck finding `name' in request scope, try in session scope.
s = (XScriptVariableScope) request.getSession().getAttribute(CONTEXT);
if (s != null) {
o = s.remove(name);
if (o != null) {
return o;
}
}
// No luck finding `name' in session scope, try in page scope.
o = pageScope.remove(name);
if (o != null) {
return o;
}
// No luck finding `name' in the page scope, try the global scope.
s = (XScriptVariableScope) ObjectModelHelper.getContext(objectModel).getAttribute(CONTEXT);
if (s != null) {
o = s.remove(name);
if (o != null) {
return o;
}
}
// Not found, throw exception
s = null;
}
if (s != null) {
o = s.remove(name);
if (o != null) {
return o;
}
}
throw createAccessException("remove", name, scope);
}
public XScriptObject removeFirst(XScriptVariableScope pageScope, Map objectModel,
String name)
throws IllegalArgumentException
{
return remove(pageScope, objectModel, name, ALL_SCOPES);
}
}