You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by pi...@apache.org on 2003/02/11 03:47:50 UTC
cvs commit: xml-cocoon2/src/blocks/proxy/java/org/apache/cocoon/generation HttpProxyGenerator.java
pier 2003/02/10 18:47:50
Modified: lib jars.xml
Added: lib/optional commons-httpclient-20030210.jar
src/blocks/proxy/java/org/apache/cocoon/generation
HttpProxyGenerator.java
Removed: lib/optional commons-httpclient-2.0-alpha2.jar
Log:
Updated the commons-httpclient to latest.
Implementation of the HTTP Proxy generator derived from the
WebServiceProxyGenerator.
Revision Changes Path
1.77 +1 -1 xml-cocoon2/lib/jars.xml
Index: jars.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/lib/jars.xml,v
retrieving revision 1.76
retrieving revision 1.77
diff -u -r1.76 -r1.77
--- jars.xml 10 Feb 2003 19:35:27 -0000 1.76
+++ jars.xml 11 Feb 2003 02:47:50 -0000 1.77
@@ -314,7 +314,7 @@
and feature-rich package implementing the client side of the most recent
HTTP standards and recommendations.</description>
<used-by>SOAP logicsheet, WebServiceProxyGenerator</used-by>
- <lib>optional/commons-httpclient-2.0-alpha2.jar</lib>
+ <lib>optional/commons-httpclient-20030210.jar</lib>
<lib>optional/commons-logging-1.0.2.jar</lib>
<homepage>http://jakarta.apache.org/commons/httpclient/</homepage>
</file>
1.1 xml-cocoon2/lib/optional/commons-httpclient-20030210.jar
<<Binary file>>
1.1 xml-cocoon2/src/blocks/proxy/java/org/apache/cocoon/generation/HttpProxyGenerator.java
Index: HttpProxyGenerator.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.generation;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.Map;
import org.apache.avalon.framework.component.Component;
import org.apache.avalon.framework.component.ComponentException;
import org.apache.avalon.framework.configuration.Configurable;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.avalon.framework.parameters.Parameters;
import org.apache.cocoon.ProcessingException;
import org.apache.cocoon.environment.SourceResolver;
import org.apache.commons.httpclient.HttpConnection;
import org.apache.commons.httpclient.HttpMethodBase;
import org.apache.commons.httpclient.HttpState;
import org.apache.commons.httpclient.HttpURL;
import org.apache.commons.httpclient.HostConfiguration;
import org.apache.commons.httpclient.NameValuePair;
import org.apache.commons.httpclient.URIException;
import org.apache.commons.httpclient.methods.GetMethod;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.excalibur.xml.sax.SAXParser;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;
/**
* The <code>HttpProxyGenerator</code> is a Cocoon generator using the
* <b>Jakarta Commons HTTPClient Library</code> to access an XML stream
* over HTTP.
*
* @version CVS $Revision: 1.1 $
* @author <a href="mailto:ivelin@apache.org">Ivelin Ivanov</a>, June 2002
* @author <a href="mailto:tc@hist.umn.edu">Tony Collen</a>, December 2002
* @author <a href="mailto:pier@apache.org">Pier Fumagalli</a>, February 2003
*/
public class HttpProxyGenerator extends ComposerGenerator implements Configurable {
/** The HTTP method to use at request time. */
private HttpMethodBase method = null;
/** The base HTTP URL for requests. */
private HttpURL url = null;
/** The list of request parameters for the request */
private ArrayList reqParams = null;
/** The list of query parameters for the request */
private ArrayList qryParams = null;
/** Wether we want a debug output or not */
private boolean debug = false;
/**
* Prepare a map of parameters from an array of <code>Configuration</code>
* items.
*
* @param configurations An array of <code>Configuration</code> elements.
* @return A <code>List</code> of <code>NameValuePair</code> elements.
* @exception ConfigurationException If a parameter doesn't specify a name.
*/
private ArrayList getParams(Configuration configurations[])
throws ConfigurationException {
ArrayList list = new ArrayList();
if (configurations.length < 1) return (list);
for (int x = 0; x < configurations.length; x++) {
Configuration configuration = configurations[x];
String name = configuration.getAttribute("name", null);
if (name == null) {
throw new ConfigurationException("No name specified for parameter at "
+ configuration.getLocation());
}
String value = configuration.getAttribute("value", null);
if (value != null) list.add(new NameValuePair(name, value));
Configuration subconfigurations[] = configuration.getChildren("value");
for (int y = 0; y < subconfigurations.length; y++) {
value = subconfigurations[y].getValue(null);
if (value != null) list.add(new NameValuePair(name, value));
}
}
return (list);
}
private ArrayList overrideParams(ArrayList list, String name, String value) {
Iterator iterator = list.iterator();
while (iterator.hasNext()) {
NameValuePair param = (NameValuePair) iterator.next();
if (param.getName().equals(name)) iterator.remove();
}
list.add(new NameValuePair(name, value));
return (list);
}
public void configure(Configuration configuration)
throws ConfigurationException {
/* Setup the HTTP method to use. */
String method = configuration.getChild("method").getValue("GET");
if ("GET".equalsIgnoreCase(method)) {
this.method = new GetMethod();
} else if ("POST".equalsIgnoreCase(method)) {
this.method = new PostMethod();
/* Work around a bug from the HttpClient library */
((PostMethod) this.method).setRequestBody("");
} else {
throw new ConfigurationException("Invalid method \"" + method + "\" specified"
+ " at " + configuration.getChild("method").getLocation());
}
/* Create the base URL */
String url = configuration.getChild("url").getValue(null);
try {
if (url != null) this.url = new HttpURL(url);
} catch (URIException e) {
throw new ConfigurationException("Cannot process URL \"" + url + "\" specified"
+ " at " + configuration.getChild("url").getLocation());
}
/* Prepare the base request and query parameters */
this.reqParams = this.getParams(configuration.getChildren("param"));
this.qryParams = this.getParams(configuration.getChildren("query"));
}
public void setup(SourceResolver sourceResolver, Map objectModel,
String source, Parameters parameters)
throws ProcessingException, SAXException, IOException {
/* Do the usual stuff */
super.setup(sourceResolver, objectModel, source, parameters);
/*
* Parameter handling: In case the method is a POST method, query
* parameters and request parameters will be two different arrays
* (one for the body, one for the query string, otherwise it's going
* to be the same one, as all parameters are passed on the query string
*/
ArrayList req = new ArrayList();
ArrayList qry = req;
if (this.method instanceof PostMethod) qry = new ArrayList();
req.addAll(this.reqParams);
qry.addAll(this.qryParams);
/*
* Parameter handling: complete or override the configured parameters with
* those specified in the pipeline.
*/
String names[] = parameters.getNames();
for (int x = 0; x < names.length; x++) {
String name = names[x];
String value = parameters.getParameter(name, null);
if (value == null) continue;
if (name.startsWith("query:")) {
name = name.substring("query:".length());
qry.add(new NameValuePair(name, value));
} else if (name.startsWith("param:")) {
name = name.substring("param:".length());
req.add(new NameValuePair(name, value));
} else if (name.startsWith("query-override:")) {
name = name.substring("query-override:".length());
qry = overrideParams(qry, name, value);
} else if (name.startsWith("param-override:")) {
name = name.substring("param-override:".length());
req = overrideParams(req, name, value);
}
}
/* Process the current source URL in relation to the configured one */
HttpURL src = (super.source == null ? null : new HttpURL(super.source));
if (this.url != null) src = (src == null ? this.url : new HttpURL(this.url, src));
if (src == null) throw new ProcessingException("No URL specified");
if (src.isRelativeURI()) {
throw new ProcessingException("Invalid URL \"" + src.toString() + "\"");
}
/* Configure the method with the resolved URL */
HostConfiguration hc = new HostConfiguration();
hc.setHost(src);
this.method.setHostConfiguration(hc);
this.method.setPath(src.getPath());
this.method.setQueryString(src.getQuery());
/* And now process the query string (from the parameters above) */
if (qry.size() > 0) {
String qs = this.method.getQueryString();
NameValuePair nvpa[] = new NameValuePair[qry.size()];
this.method.setQueryString((NameValuePair []) qry.toArray(nvpa));
if (qs != null) {
this.method.setQueryString(qs + "&" + this.method.getQueryString());
}
}
/* Finally process the body parameters */
if ((this.method instanceof PostMethod) && (req.size() > 0)) {
PostMethod post = (PostMethod) this.method;
NameValuePair nvpa[] = new NameValuePair[req.size()];
post.setRequestBody((NameValuePair []) req.toArray(nvpa));
}
/* Check the debugging flag */
this.debug = parameters.getParameterAsBoolean("debug", false);
}
public void recycle() {
/* Recycle the method */
this.method.recycle();
/* Work around a bug from the HttpClient library */
if (this.method instanceof PostMethod) ((PostMethod) this.method).setRequestBody("");
/* Clean up our parent */
super.recycle();
}
public void generate()
throws IOException, SAXException, ProcessingException {
/* Do the boring stuff in case we have to do a debug output (blablabla) */
if (this.debug) {
this.generateDebugOutput();
return;
}
/* Call up the remote HTTP server */
HttpConnection connection = new HttpConnection(this.method.getHostConfiguration());
HttpState state = new HttpState();
this.method.setFollowRedirects(true);
int status = this.method.execute(state, connection);
if ((status < 200) || (status > 299)) {
throw new ProcessingException("Unable to access HTTP resource at \""
+ this.method.getURI().toString() + "\" (status=" + status + ")");
}
InputStream response = this.method.getResponseBodyAsStream();
SAXParser parser = null;
try {
InputSource inputSource = new InputSource(response);
parser = (SAXParser) this.manager.lookup(SAXParser.ROLE);
parser.parse(inputSource, super.xmlConsumer);
} catch (ComponentException ex) {
throw new ProcessingException("Unable to get parser", ex);
} finally {
this.manager.release((Component) parser);
this.method.releaseConnection();
connection.close();
}
}
private void generateDebugOutput()
throws IOException, SAXException, ProcessingException {
super.xmlConsumer.startDocument();
AttributesImpl attributes = new AttributesImpl();
attributes.addAttribute("", "method", "method", "CDATA", this.method.getName());
attributes.addAttribute("", "url", "url", "CDATA", this.method.getURI().toString());
attributes.addAttribute("", "protocol", "protocol", "CDATA",
(this.method.isHttp11() ? "HTTP/1.1" : "HTTP/1.0"));
super.xmlConsumer.startElement("", "request", "request", attributes);
if (this.method instanceof PostMethod) {
String body = ((PostMethod) this.method).getRequestBodyAsString();
attributes = new AttributesImpl();
attributes.addAttribute("", "name", "name", "CDATA", "Content-Type");
attributes.addAttribute("", "value", "value", "CDATA", "application/x-www-form-urlencoded");
super.xmlConsumer.startElement("", "header", "header", attributes);
super.xmlConsumer.endElement("", "header", "header");
attributes = new AttributesImpl();
attributes.addAttribute("", "name", "name", "CDATA", "Content-Length");
attributes.addAttribute("", "value", "value", "CDATA", Integer.toString(body.length()));
super.xmlConsumer.startElement("", "header", "header", attributes);
super.xmlConsumer.endElement("", "header", "header");
attributes = new AttributesImpl();
super.xmlConsumer.startElement("", "body", "body", attributes);
super.xmlConsumer.characters(body.toCharArray(), 0, body.length());
super.xmlConsumer.endElement("", "body", "body");
}
super.xmlConsumer.endElement("", "request", "request");
super.xmlConsumer.endDocument();
return;
}
}
----------------------------------------------------------------------
In case of troubles, e-mail: webmaster@xml.apache.org
To unsubscribe, e-mail: cocoon-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: cocoon-cvs-help@xml.apache.org
Re: cvs commit:
xml-cocoon2/src/blocks/proxy/java/org/apache/cocoon/generation
HttpProxyGenerator.java
Posted by Pier Fumagalli <pi...@betaversion.org>.
On 11/2/03 2:47, "pier@apache.org" <pi...@apache.org> wrote:
> Added: src/blocks/proxy/java/org/apache/cocoon/generation
> HttpProxyGenerator.java
> Log:
> Implementation of the HTTP Proxy generator derived from the
> WebServiceProxyGenerator.
For sure it has bugs ATM, as I wrote it in 3 hours cuz I need it tomorrow
(and I already have lost the one debugged copy I've been working on for the
past two days).
Still to add are authentication, proxying and JavaDocs, but (in theory) it
works...
And now onto the block...
Pier
---------------------------------------------------------------------
To unsubscribe, e-mail: cocoon-dev-unsubscribe@xml.apache.org
For additional commands, email: cocoon-dev-help@xml.apache.org