You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by hl...@apache.org on 2003/06/10 19:58:20 UTC
cvs commit: jakarta-commons-sandbox/hivemind/src/test/hivemind/test HiveMindSuite.java
hlship 2003/06/10 10:58:20
Modified: hivemind .classpath project.xml
hivemind/xdocs services.xml navigation.xml
hivemind/src/test/hivemind/test HiveMindSuite.java
Added: hivemind/src/test/hivemind/test/ant
TestManifestClassPath.java
hivemind/xdocs/ant index.xml ManifestClassPath.xml
hivemind/src/java/org/apache/commons/hivemind/ant
ManifestClassPath.java
Log:
Add Ant task for helping with Manifest Class-Path.
Revision Changes Path
1.1 jakarta-commons-sandbox/hivemind/src/test/hivemind/test/ant/TestManifestClassPath.java
Index: TestManifestClassPath.java
===================================================================
/*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2003 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 acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Commons", 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 names without prior written
* permission of the Apache Group.
*
* 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 hivemind.test.ant;
import java.io.File;
import hivemind.test.HiveMindTestCase;
import org.apache.commons.hivemind.ant.ManifestClassPath;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Target;
import org.apache.tools.ant.types.FileSet;
import org.apache.tools.ant.types.Path;
public class TestManifestClassPath extends HiveMindTestCase
{
public class Driver extends ManifestClassPath
{
public Driver()
{
project = new Project();
project.init();
taskType = "manifestClassPath";
taskName = "manfiestClassPath";
target = new Target();
}
}
public TestManifestClassPath(String name)
{
super(name);
}
public void testSimple() throws Exception
{
Project p = new Project();
Target t = new Target();
ManifestClassPath mcp = new ManifestClassPath();
mcp.setProject(p);
mcp.setOwningTarget(t);
mcp.setTaskName("manifestClassPath");
mcp.setProperty("output");
assertEquals("output", mcp.getProperty());
Path path = mcp.createClasspath();
Path.PathElement pe = path.createPathElement();
pe.setLocation(new File("src/META-INF/hivemodule.xml"));
pe = path.createPathElement();
pe.setLocation(new File("src/java/org/apache/commons/hivemind/HiveMind.properties"));
mcp.execute();
assertEquals("hivemodule.xml HiveMind.properties", p.getProperty("output"));
}
public void testDirectory() throws Exception
{
Project p = new Project();
Target t = new Target();
ManifestClassPath mcp = new ManifestClassPath();
mcp.setProject(p);
mcp.setOwningTarget(t);
mcp.setTaskName("manifestClassPath");
mcp.setProperty("output");
assertEquals("output", mcp.getProperty());
File dir = new File("src").getAbsoluteFile();
mcp.setDirectory(dir);
assertEquals(dir, mcp.getDirectory());
Path path = mcp.createClasspath();
Path.PathElement pe = path.createPathElement();
pe.setLocation(new File("src/META-INF/hivemodule.xml"));
pe = path.createPathElement();
pe.setLocation(new File("src/java/org/apache/commons/hivemind/HiveMind.properties"));
pe = path.createPathElement();
pe.setLocation(new File("common/links.xml"));
mcp.execute();
assertEquals(
"META-INF/hivemodule.xml java/org/apache/commons/hivemind/HiveMind.properties",
p.getProperty("output"));
}
public void testEmpty() throws Exception
{
Project p = new Project();
Target t = new Target();
ManifestClassPath mcp = new ManifestClassPath();
mcp.setProject(p);
mcp.setOwningTarget(t);
mcp.setTaskName("manifestClassPath");
mcp.setProperty("zap");
assertEquals("zap", mcp.getProperty());
mcp.createClasspath();
mcp.execute();
assertEquals("", p.getProperty("zap"));
}
public void testNoProperty() throws Exception
{
Project p = new Project();
Target t = new Target();
ManifestClassPath mcp = new ManifestClassPath();
mcp.setProject(p);
mcp.setOwningTarget(t);
mcp.setTaskName("manifestClassPath");
mcp.createClasspath();
try
{
mcp.execute();
unreachable();
}
catch (BuildException ex)
{
checkException(ex, "You must specify a property to assign the manifest classpath to");
}
}
public void testNoClasspath() throws Exception
{
Project p = new Project();
Target t = new Target();
ManifestClassPath mcp = new ManifestClassPath();
mcp.setProject(p);
mcp.setOwningTarget(t);
mcp.setTaskName("manifestClassPath");
mcp.setProperty("bar");
try
{
mcp.execute();
unreachable();
}
catch (BuildException ex)
{
checkException(ex, "You must specify a classpath to generate the manifest entry from");
}
}
}
1.1 jakarta-commons-sandbox/hivemind/xdocs/ant/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<!-- $Id: index.xml,v 1.1 2003/06/10 17:58:19 hlship Exp $ -->
<document>
<properties>
<title>HiveMind Ant Tasks</title>
<author email="hlship@apache.org">Howard M. Lewis Ship</author>
</properties>
<body>
<section name="HiveMind Ant Tasks">
<p>The HiveMind JAR includes an Ant task that is useful in assembling
applications.</p>
<p>The names provided in the table below are suggestions, you must use an
Ant <taskdef> to define these, i.e.:
<source><![CDATA[
<taskdef name="manifestclasspath" classname="org.apache.commons.hivemind.ant.ManifestClassPath">
<classpath>
<pathelement location="lib/commons-hivemind-1.0.jar"/>
</classpath>
</taskdef>
]]></source>
</p>
<table>
<tr>
<th>Task Name</th>
<th>Task Class</th>
<th>Description</th>
</tr>
<tr>
<td>
<a href="ManifestClassPath.html">ManifestClassPath</a>
</td>
<td>org.apache.commons.hivemind.ant.ManifestClassPath</td>
<td>Creates a Manifest Class-Path entry for a module, which is useful
for ensuring that all modules will be in the classpath when
executing an application as an Enterprise Application Archive.</td>
</tr>
</table>
</section>
</body>
</document>
1.1 jakarta-commons-sandbox/hivemind/xdocs/ant/ManifestClassPath.xml
Index: ManifestClassPath.xml
===================================================================
<?xml version="1.0"?>
<!-- $Id: ManifestClassPath.xml,v 1.1 2003/06/10 17:58:19 hlship Exp $ -->
<document>
<properties>
<title>ManifestClassPath Ant Task</title>
<author email="hlship@apache.org">Howard M. Lewis Ship</author>
</properties>
<body>
<section name="Description">
<p>
Converts a classpath into a space-separated list of items used to
set the <code>Manifest Class-Path</code> attribute.
</p>
<p>
This is highly useful when modules are packaged together inside an Enterprise Application
Archive (EAR). Library modules may be deployed inside an EAR, but (in the current
J2EE specs), there's no way for such modules to be added to the classpath in the deployment
descriptor; instead, each JAR is expected to have a Manifest Class-Path attribute identifying
the exactly list of JARs that should be in the classpath. This Task is used to generate that list.
</p>
</section>
<section name="Parameters">
<table>
<tr>
<th>Attribute</th> <th>Description</th> <th>Required</th>
</tr>
<tr>
<td>property</td>
<td>The name of a property to set as a result of executing the task.</td>
<td>Yes</td>
</tr>
<tr>
<td>directory</td>
<td>If specified, then the directories does two things:
<ul>
<li>It acts as a filter, limiting the results to just those elements that are within the directory</li>
<li>It strips off the directory as a prefix (plus the separator), creating results that are
relative to the directory.
</li>
</ul>
</td>
<td>
No</td>
</tr>
</table>
</section>
<section name="Parameters specified as nested elements">
<subsection name="classpath">
<p>A path-like structure, used to identify what the classpath should be. </p>
</subsection>
</section>
<section name="Examples">
<p>
Generate a list of JARs inside the <code>${target}</code> directory as relative paths
and use it to set the Class-Path manifest attribute.
</p>
<source><![CDATA[
<manifestclasspath directory="${target}" property="manifest.class.path">
<classpath refid="build.class.path"/>
</manifestclasspath>
<jar . . .>
<manifest>
<attribute name="Class-Path" value="${manifest.class.path}"/>
. . .
</manifest>
</jar>
]]>
</source>
</section>
</body>
</document>
1.3 +1 -0 jakarta-commons-sandbox/hivemind/.classpath
Index: .classpath
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/hivemind/.classpath,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- .classpath 6 Jun 2003 21:56:29 -0000 1.2
+++ .classpath 10 Jun 2003 17:58:20 -0000 1.3
@@ -18,5 +18,6 @@
<classpathentry kind="var" path="MAVEN_REPOS_DIR/servletapi/jars/servletapi-2.3.jar"/>
<classpathentry kind="var" path="MAVEN_REPOS_DIR/xml-apis/jars/xml-apis-1.0.b2.jar"/>
<classpathentry kind="var" path="MAVEN_REPOS_DIR/jakarta-tapestry/jars/tapestry-3.0-beta-1a.jar"/>
+ <classpathentry kind="var" path="MAVEN_REPOS_DIR/ant/jars/ant-1.5.1.jar"/>
<classpathentry kind="output" path="bin"/>
</classpath>
1.6 +15 -6 jakarta-commons-sandbox/hivemind/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/hivemind/project.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- project.xml 9 Jun 2003 22:23:07 -0000 1.5
+++ project.xml 10 Jun 2003 17:58:20 -0000 1.6
@@ -8,23 +8,24 @@
<organization>
<name>Apache Software Foundation</name>
<url>http://jakarta.apache.org/</url>
+ <logo>/images/jakarta-logo-blue.png</logo>
</organization>
<inceptionYear>2003</inceptionYear>
<package>org.apache.commons.hivemind</package>
-
+ <logo>/images/HiveMind-Logo.png</logo>
<shortDescription>Dynamic services and configuration microkernel</shortDescription>
<!-- Gump integration -->
<gumpRepositoryId>jakarta</gumpRepositoryId>
<description>
- HiveMind is a dynamic services and configuration microkernel Its primary
+ HiveMind is a dynamic services and configuration microkernel. Its primary
feature is the dynamic creation of a runtime registry of services and
configuration data, where any HiveMind module may contribute extensions
to any other HiveMind module.
</description>
- <url>http://jakarta.apache.org/commons/hivemind</url>
+ <url>http://jakarta.apache.org/commons/sandbox/hivemind</url>
<issueTrackingUrl>http://issues.apache.org/bugzilla</issueTrackingUrl>
<siteAddress>jakarta.apache.org</siteAddress>
<siteDirectory>
@@ -36,7 +37,7 @@
<repository>
<connection>
- scm:cvs:pserver:anoncvs@cvs.apache.org:/home/cvspublic
+ scm:cvs:pserver:anoncvs@cvs.apache.org:/home/cvspublic/jakarta-commons-sandbox/hivemind
</connection>
<url>
http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/hivemind
@@ -64,12 +65,20 @@
<name>Howard M. Lewis Ship</name>
<id>hlship</id>
<email>hlship@apache.org</email>
- <roles>Troublemaker</roles>
+ <roles>
+ <role>Troublemaker</role>
+ </roles>
</developer>
</developers>
<dependencies>
+ <dependency>
+ <id>ant</id>
+ <version>1.5.1</version>
+ <url>http://ant.apache.org/</url>
+ </dependency>
+
<dependency>
<id>xerces</id>
<version>2.3.0</version>
1.1 jakarta-commons-sandbox/hivemind/src/java/org/apache/commons/hivemind/ant/ManifestClassPath.java
Index: ManifestClassPath.java
===================================================================
/*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2003 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 acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Commons", 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 names without prior written
* permission of the Apache Group.
*
* 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.commons.hivemind.ant;
import java.io.File;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.types.Path;
/**
* Utility used to create a manifest class path.
* It takes, as input, a reference to a path. It converts this
* into a space-separated list of file names. The default
* behavior is to simply strip off the directory portion of
* each file entirely.
*
* <p>
* The final result is assigned to the property.
*
* @author Howard Lewis Ship
* @version $Id: ManifestClassPath.java,v 1.1 2003/06/10 17:58:20 hlship Exp $
*/
public class ManifestClassPath extends Task
{
private String _property;
private Path _classpath;
private File _directory;
public Path createClasspath()
{
_classpath = new Path(project);
return _classpath;
}
public String getProperty()
{
return _property;
}
public void setProperty(String string)
{
_property = string;
}
public void execute()
{
if (_classpath == null)
throw new BuildException("You must specify a classpath to generate the manifest entry from");
if (_property == null)
throw new BuildException("You must specify a property to assign the manifest classpath to");
StringBuffer buffer = new StringBuffer();
String[] paths = _classpath.list();
String stripPrefix = null;
if (_directory != null)
stripPrefix = _directory.getPath();
// Will paths ever be null?
boolean needSep = false;
for (int i = 0; i < paths.length; i++)
{
String path = paths[i];
if (stripPrefix != null)
{
if (!path.startsWith(stripPrefix))
continue;
if (needSep)
buffer.append(' ');
// Strip off the directory and the seperator, leaving
// just the relative path.
buffer.append(filter(path.substring(stripPrefix.length() + 1)));
needSep = true;
}
else
{
if (needSep)
buffer.append(' ');
File f = new File(path);
buffer.append(f.getName());
needSep = true;
}
}
project.setProperty(_property, buffer.toString());
}
public File getDirectory()
{
return _directory;
}
/**
* Sets a containing directory. This has two effects:
* <ul>
* <li>Only files in the classpath that are contained by the directory are included.
* <li>The directory path is stripped from each path, leaving a relative path
* to the file.
* </ul>
*/
public void setDirectory(File file)
{
_directory = file;
}
/**
* Classpath entries must use a forward slash, regardless of what the
* local filesystem uses.
*/
protected String filter(String value)
{
if (File.separatorChar == '/')
return value;
return value.replace(File.separatorChar, '/');
}
}
1.5 +6 -4 jakarta-commons-sandbox/hivemind/xdocs/services.xml
Index: services.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/hivemind/xdocs/services.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- services.xml 9 Jun 2003 22:23:07 -0000 1.4
+++ services.xml 10 Jun 2003 17:58:20 -0000 1.5
@@ -150,9 +150,11 @@
dependencies. Here, the module supplying the implementation is dependent
on the module supplying the interface.</p>
<p>The runtime code to access the service is very streamlined:</p>
- <source>IRegistry registry = HiveMind.getDefault(); IAdder service =
- (IAdder) registry.getService("com.myco.mypackage.Adder", IAdder.class);
- int sum = service.add(4, 7);</source>
+ <source><![CDATA[
+IRegistry registry = HiveMind.getDefault();
+IAdder service = (IAdder) registry.getService("com.myco.mypackage.Adder", IAdder.class);
+int sum = service.add(4, 7);
+]]></source>
<p>Another module may provide an interceptor:</p>
<source><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
1.3 +3 -0 jakarta-commons-sandbox/hivemind/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/hivemind/xdocs/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 4 Jun 2003 03:05:49 -0000 1.2
+++ navigation.xml 10 Jun 2003 17:58:20 -0000 1.3
@@ -8,6 +8,9 @@
<menu name="Reference">
<item name="Services" href="/services.html"/>
<item name="Module Descriptor" href="/descriptor.html"/>
+ <item name="Ant Tasks" href="/ant/index.html" collapse="true">
+ <item name="ManifestClassPath" href="/ant/ManifestClassPath.html"/>
+ </item>
</menu>
</body>
</project>
1.6 +2 -0 jakarta-commons-sandbox/hivemind/src/test/hivemind/test/HiveMindSuite.java
Index: HiveMindSuite.java
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/hivemind/src/test/hivemind/test/HiveMindSuite.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- HiveMindSuite.java 9 Jun 2003 22:23:07 -0000 1.5
+++ HiveMindSuite.java 10 Jun 2003 17:58:20 -0000 1.6
@@ -57,6 +57,7 @@
package hivemind.test;
+import hivemind.test.ant.TestManifestClassPath;
import hivemind.test.config.TestConfiguration;
import hivemind.test.external.TestExternalParser;
import hivemind.test.parse.TestDescriptorParser;
@@ -77,6 +78,7 @@
suite.addTestSuite(TestConfiguration.class);
suite.addTestSuite(TestRegistryBuilder.class);
suite.addTestSuite(TestToString.class);
+ suite.addTestSuite(TestManifestClassPath.class);
return suite;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org