/*
============================================================================
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.language.generator;
import org.apache.avalon.excalibur.component.ComponentHandler;
import org.apache.avalon.excalibur.component.ExcaliburComponentSelector;
import org.apache.avalon.excalibur.component.RoleManager;
import org.apache.avalon.excalibur.component.LogkitLoggerManager;
import org.apache.avalon.excalibur.logger.LogKitManager;
import org.apache.avalon.excalibur.logger.LoggerManager;
import org.apache.avalon.framework.activity.Disposable;
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.configuration.DefaultConfiguration;
import org.apache.avalon.framework.context.Context;
import org.apache.cocoon.Constants;
import org.apache.cocoon.components.classloader.ClassLoaderManager;
import org.apache.cocoon.components.language.programming.Program;
import java.io.File;
import java.util.HashMap;
import java.util.Map;
import java.util.ArrayList;
import java.util.List;
import java.util.Iterator;
/**
* This interface is the common base of all Compiled Components. This
* includes Sitemaps and XSP Pages
*
* @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
* @author <a href="mailto:vgritsenko@apache.org">Vadim Gritsenko</a>
* @version CVS $Id: GeneratorSelector.java,v 1.9.2.2 2002/06/28 09:01:39 cziegeler Exp $
*/
public class GeneratorSelector extends ExcaliburComponentSelector implements Disposable {
public static String ROLE = "org.apache.cocoon.components.language.generator.ServerPages";
private ClassLoaderManager classManager;
/** The component manager */
protected ComponentManager manager;
private LogkitLoggerManager logKitManager;
protected Context context;
protected RoleManager roles;
protected Map componentHandlers = new HashMap();
/** Dynamic component handlers mapping. */
private Map componentMapping = new HashMap();
public void contextualize(Context context) {
super.contextualize(context);
this.context = context;
}
public void setRoleManager(RoleManager roleMgr) {
super.setRoleManager(roleMgr);
this.roles = roleMgr;
}
/**
* Configure the LogKitManager
*/
public void setLogKitManager( final LogKitManager logkit ) {
super.setLogKitManager(logkit);
if( null == this.logKitManager ) {
this.logKitManager = new LogkitLoggerManager( null, logkit );
}
}
/**
* Configure the LoggerManager.
*/
public void setLoggerManager( final LoggerManager logkit ) {
super.setLoggerManager(logkit);
if( null == this.logKitManager ) {
this.logKitManager = new LogkitLoggerManager( logkit, null );
}
}
public void compose (ComponentManager manager) throws ComponentException {
super.compose(manager);
this.manager = manager;
try {
this.classManager = (ClassLoaderManager) manager.lookup(ClassLoaderManager.ROLE);
} catch (ComponentException cme) {
throw new ComponentException("GeneratorSelector", cme);
}
try {
this.classManager.addDirectory((File) this.m_context.get(Constants.CONTEXT_WORK_DIR));
} catch (Exception e) {
throw new ComponentException("Could not add repository to ClassLoaderManager", e);
}
}
public Component select(Object hint) throws ComponentException {
ComponentHandler handler = (ComponentHandler) this.componentHandlers.get(hint);
if (handler == null) {
throw new ComponentException("Could not find component for hint: " + hint);
}
try {
Component component = (Component) handler.get();
componentMapping.put(component, handler);
return component;
} catch (Exception ce) {
getLogger().debug("Could not access component for hint: " + hint, ce);
throw new ComponentException("Could not access component for hint: " + hint, ce);
}
}
public void release(Component component) {
ComponentHandler handler = (ComponentHandler)componentMapping.remove(component);
if (handler != null) {
try {
handler.put(component);
} catch (Exception e) {
getLogger().error("Error trying to release component", e);
}
}
}
protected void addGenerator(ComponentManager newManager,
Object hint, Program generator)
throws Exception {
try {
final ComponentHandler handler =
generator.getHandler(newManager, this.context, this.roles, this.logKitManager);
handler.setLogger(getLogkitLogger());
handler.initialize();
this.componentHandlers.put(hint, handler);
if (getLogger().isDebugEnabled()) {
getLogger().debug("Adding " + generator.getName() + " for " + hint);
}
} catch(final Exception e) {
// Error will be logged by caller. This is for debug only
getLogger().debug("Could not set up Component for hint: " + hint, e);
throw e;
}
}
protected void removeGenerator(Object hint) {
ComponentHandler handler = (ComponentHandler) this.componentHandlers.remove(hint);
if (handler != null) {
handler.dispose();
this.classManager.reinstantiate();
getLogger().debug("Removing " + handler.getClass().getName() + " for " + hint.toString());
}
}
public void dispose() {
this.manager.release(this.classManager);
synchronized(this) {
Iterator keys = this.componentHandlers.keySet().iterator();
List keyList = new ArrayList();
while(keys.hasNext()) {
Object key = keys.next();
ComponentHandler handler =
(ComponentHandler)this.componentHandlers.get(key);
handler.dispose();
keyList.add(key);
}
keys = keyList.iterator();
while(keys.hasNext()) {
this.componentHandlers.remove(keys.next());
}
keyList.clear();
}
super.dispose();
}
}