You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by sy...@apache.org on 2002/03/04 19:16:45 UTC
cvs commit: xml-cocoon2/src/java/org/apache/cocoon/components ExtendedComponentSelector.java LifecycleHelper.java
sylvain 02/03/04 10:16:45
Added: src/java/org/apache/cocoon/components
ExtendedComponentSelector.java LifecycleHelper.java
Log:
Forgot to remove some classes from the scratchpad...
Revision Changes Path
1.1 xml-cocoon2/src/java/org/apache/cocoon/components/ExtendedComponentSelector.java
Index: ExtendedComponentSelector.java
===================================================================
/*
============================================================================
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 <st...@apache.org>. For more information on the Apache
Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.cocoon.components;
import org.apache.avalon.framework.component.Component;
import org.apache.avalon.framework.component.ComponentException;
import org.apache.avalon.framework.component.ComponentSelector;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.avalon.framework.configuration.DefaultConfiguration;
import org.apache.avalon.excalibur.component.ExcaliburComponentSelector;
import org.apache.avalon.excalibur.component.RoleManager;
import java.util.*;
/**
* An extension of <code>ExcaliburComponentSelector</code> that can have a parent
* and accepts a wider variety of configurations.
*
* @author <a href="mailto:sylvain@apache.org">Sylvain Wallez</a>
* @version CVS $Id: ExtendedComponentSelector.java,v 1.1 2002/03/04 18:16:45 sylvain Exp $
*/
public class ExtendedComponentSelector extends ExcaliburComponentSelector {
/** The role manager */
protected RoleManager roles;
/** The parent selector, if any */
protected ComponentSelector parentSelector;
/** The class loader to use */
protected ClassLoader classLoader;
/** The components selected in the parent selector */
protected Set parentComponents;
/** The role of this selector. Set in <code>configure()</code>. */
protected String roleName;
/** The default hint */
protected String defaultHint;
public ExtendedComponentSelector()
{
super();
this.classLoader = Thread.currentThread().getContextClassLoader();
}
/** Create the ComponentSelector with a Classloader */
public ExtendedComponentSelector(ClassLoader loader)
{
super(loader);
if (loader == null) {
this.classLoader = Thread.currentThread().getContextClassLoader();
} else {
this.classLoader = loader;
}
}
/**
* Get the name for component-instance elements (i.e. components not defined
* by their role shortcut. If <code>null</code>, any element having a 'class'
* attribute will be considered as a component instance.
* <p>
* The default here is to return <code>null</code>, and subclasses can redefine
* this method to return particular values.
*
* @return <code>null</code>, but can be changed by subclasses
*/
protected String getComponentInstanceName() {
return null;
}
/**
* Get the name of the attribute giving the class name of a component.
* The default here is "class", but this can be overriden in subclasses.
*
* @return "<code>class</code>", but can be changed by subclasses
*/
protected String getClassAttributeName() {
return "class";
}
/**
* Get the name of the attribute giving the default hint to use if
* none is given. The default here is "default", but this can be
* overriden in subclasses. If this method returns <code>null</code>,
* no default hint can be specified.
*
* @return "<code>default</code>", but can be changed by subclasses
*/
protected String getDefaultHintAttributeName() {
return "default";
}
/**
* Configure the RoleManager. Redeclared only because parent member is private.
*/
public void setRoleManager(RoleManager roles) {
super.setRoleManager(roles);
this.roles = roles;
}
/**
* Set the parent of this selector. This can be done after the selector is
* initialized, but <em>only once</em>. This allows this selector to be
* created by a component manager while still being able to have a parent.
*
* @param parent the parent selector
* @throws IllegalStateException if parent is already set
*/
public void setParentSelector(ComponentSelector parent) {
if (this.parentSelector != null) {
throw new IllegalStateException("Parent selector is already set");
}
this.parentSelector = parent;
this.parentComponents = new HashSet();
}
/**
* Get the role name for this selector. This is called by <code>configure()</code>
* to set the value of <code>this.roleName</code>.
*
* @return the role name, or <code>null<code> if it couldn't be determined.
*/
protected String getRoleName(Configuration config) {
// Get the role for this selector
String roleName = config.getAttribute("role", null);
if (roleName == null && this.roles != null) {
roleName = this.roles.getRoleForName(config.getName());
}
return roleName;
}
/**
* Configure this selector. This is the main difference with the parent class :
* <ul>
* <li>if {@link #getComponentInstanceName()} returns <code>null</code>,
* any child configurations having a attribute named as the result of
* {@link "getClassAttributeName()}, is considered as a component instance.
* </li>
* <li>if {@link #getComponentInstanceName()} returns a non-null value,
* only child configurations having this name are considered as a
* component instance.
* </li>
* <li>if other cases, it's name is considered to be a hint in the role manager.
* The behaviour is then the same as <code>ExcaliburComponentSelector</code>.
* </li>
*
* @param config the configuration
* @throws ConfigurationException if some hints aren't defined
*/
public void configure(Configuration config) throws ConfigurationException {
this.roleName = getRoleName(config);
// Pass a copy of the top-level object to superclass so that
// our name is properly initialized
// FIXME : could be avoided if parent m_role was protected or had protected accessors
DefaultConfiguration temp = new DefaultConfiguration(config.getName(), config.getLocation());
if (config.getAttribute("role", null) != null) {
temp.setAttribute("role", this.roleName);
}
super.configure(temp);
// Get default hint
this.defaultHint = config.getAttribute(this.getDefaultHintAttributeName(), null);
// Add components
String compInstanceName = getComponentInstanceName();
Configuration[] instances = config.getChildren();
for (int i = 0; i < instances.length; i++) {
Configuration instance = instances[i];
Object hint = instance.getAttribute("name").trim();
String classAttr = instance.getAttribute(getClassAttributeName(), null);
String className;
if (compInstanceName == null) {
// component-instance implicitly defined by the presence of the 'class' attribute
if (classAttr == null) {
className = this.roles.getDefaultClassNameForHint(roleName, instance.getName());
} else {
className = classAttr.trim();
}
} else {
// component-instances names explicitly defined
if (compInstanceName.equals(instance.getName())) {
className = (classAttr == null) ? null : classAttr.trim();
} else {
className = this.roles.getDefaultClassNameForHint(roleName, instance.getName());
}
}
if (className == null) {
String message = "Unable to determine class name for component named '" + hint +
"' at " + instance.getLocation();
getLogger().error(message);
throw new ConfigurationException(message);
}
try
{
Class clazz = this.classLoader.loadClass(className);
addComponent(hint, clazz, instance);
} catch(Exception e) {
String message = "Could not load class " + className + " for component named '" +
hint + "' at " + instance.getLocation();
getLogger().error(message, e);
throw new ConfigurationException(message, e);
}
}
}
/**
* Get the default hint, if any for this selector.
*/
public String getDefaultHint() {
return this.defaultHint;
}
public Component select(Object hint) throws ComponentException {
if (hint == null) {
hint = this.defaultHint;
}
if (parentSelector == null) {
// No parent : default behaviour
return super.select(hint);
} else {
// Try here first
try {
return super.select(hint);
} catch(ComponentException ce) {
// Doesn't exist here : try in parent selector
Component component = this.parentSelector.select(hint);
this.parentComponents.add(component);
return component;
}
}
}
public void release(Component component) {
// Was it selected on the parent ?
if (this.parentComponents != null && this.parentComponents.remove(component)) {
this.parentSelector.release(component);
} else {
super.release(component);
}
}
}
1.1 xml-cocoon2/src/java/org/apache/cocoon/components/LifecycleHelper.java
Index: LifecycleHelper.java
===================================================================
/*
============================================================================
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 <st...@apache.org>. For more information on the Apache
Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.cocoon.components;
import org.apache.avalon.framework.activity.Disposable;
import org.apache.avalon.framework.activity.Initializable;
import org.apache.avalon.framework.activity.Startable;
import org.apache.avalon.framework.component.ComponentManager;
import org.apache.avalon.framework.component.Composable;
import org.apache.avalon.framework.configuration.Configurable;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.context.Context;
import org.apache.avalon.framework.context.Contextualizable;
import org.apache.avalon.framework.logger.AbstractLoggable;
import org.apache.avalon.framework.logger.Loggable;
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.excalibur.component.RoleManageable;
import org.apache.avalon.excalibur.component.RoleManager;
import org.apache.avalon.excalibur.logger.LogKitManager;
import org.apache.avalon.excalibur.logger.LogKitManageable;
import org.apache.log.Logger;
/**
* Utility class for setting up Avalon components. Similar to Excalibur's
* <code>DefaultComponentFactory</code>, but on existing objects.
* <p>
* To be moved to Avalon ?
*
* @author <a href="mailto:sylvain@apache.org">Sylvain Wallez</a>
* @version CVS $Id: LifecycleHelper.java,v 1.1 2002/03/04 18:16:45 sylvain Exp $
*/
// FIXME : need to handle also LogEnabled.
public class LifecycleHelper
{
/** The Logger for the component
*/
private Logger m_logger;
/** The Context for the component
*/
private Context m_context;
/** The component manager for this component.
*/
private ComponentManager m_componentManager;
/** The configuration for this component.
*/
private Configuration m_configuration;
/** The RoleManager for child ComponentSelectors
*/
private RoleManager m_roles;
/** The LogKitManager for child ComponentSelectors
*/
private LogKitManager m_logkit;
/**
* Construct a new <code>LifecycleHelper</code> that can be used repeatedly to
* setup several components. <b>Note</b> : if a parameter is <code>null</code>,
* the corresponding method isn't called (e.g. if <code>configuration</code> is
* <code>null</code>, <code>configure()</code> isn't called).
*
* @param logger the <code>Logger</code> to pass to <code>Loggable</code>s, unless there is
* a <code>LogKitManager</code> and the configuration specifies a logger name.
* @param context the <code>Context</code> to pass to <code>Contexutalizable</code>s.
* @param componentManager the component manager to pass to <code>Composable</code>s.
* @param roles the <code>RoleManager</code> to pass to <code>DefaultComponentSelector</code>s.
* @param configuration the <code>Configuration</code> object to pass to new instances.
*/
public LifecycleHelper( final Logger logger,
final Context context,
final ComponentManager componentManager,
final RoleManager roles,
final LogKitManager logkit,
final Configuration configuration )
{
m_logger = logger;
m_context = context;
m_componentManager = componentManager;
m_roles = roles;
m_logkit = logkit;
m_configuration = configuration;
}
/**
* Setup a component, including initialization and start.
*
* @param component the component to setup.
* @return the component passed in, to allow function chaining.
* @throws Exception if something went wrong.
*/
public Object setupComponent(Object component)
throws Exception
{
return setupComponent(component, true);
}
/**
* Setup a component, and optionnaly initializes (if it's <code>Initializable</code>)
* and starts it (if it's <code>Startable</code>).
*
* @param component the component to setup.
* @param initializeAndStart if true, <code>intialize()</code> and <code>start()</code>
* will be called.
* @return the component passed in, to allow function chaining.
* @throws Exception if something went wrong.
*/
public Object setupComponent( Object component, boolean initializeAndStart )
throws Exception
{
return setupComponent( component,
m_logger,
m_context,
m_componentManager,
m_roles,
m_logkit,
m_configuration,
initializeAndStart );
}
/**
* Static equivalent to {@link #setupComponent(Object)}, to be used when there's only one
* component to setup.
*/
public static Object setupComponent( final Object component,
final Logger logger,
final Context context,
final ComponentManager componentManager,
final RoleManager roles,
final LogKitManager logkit,
final Configuration configuration )
throws Exception
{
return setupComponent( component,
logger,
context,
componentManager,
roles,
logkit,
configuration,
true );
}
/**
* Static equivalent to {@link #setupComponent(Object, boolean)}, to be used when there's only one
* component to setup.
*/
public static Object setupComponent( final Object component,
final Logger logger,
final Context context,
final ComponentManager componentManager,
final RoleManager roles,
final LogKitManager logkit,
final Configuration configuration,
final boolean initializeAndStart )
throws Exception
{
if( component instanceof Loggable )
{
Logger usedLogger;
if( null == logkit )
{
usedLogger = logger;
}
else if( configuration == null )
{
usedLogger = logger;
}
else
{
final String loggerName = configuration.getAttribute( "logger", null );
if( null == loggerName )
{
// No logger attribute available, using standard logger
usedLogger = logger;
}
else
{
usedLogger = logkit.getLogger( loggerName );
}
}
((Loggable)component).setLogger( usedLogger );
}
if( null != context && component instanceof Contextualizable )
{
((Contextualizable)component).contextualize( context );
}
if( null != componentManager && component instanceof Composable )
{
((Composable)component).compose( componentManager );
}
if( null != roles && component instanceof RoleManageable )
{
((RoleManageable)component).setRoleManager( roles );
}
if( null != logkit && component instanceof LogKitManageable )
{
((LogKitManageable)component).setLogKitManager( logkit );
}
if( null != configuration && component instanceof Configurable )
{
((Configurable)component).configure( configuration );
}
if( null != configuration && component instanceof Parameterizable )
{
((Parameterizable)component).
parameterize( Parameters.fromConfiguration( configuration ) );
}
if( initializeAndStart && component instanceof Initializable )
{
((Initializable)component).initialize();
}
if( initializeAndStart && component instanceof Startable )
{
((Startable)component).start();
}
return component;
}
/**
* Decomission a component, by stopping (if it's <code>Startable</code>) and
* disposing (if it's <code>Disposable</code>) a component.
*/
public static final void decommission( final Object component )
throws Exception
{
if( component instanceof Startable )
{
((Startable)component).stop();
}
dispose( component );
}
/**
* Dispose a component if it's <code>Disposable</code>. Otherwhise, do nothing.
*/
public static final void dispose( final Object component )
{
if ( component instanceof Disposable )
{
((Disposable)component).dispose();
}
}
}
----------------------------------------------------------------------
In case of troubles, e-mail: webmaster@xml.apache.org
To unsubscribe, e-mail: cocoon-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: cocoon-cvs-help@xml.apache.org