donaldp 01/05/28 05:28:07
Modified: proposal/myrmidon/src/java/org/apache/ant Main.java
Added:
proposal/myrmidon/src/java/org/apache/myrmidon/components/embeddor
Embeddor.java MyrmidonEmbeddor.java
Removed: proposal/myrmidon/src/java/org/apache/ant/runtime
AntContextResources.java AntEngine.java
DefaultAntEngine.java
Log:
Move AntEngine->Embeddor to follow suit with Avalon+Framework JSR naming
conventions.
Revision Changes Path
1.15 +13 -13
jakarta-ant/proposal/myrmidon/src/java/org/apache/ant/Main.java
Index: Main.java
===================================================================
RCS file:
/home/cvs/jakarta-ant/proposal/myrmidon/src/java/org/apache/ant/Main.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- Main.java 2001/05/28 10:27:49 1.14
+++ Main.java 2001/05/28 12:28:05 1.15
@@ -20,15 +20,14 @@
import java.util.Iterator;
import java.util.List;
import java.util.Map;
-import java.util.Properties;
import org.apache.myrmidon.launcher.LauncherClassLoader;
import org.apache.ant.project.LogTargetToListenerAdapter;
import org.apache.ant.project.Project;
import org.apache.ant.project.ProjectBuilder;
import org.apache.ant.project.ProjectEngine;
import org.apache.ant.project.ProjectListener;
-import org.apache.ant.runtime.AntEngine;
-import org.apache.ant.runtime.DefaultAntEngine;
+import org.apache.myrmidon.components.embeddor.Embeddor;
+import org.apache.myrmidon.components.embeddor.MyrmidonEmbeddor;
import org.apache.myrmidon.api.JavaVersion;
import org.apache.myrmidon.api.TaskContext;
import org.apache.myrmidon.api.DefaultTaskContext;
@@ -45,6 +44,7 @@
import org.apache.avalon.framework.camelot.Deployer;
import org.apache.avalon.framework.camelot.DeploymentException;
import org.apache.avalon.framework.logger.AbstractLoggable;
+import org.apache.avalon.framework.parameters.Parameters;
import org.apache.log.Hierarchy;
import org.apache.log.Logger;
import org.apache.log.LogTarget;
@@ -275,10 +275,10 @@
//that was set up by launcher.
if( null == homeDir ) homeDir = System.getProperty( "ant.home" );
- final Properties properties = new Properties();
- properties.setProperty( "ant.home", homeDir );
+ final Parameters parameters = new Parameters();
+ parameters.setParameter( "ant.home", homeDir );
- if( null != taskLibDir ) properties.setProperty(
"ant.path.task-lib", taskLibDir );
+ if( null != taskLibDir ) parameters.setParameter(
"ant.path.task-lib", taskLibDir );
m_homeDir = (new File( homeDir )).getAbsoluteFile();
if( !m_homeDir.isDirectory() )
@@ -309,17 +309,17 @@
//getLogger().debug( "Ant Lib Directory: " + m_libDir );
//getLogger().debug( "Ant Task Lib Directory: " + m_taskLibDir );
- final AntEngine antEngine = new DefaultAntEngine();
- setupLogger( antEngine );
- antEngine.setProperties( properties );
- antEngine.initialize();
+ final Embeddor embeddor = new MyrmidonEmbeddor();
+ setupLogger( embeddor );
+ embeddor.parameterize( parameters );
+ embeddor.initialize();
- final ProjectBuilder builder = antEngine.getProjectBuilder();
+ final ProjectBuilder builder = embeddor.getProjectBuilder();
//create the project
final Project project = builder.build( buildFile );
- final ProjectEngine engine = antEngine.getProjectEngine();
+ final ProjectEngine engine = embeddor.getProjectEngine();
engine.addProjectListener( listener );
BufferedReader reader = null;
@@ -352,7 +352,7 @@
}
- antEngine.dispose();
+ embeddor.dispose();
}
/**
1.1
jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/embeddor/Embeddor.java
Index: Embeddor.java
===================================================================
/*
* 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 file.
*/
package org.apache.myrmidon.components.embeddor;
import org.apache.ant.project.ProjectBuilder;
import org.apache.ant.project.ProjectEngine;
import org.apache.avalon.framework.activity.Disposable;
import org.apache.avalon.framework.activity.Initializable;
import org.apache.avalon.framework.component.Component;
import org.apache.avalon.framework.parameters.Parameterizable;
/**
* Interface through which you embed Myrmidon into applications.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Peter Donald</a>
*/
public interface Embeddor
extends Component, Parameterizable, Initializable, Disposable
{
/**
* Retrieve builder for runtime.
* Valid after initialize() call
*
* @return the ProjectBuilder
*/
ProjectBuilder getProjectBuilder();
/**
* Retrieve project engine for runtime.
* Valid after initialize() call
*
* @return the ProjectBuilder
*/
ProjectEngine getProjectEngine();
}
1.1
jakarta-ant/proposal/myrmidon/src/java/org/apache/myrmidon/components/embeddor/MyrmidonEmbeddor.java
Index: MyrmidonEmbeddor.java
===================================================================
/*
* 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 file.
*/
package org.apache.myrmidon.components.embeddor;
import java.io.File;
import org.apache.ant.AntException;
import org.apache.ant.convert.engine.ConverterEngine;
import org.apache.ant.project.ProjectBuilder;
import org.apache.ant.project.ProjectEngine;
import org.apache.ant.tasklet.engine.DataTypeEngine;
import org.apache.ant.tasklet.engine.TaskletEngine;
import org.apache.ant.tasklet.engine.TskDeployer;
import org.apache.avalon.excalibur.io.FileUtil;
import org.apache.avalon.framework.activity.Initializable;
import org.apache.avalon.framework.camelot.CamelotUtil;
import org.apache.avalon.framework.camelot.DefaultFactory;
import org.apache.avalon.framework.camelot.Deployer;
import org.apache.avalon.framework.camelot.Factory;
import org.apache.avalon.framework.component.Component;
import org.apache.avalon.framework.component.Composable;
import org.apache.avalon.framework.component.DefaultComponentManager;
import org.apache.avalon.framework.logger.AbstractLoggable;
import org.apache.avalon.framework.parameters.Parameters;
import org.apache.avalon.framework.parameters.Parameterizable;
import org.apache.myrmidon.api.JavaVersion;
import org.apache.myrmidon.components.configurer.Configurer;
/**
* Default implementation of Ant runtime.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Peter Donald</a>
*/
public class MyrmidonEmbeddor
extends AbstractLoggable
implements Embeddor
{
private ConverterEngine m_converterEngine;
private DataTypeEngine m_dataTypeEngine;
private TaskletEngine m_taskEngine;
private ProjectEngine m_projectEngine;
private ProjectBuilder m_builder;
private TskDeployer m_deployer;
private Configurer m_configurer;
private Factory m_factory;
private DefaultComponentManager m_componentManager;
private Parameters m_parameters;
private Parameters m_defaults;
private File m_homeDir;
private File m_binDir;
private File m_libDir;
private File m_taskLibDir;
/**
* Setup basic properties of engine.
* Called before init() and can be used to specify alternate components
in system.
*
* @param properties the properties
*/
public void parameterize( final Parameters parameters )
{
m_parameters = parameters;
}
/**
* Retrieve builder for runtime.
* Valid after init() call
*
* @return the ProjectBuilder
*/
public ProjectBuilder getProjectBuilder()
{
return m_builder;
}
/**
* Retrieve project engine for runtime.
* Valid after init() call
*
* @return the ProjectBuilder
*/
public ProjectEngine getProjectEngine()
{
return m_projectEngine;
}
/**
* Initialize the system.
*
* @exception Exception if an error occurs
*/
public void initialize()
throws Exception
{
//setup default properties
m_defaults = createDefaultParameters();
//create all the components
m_factory = new DefaultFactory();
createComponents();
//setup the component manager
m_componentManager = createComponentManager();
setupComponents();
setupFiles();
CamelotUtil.deployFromDirectory( m_deployer, m_taskLibDir, ".tsk" );
}
/**
* Dispose engine.
*
* @exception Exception if an error occurs
*/
public void dispose()
throws Exception
{
m_converterEngine = null;
m_dataTypeEngine = null;
m_taskEngine = null;
m_projectEngine = null;
m_builder = null;
m_deployer = null;
m_configurer = null;
m_factory = null;
m_componentManager = null;
m_parameters = null;
m_defaults = null;
m_homeDir = null;
m_binDir = null;
m_libDir = null;
m_taskLibDir = null;
}
/**
* Create default properties which includes default names of all
components.
* Overide this in sub-classes to change values.
*
* @return the Parameters
*/
private Parameters createDefaultParameters()
{
final Parameters defaults = new Parameters();
//create all the default properties for files/directories
defaults.setParameter( "ant.path.bin", "bin" );
defaults.setParameter( "ant.path.lib", "lib" );
defaults.setParameter( "ant.path.task-lib", "lib" );
//create all the default properties for components
defaults.setParameter( "ant.comp.converter",
"org.apache.ant.convert.engine.DefaultConverterEngine" );
defaults.setParameter( "ant.comp.datatype",
"org.apache.ant.tasklet.engine.DefaultDataTypeEngine" );
defaults.setParameter( "ant.comp.task",
"org.apache.ant.tasklet.engine.DefaultTaskletEngine" );
defaults.setParameter( "ant.comp.project",
"org.apache.ant.project.DefaultProjectEngine" );
defaults.setParameter( "ant.comp.builder",
"org.apache.ant.project.DefaultProjectBuilder"
);
defaults.setParameter( "ant.comp.deployer",
"org.apache.ant.tasklet.engine.DefaultTskDeployer" );
defaults.setParameter( "ant.comp.configurer",
"org.apache.myrmidon.components.configurer.DefaultConfigurer" );
return defaults;
}
/**
* Create a ComponentManager containing all components in engine.
*
* @return the ComponentManager
*/
private DefaultComponentManager createComponentManager()
{
final DefaultComponentManager componentManager = new
DefaultComponentManager();
componentManager.put( "org.apache.ant.tasklet.engine.TaskletEngine",
m_taskEngine );
componentManager.put( "org.apache.ant.project.ProjectEngine",
m_projectEngine );
componentManager.put( "org.apache.ant.convert.engine.ConverterEngine",
m_converterEngine );
componentManager.put( "org.apache.ant.convert.Converter",
m_converterEngine );
componentManager.put( "org.apache.ant.tasklet.engine.DataTypeEngine",
m_dataTypeEngine );
componentManager.put( "org.apache.ant.project.ProjectBuilder",
m_builder );
componentManager.put( "org.apache.ant.tasklet.engine.TskDeployer",
m_deployer );
componentManager.put( "org.apache.avalon.framework.camelot.Factory",
m_factory );
componentManager.put(
"org.apache.myrmidon.components.configurer.Configurer", m_configurer );
return componentManager;
}
/**
* Create all required components.
*
* @exception Exception if an error occurs
*/
private void createComponents()
throws Exception
{
String component = null;
component = getParameter( "ant.comp.converter" );
m_converterEngine = (ConverterEngine)createComponent( component,
ConverterEngine.class );
component = getParameter( "ant.comp.datatype" );
m_dataTypeEngine = (DataTypeEngine)createComponent( component,
DataTypeEngine.class );
component = getParameter( "ant.comp.task" );
m_taskEngine = (TaskletEngine)createComponent( component,
TaskletEngine.class );
component = getParameter( "ant.comp.project" );
m_projectEngine = (ProjectEngine)createComponent( component,
ProjectEngine.class );
component = getParameter( "ant.comp.builder" );
m_builder =(ProjectBuilder)createComponent( component,
ProjectBuilder.class );
component = getParameter( "ant.comp.deployer" );
m_deployer = (TskDeployer)createComponent( component,
TskDeployer.class );
component = getParameter( "ant.comp.configurer" );
m_configurer = (Configurer)createComponent( component,
Configurer.class );
}
/**
* Setup all the components. (ir run all required lifecycle methods).
*
* @exception Exception if an error occurs
*/
private void setupComponents()
throws Exception
{
setupComponent( m_factory );
setupComponent( m_converterEngine );
setupComponent( m_dataTypeEngine );
setupComponent( m_taskEngine );
setupComponent( m_projectEngine );
setupComponent( m_builder );
setupComponent( m_deployer );
setupComponent( m_configurer );
}
/**
* Setup an individual component.
*
* @param component the component
* @exception Exception if an error occurs
*/
private void setupComponent( final Component component )
throws Exception
{
setupLogger( component );
if( component instanceof Composable )
{
((Composable)component).compose( m_componentManager );
}
if( component instanceof Initializable )
{
((Initializable)component).initialize();
}
}
/**
* Setup all the files attributes.
*/
private void setupFiles()
{
String filepath = null;
filepath = getParameter( "ant.home" );
m_homeDir = (new File( filepath )).getAbsoluteFile();
checkDirectory( m_homeDir, "ant-home" );
filepath = getParameter( "ant.path.bin" );
m_binDir = resolveDirectory( filepath, "bin-dir" );
filepath = getParameter( "ant.path.lib" );
m_libDir = resolveDirectory( filepath, "lib-dir" );
filepath = getParameter( "ant.path.task-lib" );
m_taskLibDir = resolveDirectory( filepath, "task-lib-dir" );
}
/**
* Retrieve value of named property.
* First access passed in properties and then the default properties.
*
* @param name the name of property
* @return the value of property or null
*/
private String getParameter( final String name )
{
String value = m_parameters.getParameter( name, null );
if( null == value )
{
value = m_defaults.getParameter( name, null );
}
return value;
}
/**
* Resolve a directory relative to another base directory.
*
* @param dir the base directory
* @param name the relative directory
* @return the created File
* @exception AntException if an error occurs
*/
private File resolveDirectory( final String dir, final String name )
throws AntException
{
final File file = FileUtil.resolveFile( m_homeDir, dir );
checkDirectory( file, name );
return file;
}
/**
* Verify file is a directory else throw an exception.
*
* @param file the File
* @param name the name of file type (used in error messages)
*/
private void checkDirectory( final File file, final String name )
throws AntException
{
if( !file.exists() )
{
throw new AntException( name + " (" + file + ") does not exist" );
}
else if( !file.isDirectory() )
{
throw new AntException( name + " (" + file + ") is not a
directory" );
}
}
/**
* Helper method to retrieve current JVM version.
* Basically stolen from original Ant sources.
*
* @return the current JVM version
*/
private JavaVersion getJavaVersion()
{
JavaVersion version = JavaVersion.JAVA1_0;
try
{
Class.forName( "java.lang.Void" );
version = JavaVersion.JAVA1_1;
Class.forName( "java.lang.ThreadLocal" );
version = JavaVersion.JAVA1_2;
Class.forName( "java.lang.StrictMath" );
version = JavaVersion.JAVA1_3;
}
catch( final ClassNotFoundException cnfe ) {}
return version;
}
/**
* Create a component that implements an interface.
*
* @param component the name of the component
* @param clazz the name of interface/type
* @return the created object
* @exception AntException if an error occurs
*/
private Object createComponent( final String component, final Class clazz
)
throws AntException
{
try
{
final Object object = Class.forName( component ).newInstance();
if( !clazz.isInstance( object ) )
{
throw new AntException( "Object " + component + " is not an
instance of " +
clazz );
}
return object;
}
catch( final IllegalAccessException iae )
{
throw new AntException( "Non-public constructor for " + clazz + "
" + component,
iae );
}
catch( final InstantiationException ie )
{
throw new AntException( "Error instantiating class for " + clazz
+ " " + component,
ie );
}
catch( final ClassNotFoundException cnfe )
{
throw new AntException( "Could not find the class for " + clazz +
" (" + component + ")", cnfe );
}
}
}
