/*
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2003 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.webapps.session.components;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
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.AbstractLogEnabled;
import org.apache.avalon.framework.thread.ThreadSafe;
import org.apache.cocoon.ProcessingException;
import org.apache.cocoon.components.CocoonComponentManager;
import org.apache.cocoon.environment.ObjectModelHelper;
import org.apache.cocoon.environment.Request;
import org.apache.cocoon.environment.Session;
import org.apache.cocoon.webapps.session.ContextManager;
import org.apache.cocoon.webapps.session.SessionConstants;
import org.apache.cocoon.webapps.session.context.SessionContext;
import org.apache.cocoon.webapps.session.context.SessionContextProvider;
import org.apache.cocoon.webapps.session.context.SimpleSessionContext;
import org.apache.cocoon.webapps.session.context.StandardSessionContextProvider;
import org.xml.sax.SAXException;
/**
* Context manager
*
* @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
* @version CVS $Id: DefaultContextManager.java,v 1.1 2003/05/04 20:19:41 cziegeler Exp $
*/
public final class DefaultContextManager
extends AbstractLogEnabled
implements Composable, ContextManager, ThreadSafe, Component {
/** The <code>ComponentManager</code> */
private ComponentManager manager;
/** Registered context provider */
private Map contextProvider = new HashMap();
/* The list of reserved contexts */
static private String[] reservedContextNames = {"session",
"context"};
/**
* Avalon Composer Interface
*/
public void compose(ComponentManager manager)
throws ComponentException {
this.manager = manager;
// add standard provider
SessionContextProvider provider = new StandardSessionContextProvider();
try {
this.addSessionContextProvider(provider, SessionConstants.TEMPORARY_CONTEXT);
this.addSessionContextProvider(provider, SessionConstants.REQUEST_CONTEXT);
this.addSessionContextProvider(provider, SessionConstants.RESPONSE_CONTEXT);
} catch (ProcessingException e) {
throw new ComponentException("Unable to register default session context provider.", e);
}
}
/**
* Get the session
*/
private Session getSession(boolean create) {
final Map objectModel = CocoonComponentManager.getCurrentEnvironment().getObjectModel();
final Request request = ObjectModelHelper.getRequest( objectModel );
return request.getSession( create );
}
/**
* Get the list of contexts
*/
private Map getSessionContexts(Session session) {
Map contexts;
contexts = (Map)session.getAttribute(SessionContext.class.getName());
if (contexts == null) {
contexts = new HashMap(5, 3);
session.setAttribute(SessionContext.class.getName(), contexts);
}
return contexts;
}
/**
* Checks if the context name is a reserved context.
*/
private boolean isReservedContextName(String name) {
// synchronized (not needed)
int i, l;
boolean found;
found = false;
i = 0;
l = reservedContextNames.length;
while (i < l && found == false) {
found = reservedContextNames[i].equals(name);
i++;
}
if (!found ) {
found = (contextProvider.get(name) != null);
}
return found;
}
/**
* Add a context provider.
*/
public synchronized void addSessionContextProvider(SessionContextProvider provider,
String contextName)
throws ProcessingException {
if (contextName != null && provider != null) {
if (this.isReservedContextName(contextName)) {
throw new ProcessingException("Unable to register context '"+contextName+"' : Already registered.");
}
this.contextProvider.put(contextName, provider);
} else {
throw new ProcessingException("Unable to add new provider: Name or provider info missing.");
}
}
/**
* Get a reserved context
*/
private boolean existsReservedContext(String name)
throws ProcessingException {
// synchronized (not needed)
boolean exists = false;
SessionContextProvider provider = (SessionContextProvider)contextProvider.get(name);
if (provider != null) {
exists = provider.existsSessionContext( name );
}
return exists;
}
/**
* Get a reserved context
*/
private SessionContext getReservedContext(String name)
throws ProcessingException {
// synchronized
SessionContext context = null;
SessionContextProvider provider = (SessionContextProvider)contextProvider.get(name);
if (provider != null) {
synchronized (provider) {
context = provider.getSessionContext(name);
}
}
return context;
}
/**
* Create a new public context in the session.
* Create a new public session context for this user. If this context
* already exists no new context is created and the old one will be used
* instead.
*/
public SessionContext createContext(String name, String loadURI, String saveURI)
throws IOException, SAXException, ProcessingException {
// synchronized
if (this.getLogger().isDebugEnabled()) {
this.getLogger().debug("BEGIN createContext name=" + name +
"load=" + loadURI +
"save=" + saveURI);
}
// test arguments
if (name == null) {
throw new ProcessingException("CreateContext: Name is required");
}
Session session = this.getSession(true);
if (session == null) {
throw new ProcessingException("CreateContext: Session is required");
}
SessionContext context;
synchronized(session) {
// test for reserved context
if (this.isReservedContextName(name)) {
throw new ProcessingException("SessionContext with name " + name + " is reserved and cannot be created manually.");
}
if (this.existsContext(name)) {
context = this.getContext(name);
} else {
Map contexts = this.getSessionContexts(session);
context = new SimpleSessionContext();
context.setup(name, loadURI, saveURI);
contexts.put(name, context);
}
}
if (this.getLogger().isDebugEnabled()) {
this.getLogger().debug("END createContext context="+context);
}
return context;
}
/**
* Delete a public context in the session.
* If the context exists for this user, it and all of its information
* is deleted.
*/
public void deleteContext(String name)
throws ProcessingException {
// synchronized
if (this.getLogger().isDebugEnabled() ) {
this.getLogger().debug("BEGIN deleteContext name=" + name);
}
// test arguments
if (name == null) {
throw new ProcessingException("SessionManager.deleteContext: Name is required");
}
if (this.isReservedContextName(name)) {
throw new ProcessingException("SessionContext with name " + name + " is reserved and cannot be deleted manually.");
}
Session session = this.getSession(false);
if (session == null) {
throw new ProcessingException("SessionManager.deleteContext: Session is required");
}
synchronized(session) {
final Map contexts = this.getSessionContexts(session);
if (contexts.containsKey(name)) {
SessionContext context = (SessionContext)contexts.get(name);
contexts.remove(name);
}
}
if (this.getLogger().isDebugEnabled() ) {
this.getLogger().debug("END deleteContext");
}
}
/**
* Get a public context.
* The session context with the given name is returned. If the context does
* not exist <CODE>null</CODE> is returned.
*/
public SessionContext getContext(String name)
throws ProcessingException {
// synchronized
if (this.getLogger().isDebugEnabled() ) {
this.getLogger().debug("BEGIN getContext name=" + name);
}
SessionContext context;
if (this.isReservedContextName(name) ) {
context = this.getReservedContext(name);
} else {
Session session = this.getSession(false);
if ( session != null) {
synchronized (session) {
final Map contexts = this.getSessionContexts( session );
context = (SessionContext)contexts.get(name);
}
} else {
context = null;
}
}
if (this.getLogger().isDebugEnabled() ) {
this.getLogger().debug("END getContext context=" + context);
}
return context;
}
/**
* Check if a context exists
*/
public boolean hasSessionContext()
throws ProcessingException {
Session session = this.getSession(false);
if (session == null) {
throw new ProcessingException("SessionManager.hasSessionContext: Session is required.");
}
synchronized (session) {
final Map contexts = this.getSessionContexts(session);
return !(contexts.isEmpty());
}
}
/**
* Check if a public context exists.
* If the session context with the given name exists, <CODE>true</CODE> is
* returned.
*/
public boolean existsContext(String name)
throws ProcessingException {
Session session = this.getSession(false);
if (session == null) {
throw new ProcessingException("SessionManager.existsContext: Session is required.");
}
synchronized (session) {
final Map contexts = this.getSessionContexts(session);
boolean result = contexts.containsKey(name);
if (!result && this.isReservedContextName(name) ) {
result = this.existsReservedContext(name);
}
return result;
}
}
}