package org.codehaus.plexus.configuration.processor;
/*
* The MIT License
*
* Copyright (c) 2004, The Codehaus
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is furnished to do
* so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
import org.codehaus.plexus.configuration.PlexusConfiguration;
import org.codehaus.plexus.configuration.xml.XmlPlexusConfiguration;
import org.codehaus.plexus.util.StringUtils;
import java.util.HashMap;
import java.util.Map;
/**
* Take a normal PlexusConfiguration and look for directives within it
* that allow the inlining of external configuration sources.
*
* @todo could this be amalgamated with the expression handling in the component configurator? It cannot be used here,
* as it requires actual objects to be returned, which cannot be stored back into a configuration object.
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @version $Id: ConfigurationProcessor.java 1708 2005-04-15 04:47:38Z brett $
*/
public class ConfigurationProcessor
{
protected Map handlers;
public ConfigurationProcessor()
{
handlers = new HashMap();
}
public void addConfigurationResourceHandler( ConfigurationResourceHandler handler )
{
handlers.put( handler.getId(), handler );
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
public PlexusConfiguration process( PlexusConfiguration configuration, Map variables )
throws ConfigurationResourceNotFoundException, ConfigurationProcessingException
{
XmlPlexusConfiguration processed = new XmlPlexusConfiguration( "configuration" );
walk( configuration, processed, variables );
return processed;
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
protected void walk( PlexusConfiguration source, PlexusConfiguration processed, Map variables )
throws ConfigurationResourceNotFoundException, ConfigurationProcessingException
{
PlexusConfiguration[] children = source.getChildren();
for ( int i = 0; i < children.length; i++ )
{
PlexusConfiguration child = children[i];
int count = child.getChildCount();
if ( count > 0 )
{
// ----------------------------------------------------------------------
// If we have a child with children itself then we must make a configuration
// with the name of the child, add that child to the processed configuration
// and walk the child.
//
// <configuration>
// <child>
// <entity>
// <foo>bar</foo>
// </entity>
// </child>
// </configuration>
//
// ----------------------------------------------------------------------
XmlPlexusConfiguration processedChild = new XmlPlexusConfiguration( child.getName() );
copyAttributes( child, processedChild );
processed.addChild( processedChild );
walk( child, processedChild, variables );
}
else
{
String elementName = child.getName();
// ----------------------------------------------------------------------
// Check to see if this element name matches the id of any of our
// source resource handlers.
// ----------------------------------------------------------------------
if ( handlers.containsKey( elementName ) )
{
ConfigurationResourceHandler handler = (ConfigurationResourceHandler) handlers.get( elementName );
PlexusConfiguration[] configurations = handler.handleRequest( createHandlerParameters( child, variables ) );
for ( int j = 0; j < configurations.length; j++ )
{
processed.addChild( configurations[j] );
}
}
else
{
processed.addChild( child );
}
}
}
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
protected Map createHandlerParameters( PlexusConfiguration c, Map variables )
{
Map parameters = new HashMap();
String[] parameterNames = c.getAttributeNames();
for ( int i = 0; i < parameterNames.length; i++ )
{
String key = parameterNames[i];
String value = StringUtils.interpolate( c.getAttribute( key, null ), variables );
parameters.put( key, value );
}
return parameters;
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
private void copyAttributes( PlexusConfiguration source, XmlPlexusConfiguration target )
{
String[] names = source.getAttributeNames();
for ( int i = 0; i < names.length; i++ )
{
target.setAttribute( names[i], source.getAttribute( names[i], null ) );
}
}
}