You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by up...@apache.org on 2003/10/13 14:08:10 UTC
cvs commit: cocoon-2.1/src/java/org/apache/cocoon/bean/helpers AntDelegate.java BeanConfigurator.java
upayavira 2003/10/13 05:08:10
Modified: src/java/org/apache/cocoon Main.java
src/java/org/apache/cocoon/bean CocoonBean.java
src/java/org/apache/cocoon/bean/helpers
BeanConfigurator.java
Added: src/java/org/apache/cocoon CocoonTask.java
src/java/org/apache/cocoon/bean/helpers AntDelegate.java
Log:
Added a simple Ant task (derived from the Ant Java and ExecuteJava classes), with significant help from Dominique Devienne
Revision Changes Path
1.23 +3 -15 cocoon-2.1/src/java/org/apache/cocoon/Main.java
Index: Main.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/java/org/apache/cocoon/Main.java,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- Main.java 10 Oct 2003 14:11:50 -0000 1.22
+++ Main.java 13 Oct 2003 12:08:10 -0000 1.23
@@ -344,7 +344,7 @@
cocoon.addTargets(line.getArgList(), destDir);
- System.out.println(getProlog());
+ listener.messageGenerated(CocoonBean.getProlog());
cocoon.initialize();
cocoon.process();
@@ -373,18 +373,6 @@
}
}
- /**
- * Print a description of the software before running
- */
- private static String getProlog() {
- String lSep = System.getProperty("line.separator");
- StringBuffer msg = new StringBuffer();
- msg.append("------------------------------------------------------------------------ ").append(lSep);
- msg.append(Constants.NAME).append(" ").append(Constants.VERSION).append(lSep);
- msg.append("Copyright (c) ").append(Constants.YEAR).append(" Apache Software Foundation. All rights reserved.").append(lSep);
- msg.append("------------------------------------------------------------------------ ").append(lSep).append(lSep);
- return msg.toString();
- }
/**
* Print the usage message and exit
@@ -393,7 +381,7 @@
HelpFormatter formatter = new HelpFormatter();
formatter.printHelp("cocoon cli [options] [targets]",
- getProlog().toString(),
+ CocoonBean.getProlog(),
options,
"Note: the context directory defaults to '"+ Constants.DEFAULT_CONTEXT_DIR + "'");
System.exit(0);
1.1 cocoon-2.1/src/java/org/apache/cocoon/CocoonTask.java
Index: CocoonTask.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 modifica-
tion, 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 "Apache Cocoon" 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 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 (INCLU-
DING, 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 and was originally created by
Stefano Mazzocchi <st...@apache.org>. For more information on the Apache
Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.cocoon;
import org.apache.tools.ant.AntClassLoader;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.DynamicConfigurator;
import org.apache.tools.ant.ExitException;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.types.CommandlineJava;
import org.apache.tools.ant.types.Path;
import org.apache.tools.ant.types.Reference;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.Element;
import org.w3c.dom.Document;
/**
* Ant task for running Cocoon. Allows for the embedding of Cocoon into
*
* @author <a href="mailto:uv@upaya.co.uk">Upayavira</a>
* @version CVS $Id: CocoonTask.java,v 1.1 2003/10/13 12:08:10 upayavira Exp $
*/
public class CocoonTask extends Task implements DynamicConfigurator {
private CommandlineJava cmdl = new CommandlineJava();
private boolean failOnError = false;
private Method method = null;
private Throwable caught = null;
private ArrayList uris = new ArrayList();
private String uriGroup = null;
private Document xconf;
private Element root;
private ElementWrapper _wrapper;
private static final String CLASS_DELEGATE = "org.apache.cocoon.bean.helpers.AntDelegate";
public CocoonTask() {
try {
DocumentBuilder builder =
DocumentBuilderFactory.newInstance().newDocumentBuilder();
xconf = builder.newDocument();
root = xconf.createElement("cocoon");
xconf.appendChild(root);
_wrapper = new ElementWrapper(root);
cmdl.setClassname(CLASS_DELEGATE);
}
catch (ParserConfigurationException e) {
throw new BuildException(e);
}
}
/**
* Adds a path to the classpath.
*
* @return created classpath
*/
public Path createClasspath() {
return cmdl.createClasspath(getProject()).createPath();
}
/**
* Classpath to use, by reference.
*
* @param r a reference to an existing classpath
*/
public void setClasspathRef(Reference r) {
createClasspath().setRefid(r);
}
/**
* Set the classpath to be used when running the Java class
*
* @param s an Ant Path object containing the classpath.
*/
public void setClasspath(Path s) {
createClasspath().append(s);
}
public void setUrigroup(String group) {
this.uriGroup = group;
}
/**
* A dynamic configurator for each element.
*/
private static class ElementWrapper
implements DynamicConfigurator {
private Node node;
/** Instantiate a root wrapper */
private ElementWrapper(Node node) {
this.node = node;
}
/** Instantiate a child wrapper */
private ElementWrapper(Node parent, String childName) {
Document document = parent.getOwnerDocument();
if (document == null) {
document = (Document)parent; // Node is the document!
}
node = document.createElement(childName);
parent.appendChild(node);
}
//
// interface DynamicConfigurator
public void setDynamicAttribute(String name, String value)
throws BuildException {
// Never called for anything by Element wrappers
Element element = (Element)node;
element.setAttribute(name, value);
}
public Object createDynamicElement(String name)
throws BuildException {
return new ElementWrapper(node, name);
}
}
public File getLibDir() throws BuildException {
Element root = xconf.getDocumentElement();
String contextDir = null;
if (root!=null) {
if (hasAttribute(root, "context-dir")){
contextDir = getAttributeValue(root, "context-dir");
}
}
if (contextDir != null) {
return new File(contextDir + "/WEB-INF/lib");
} else {
throw new BuildException("No context directory specified. Cannot find Cocoon");
}
}
private static String getAttributeValue(Node node, String attr) throws IllegalArgumentException {
NamedNodeMap nodes = node.getAttributes();
if (nodes != null) {
Node attribute = nodes.getNamedItem(attr);
if (attribute != null && attribute.getNodeValue() != null) {
return attribute.getNodeValue();
}
}
throw new IllegalArgumentException("Missing " + attr + " attribute on <" + node.getNodeName() + "> node");
}
private static boolean hasAttribute(Node node, String attr) {
NamedNodeMap nodes = node.getAttributes();
if (nodes != null) {
Node attribute = nodes.getNamedItem(attr);
return (attribute != null);
}
return false;
}
//
// interface DynamicConfigurator
public void setDynamicAttribute(String name, String value)
throws BuildException {
root.setAttribute(name, value);
}
public Object createDynamicElement(String name)
throws BuildException {
return _wrapper.createDynamicElement(name);
}
/**
* Do the execution and return a return code.
*
* @return the return code from the execute java class if it was
* executed in a separate VM (fork = "yes").
*
* @throws BuildException if required parameters are missing
*/
public void execute() throws BuildException {
int err= -1;
if (cmdl.getClasspath() == null) {
throw new BuildException("Could not find a classpath that points to the Cocoon classes");
}
try {
try {
execute(cmdl);
err = 0;
} catch (ExitException ex) {
err = ex.getStatus();
}
} catch (BuildException e) {
if (failOnError) {
throw e;
} else {
log(e.getMessage(), Project.MSG_ERR);
err = 0;
}
} catch (Throwable t) {
if (failOnError) {
throw new BuildException(t);
} else {
log(t.getMessage(), Project.MSG_ERR);
err = 0;
}
}
}
public void execute(CommandlineJava command) throws BuildException {
final String classname = command.getJavaCommand().getExecutable();
AntClassLoader loader = null;
try {
if (command.getSystemProperties() != null) {
command.getSystemProperties().setSystem();
}
final Class[] param = {Class.forName("org.w3c.dom.Document"), Class.forName("java.lang.String")};
Class target = null;
if (command.getClasspath() == null) {
target = Class.forName(classname);
} else {
loader = new AntClassLoader(getProject().getCoreLoader(), project,
command.getClasspath(), false);
loader.setIsolated(true);
loader.setThreadContextLoader();
target = loader.forceLoadClass(classname);
AntClassLoader.initializeClass(target);
}
Method method = target.getMethod("process", param);
if (method == null) {
throw new BuildException("Could not find process() method in "
+ classname);
}
run(method);
if (caught != null) {
throw caught;
}
} catch (ClassNotFoundException e) {
throw new BuildException("Could not find " + classname + "."
+ " Make sure you have it in your"
+ " classpath");
} catch (SecurityException e) {
throw e;
} catch (Throwable e) {
throw new BuildException(e);
} finally {
if (loader != null) {
loader.resetThreadContextLoader();
loader.cleanup();
}
if (command.getSystemProperties() != null) {
command.getSystemProperties().restoreSystem();
}
}
}
public void run(Method method) {
final Object[] argument = {xconf, uriGroup};
try {
method.invoke(null, argument);
} catch (InvocationTargetException e) {
Throwable t = e.getTargetException();
if (!(t instanceof InterruptedException)) {
caught = t;
} /* else { swallow, probably due to timeout } */
} catch (Throwable t) {
caught = t;
} finally {
synchronized (this) {
notifyAll();
}
}
}
}
1.36 +13 -1 cocoon-2.1/src/java/org/apache/cocoon/bean/CocoonBean.java
Index: CocoonBean.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/java/org/apache/cocoon/bean/CocoonBean.java,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -r1.35 -r1.36
--- CocoonBean.java 11 Oct 2003 01:32:53 -0000 1.35
+++ CocoonBean.java 13 Oct 2003 12:08:10 -0000 1.36
@@ -752,4 +752,16 @@
return false;
}
}
+ /**
+ * Print a description of the software before running
+ */
+ public static String getProlog() {
+ String lSep = System.getProperty("line.separator");
+ StringBuffer msg = new StringBuffer();
+ msg.append("------------------------------------------------------------------------ ").append(lSep);
+ msg.append(Constants.NAME).append(" ").append(Constants.VERSION).append(lSep);
+ msg.append("Copyright (c) ").append(Constants.YEAR).append(" Apache Software Foundation. All rights reserved.").append(lSep);
+ msg.append("------------------------------------------------------------------------ ").append(lSep).append(lSep);
+ return msg.toString();
+ }
}
1.3 +25 -8 cocoon-2.1/src/java/org/apache/cocoon/bean/helpers/BeanConfigurator.java
Index: BeanConfigurator.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/java/org/apache/cocoon/bean/helpers/BeanConfigurator.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- BeanConfigurator.java 11 Oct 2003 05:44:07 -0000 1.2
+++ BeanConfigurator.java 13 Oct 2003 12:08:10 -0000 1.3
@@ -86,14 +86,17 @@
private static final String NODE_URI_FILE = "uri-file";
private static final String NODE_CHECKSUMS_URI = "checksums-uri";
- // context-dir is needed by ant task
- public static final String ATTR_CONTEXT_DIR = "context-dir";
+ private static final String ATTR_CONTEXT_DIR = "context-dir";
private static final String ATTR_DEST_DIR = "dest-dir";
private static final String ATTR_WORK_DIR = "work-dir";
private static final String ATTR_CONFIG_FILE = "config-file";
private static final String ATTR_URI_FILE = "uri-file";
private static final String ATTR_CHECKSUMS_URI = "checksums-uri";
-
+ private static final String ATTR_AGENT = "user-agent";
+ private static final String ATTR_ACCEPT = "accept";
+ private static final String ATTR_DEFAULT_FILENAME = "default-filename";
+ private static final String ATTR_LOCALE = "locale";
+
private static final String NODE_BROKEN_LINKS = "broken-links";
private static final String ATTR_BROKEN_LINK_REPORT_TYPE = "type";
private static final String ATTR_BROKEN_LINK_REPORT_FILE = "file";
@@ -163,7 +166,24 @@
if (hasAttribute(root, ATTR_CHECKSUMS_URI)) {
cocoon.setChecksumURI(getAttributeValue(root, ATTR_CHECKSUMS_URI));
}
-
+ if (hasAttribute(root, ATTR_CHECKSUMS_URI)) {
+ cocoon.setChecksumURI(getAttributeValue(root, ATTR_CHECKSUMS_URI));
+ }
+ if (hasAttribute(root, ATTR_CHECKSUMS_URI)) {
+ cocoon.setChecksumURI(getAttributeValue(root, ATTR_CHECKSUMS_URI));
+ }
+ if (hasAttribute(root, ATTR_CHECKSUMS_URI)) {
+ cocoon.setChecksumURI(getAttributeValue(root, ATTR_CHECKSUMS_URI));
+ }
+ if (hasAttribute(root, ATTR_AGENT)) {
+ cocoon.setAgentOptions(getAttributeValue(root, ATTR_AGENT));
+ }
+ if (hasAttribute(root, ATTR_ACCEPT)) {
+ cocoon.setAgentOptions(getAttributeValue(root, ATTR_ACCEPT));
+ }
+ if (hasAttribute(root, ATTR_DEFAULT_FILENAME)) {
+ cocoon.setAgentOptions(getAttributeValue(root, ATTR_DEFAULT_FILENAME));
+ }
if (destDir == null || destDir.length() == 0) {
destDir = getNodeValue(root, NODE_DEST_DIR);
@@ -212,15 +232,12 @@
cocoon.setChecksumURI(getNodeValue(node));
}
} else if (nodeName.equals(NODE_AGENT)) {
- //@TODO@ Move this to be attributes too
cocoon.setAgentOptions(getNodeValue(node));
} else if (nodeName.equals(NODE_ACCEPT)) {
- //@TODO@ Move this to be attributes too
cocoon.setAcceptOptions(getNodeValue(node));
} else if (nodeName.equals(NODE_DEFAULT_FILENAME)) {
- //@TODO@ Move this to be attributes too
cocoon.setDefaultFilename(getNodeValue(node));
} else if (nodeName.equals(NODE_INCLUDE)) {
1.1 cocoon-2.1/src/java/org/apache/cocoon/bean/helpers/AntDelegate.java
Index: AntDelegate.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 modifica-
tion, 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 "Apache Cocoon" 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 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 (INCLU-
DING, 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 and was originally created by
Stefano Mazzocchi <st...@apache.org>. For more information on the Apache
Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.cocoon.bean.helpers;
import org.w3c.dom.Document;
import org.apache.cocoon.bean.CocoonBean;
import org.apache.cocoon.bean.helpers.OutputStreamListener;
import org.apache.cocoon.bean.helpers.BeanConfigurator;
/**
* Delegate class for use by the Cocoon Ant task. Allows Ant to run
* Cocoon with a single method call that can happily be started with
* introspection (due to classpath issues).
*
* @author <a href="mailto:uv@upaya.co.uk">Upayavira</a>
* @version CVS $Id: AntDelegate.java,v 1.1 2003/10/13 12:08:10 upayavira Exp $
*/
public class AntDelegate {
public static int process(Document xconf, String uriGroup) throws Exception {
CocoonBean cocoon = new CocoonBean();
OutputStreamListener listener = new OutputStreamListener(System.out);
cocoon.addListener(listener);
BeanConfigurator.configure(xconf, cocoon, "", uriGroup, listener);
System.out.println(CocoonBean.getProlog());
cocoon.initialize();
cocoon.process();
cocoon.dispose();
listener.complete();
return listener.isSuccessful() ? 0 : 1;
}
}