mcconnell 2003/02/27 15:13:43
Added: assembly/src/java/org/apache/avalon/assembly/lifecycle/context
AbstractContextualizer.java
DefaultContextualizer.java
DefaultContextualizer.xinfo
Log:
Assembly package standard contextualizer extension.
Revision Changes Path
1.1
avalon-sandbox/assembly/src/java/org/apache/avalon/assembly/lifecycle/context/AbstractContextualizer.java
Index: AbstractContextualizer.java
===================================================================
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, 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 "Jakarta", "Avalon", 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 [EMAIL PROTECTED]
*
* 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 (INCLUDING, 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. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.avalon.assembly.lifecycle.context;
import java.util.Map;
import java.lang.reflect.Constructor;
import org.apache.avalon.framework.context.Context;
import org.apache.avalon.framework.context.ContextException;
import org.apache.avalon.framework.context.Contextualizable;
import org.apache.avalon.framework.context.DefaultContext;
import org.apache.avalon.assembly.lifecycle.context.Contextualization;
import org.apache.avalon.meta.model.ContextDirective;
/**
* The abstract contextualizer class is a utility class that provides
* support for the establishment of a custom context argument based on
* mata info supplied under a context descriptor.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Avalon Development Team</a>
*/
public abstract class AbstractContextualizer implements Contextualization
{
//=======================================================================
// Extension
//=======================================================================
/**
* Handle the contextualization stage of a component lifecycle.
*
* @param descriptor the context descriptor
* @param object the object to contextualize
* @param map a map of context entries
* @exception ContextException if a contextualization error occurs
*/
public abstract void contextualize( ContextDirective directive, Object object,
Map map )
throws ContextException;
/**
* Returns a instance of a class established using the supplied map as a
* constructor argument.
*
* @param descriptor the context descriptor
* @param clazz the default class if no class defined in the descriptor
* @param map the context entry map
* @return the context argument value
*/
public Object createContextArgument( ContextDirective directive, Class clazz,
Map map )
throws ContextException
{
if( directive == null )
{
throw new NullPointerException( "directive" );
}
if( clazz == null )
{
throw new NullPointerException( "clazz" );
}
if( map == null )
{
throw new NullPointerException( "map" );
}
String classname = directive.getClassname();
Class base;
if( classname != null )
{
try
{
base = Thread.currentThread().getContextClassLoader().loadClass(
classname );
}
catch( ClassNotFoundException cnfe )
{
throw new ContextException(
"Could not find context class: " + classname, cnfe );
}
}
else
{
base = clazz;
}
try
{
Constructor constructor = base.getConstructor(
new Class[]{ Map.class } );
return constructor.newInstance( new Object[]{ map } );
}
catch( NoSuchMethodException e )
{
final String error =
"Custom context class: [" + classname
+ "] does not implement a constructor pattern <init>{ Map }.";
throw new ContextException( error, e );
}
catch( Throwable e )
{
throw new ContextException(
"Unexpected exception while creating context from "
+ base.getName(), e );
}
}
}
1.1
avalon-sandbox/assembly/src/java/org/apache/avalon/assembly/lifecycle/context/DefaultContextualizer.java
Index: DefaultContextualizer.java
===================================================================
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, 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 "Jakarta", "Avalon", 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 [EMAIL PROTECTED]
*
* 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 (INCLUDING, 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. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.avalon.assembly.lifecycle.context;
import java.util.Map;
import org.apache.avalon.assembly.lifecycle.context.AbstractContextualizer;
import org.apache.avalon.assembly.locator.Contextualizable;
import org.apache.avalon.assembly.locator.Locator;
import org.apache.avalon.assembly.locator.DefaultLocator;
import org.apache.avalon.framework.context.ContextException;
import org.apache.avalon.meta.model.ContextDirective;
/**
* Definition of an strategy handler that handles the Contextualization
* process. This implementation is provided as a template for alternative
* context handlers. The requirements for introduction of an alternative
* handler include:
* <ul>
* <li>A class implementing the [EMAIL PROTECTED] Contextualization} handler
interface.</li>
* <li>Declaration in the classes xinfo of the extension type where the
* type attribute value is a version interface reference corresponding
* to the interface that the target component must implement.</li>
* <li>Declaration by the target component in it's xinfo atttributes
* of the criteria for a custom context handler under the attribute
* key "urn:assembly:lifecycle.context.strategy" and value
* corresponding to the strategy type. </li>
* <li>Implementation of the strategy type interface by the target
* component.</li>
* </ul>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Avalon Development Team</a>
*/
public class DefaultContextualizer extends AbstractContextualizer
{
//=======================================================================
// Extension
//=======================================================================
/**
* Handle the contextualization stage of a component lifecycle.
*
* @param directive the context directive
* @param object the object to contextualize
* @param map a map of context entries
* @exception ContextException if a contextualization error occurs
*/
public void contextualize( ContextDirective directive, Object object, Map map )
throws ContextException
{
if( object instanceof Contextualizable )
{
Object context = createContextArgument( directive, DefaultLocator.class,
map );
if( context instanceof Locator )
{
( (Contextualizable)object ).contextualize( (Locator) context );
}
else
{
final String error =
"Requested context implementation class " +
context.getClass().getName()
+ " does not implement the Locator interface.";
throw new ContextException( error );
}
}
}
}
1.1
avalon-sandbox/assembly/src/java/org/apache/avalon/assembly/lifecycle/context/DefaultContextualizer.xinfo
Index: DefaultContextualizer.xinfo
===================================================================
<?xml version="1.0"?>
<!DOCTYPE type
PUBLIC "-//AVALON/Component Type DTD Version 1.0//EN"
"http://avalon.apache.org/dtds/meta/type_1_1.dtd"; >
<!--
Copyright (C) The Apache Software Foundation. All rights reserved.
This software is published under the terms of the Apache Software License
version 1.1, a copy of which has been included with this distribution in
the LICENSE.txt file.
@author Avalon Development Team
@version 1.0 12/03/2001
-->
<!--
Definition of the extension type phase support.
-->
<type>
<info>
<name>context</name>
</info>
<!--
Declaration of the lifecycle support phases that this manager provides.
-->
<extensions>
<extension type="org.apache.avalon.assembly.locator.Contextualizable"
phase="CONTEXT" />
</extensions>
</type>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
