mcconnell 2002/11/19 04:27:48
Added: assembly/src/java/org/apache/excalibur/assembly/appliance
DefaultApplianceManager.java
Log:
Initial default implemetation of an ApplianceManager.
Revision Changes Path
1.1
jakarta-avalon-excalibur/assembly/src/java/org/apache/excalibur/assembly/appliance/DefaultApplianceManager.java
Index: DefaultApplianceManager.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.excalibur.assembly.appliance;
import java.util.Map;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.ArrayList;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.context.Context;
import org.apache.avalon.framework.context.ContextException;
import org.apache.avalon.framework.context.Contextualizable;
import org.apache.excalibur.meta.info.Type;
import org.apache.excalibur.meta.model.Profile;
import org.apache.excalibur.assembly.appliance.builder.ApplianceBuilder;
import org.apache.excalibur.assembly.profile.DefaultProfileManager;
import org.apache.excalibur.meta.info.DependencyDescriptor;
import org.apache.excalibur.meta.info.StageDescriptor;
import org.apache.excalibur.meta.info.ReferenceDescriptor;
/**
* The default appliance manager provides support for {@link Appliance}
* creation, registration and retrival.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Stephen McConnell</a>
* @version $Revision: 1.1 $ $Date: 2002/11/19 12:27:48 $
*/
public final class DefaultApplianceManager extends DefaultProfileManager
implements ApplianceManager
{
//==================================================================
// static
//==================================================================
/**
* The default appliacnce buildier.
*/
private static final ApplianceBuilder m_builder = new ApplianceBuilder();
/**
* Creation of a new Appliance instance from a profile and configuration.
* @param profile the profile to manager
* @param config the appliance configuration
* @return a non-initialized appliance instance
*/
public static Appliance createAppliance( Profile profile, Configuration config )
throws ApplianceException
{
try
{
return m_builder.createAppliance( profile, config );
}
catch( Throwable e )
{
final String error =
"Build failure while attempting to create appliance for profile: "
+ profile;
throw new ApplianceException( error, e );
}
}
/**
* Creation of a new Appliance instance based on a supplied profile, enabled
state and activation policy.
*/
public static Appliance createAppliance( Profile profile, boolean enabled,
boolean activation )
throws ApplianceException
{
return m_builder.createAppliance( profile, enabled, activation );
}
//==================================================================
// state
//==================================================================
/**
* The parent appliance manager.
*/
private ApplianceManager m_parent;
/**
* The classloader.
*/
private ClassLoader m_loader;
/**
* Table of component profiles keyed by profile name.
*/
private final Map m_appliances = new Hashtable();
//==================================================================
// constructor
//==================================================================
public DefaultApplianceManager( ApplianceManager parent, ClassLoader classloader
)
{
super( parent, classloader );
m_parent = parent;
m_loader = classloader;
}
//==================================================================
// ApplianceManager
//==================================================================
/**
* Return the set of appliance istances capable of supporting the supplied
dependency.
* @param dependency a service dependency descriptor
* @return a matching appliance
*/
public Appliance[] getAppliances( DependencyDescriptor dependency )
{
ArrayList list = new ArrayList();
if( m_parent != null )
{
Appliance[] appliances = m_parent.getAppliances( dependency );
for( int i=0; i<appliances.length; i++ )
{
list.add( appliances[i] );
}
}
ReferenceDescriptor reference = dependency.getReference();
Iterator iterator = m_appliances.entrySet().iterator();
while( iterator.hasNext() )
{
Appliance appliance = (Appliance) iterator.next();
Object service = appliance.getProfile().getType().getService( reference
);
if( service != null )
{
list.add( appliance );
}
}
return (Appliance[]) list.toArray( new Appliance[0] );
}
/**
* Return the set of appliance instances that provide the supplied extension.
* @param service a service descriptor
* @return a set of types that provide the supplied service
*/
public Appliance[] getAppliances( StageDescriptor stage )
{
ArrayList list = new ArrayList();
if( m_parent != null )
{
Appliance[] appliances = m_parent.getAppliances( stage );
for( int i=0; i<appliances.length; i++ )
{
list.add( appliances[i] );
}
}
Iterator iterator = m_appliances.entrySet().iterator();
while( iterator.hasNext() )
{
Appliance appliance = (Appliance) iterator.next();
if( appliance.isEnabled()
&& ( appliance.getProfile().getType().getExtension( stage ) != null ) )
{
list.add( appliance );
}
}
return (Appliance[]) list.toArray( new Appliance[0] );
}
/**
* Select an appliance supporting the supplied dependency using a supplied
selector.
* @param dependency a service depedency descriptor
* @param selector the applaice selector
* @return the selected appliance (possibly null)
*/
public Appliance getAppliance( DependencyDescriptor dependency,
ApplianceSelector selector )
{
Appliance[] appliances = getAppliances( dependency );
return selector.select( appliances, dependency );
}
/**
* Select an appliance capable of supporting the supplied stage
* @param stage a lifecycle stage
* @param selector an appliance selector
* @return the selected appliance (possibly null)
*/
public Appliance getAppliance( StageDescriptor stage, ApplianceSelector selector
)
{
Appliance[] appliances = getAppliances( stage );
return selector.select( appliances, stage );
}
//==================================================================
// implemetation
//==================================================================
/**
* Add a appliance to the manager.
* @param appliance the appliance to add to the manager
* @exception DuplicateApplianceException if an appliance has already been
registered
* for the undrlying profile
*/
public void addAppliance( Appliance appliance ) throws
DuplicateApplianceException
{
if( appliance == null )
{
throw new NullPointerException( "appliance" );
}
final String key = appliance.getProfile().getName();
if( m_appliances.get( key ) != null )
{
throw new DuplicateApplianceException( key );
}
m_appliances.put( key, appliance );
}
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
