You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by di...@apache.org on 2002/07/14 15:05:14 UTC
cvs commit: jakarta-commons/latka/src/java/org/apache/commons/latka/jelly HttpTagSupport.java HttpTagLibrary.java
dion 2002/07/14 06:05:14
Added: latka/src/java/org/apache/commons/latka/jelly
HttpTagSupport.java HttpTagLibrary.java
Log:
Missing files in rework
Revision Changes Path
1.1 jakarta-commons/latka/src/java/org/apache/commons/latka/jelly/HttpTagSupport.java
Index: HttpTagSupport.java
===================================================================
/*
* $Header: /home/cvs/jakarta-commons/latka/src/java/org/apache/commons/latka/jelly/HttpTagSupport.java,v 1.1 2002/07/14 13:05:14 dion Exp $
* $Revision: 1.1 $
* $Date: 2002/07/14 13:05:14 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2001 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.latka.jelly;
import java.net.MalformedURLException;
import java.util.ArrayList;
import java.util.List;
import org.apache.commons.httpclient.HttpMultiClient;
import org.apache.commons.httpclient.HttpUrlMethod;
import org.apache.commons.httpclient.NameValuePair;
import org.apache.commons.jelly.TagSupport;
import org.apache.commons.jelly.XMLOutput;
/**
* The base tag for all http requests
*
* @author dion
* @version $Id: HttpTagSupport.java,v 1.1 2002/07/14 13:05:14 dion Exp $
*/
public abstract class HttpTagSupport extends TagSupport {
/** unique identifier of the tag/ variable to store result in */
private String _var;
/**
* the path to be tested relative to the host/port specifed on the parent
* {@link SuiteTag suite tag}.
* Either this property and the suite's host
* must be provided, or the {@link #getUrl() url} property must be specifed
*/
private String _path;
/**
* The complete uri to be processed
* Either this property or the {@link #getPath() path} and the suite's host
* must be provided.
*/
private String _uri;
/** whether or not to follow redirects */
private boolean _followRedirects = true;
/** list of parameters as name value pairs */
private List _parameters;
/** list of headers as name value pairs */
private List _requestHeaders;
/** the header name for the user agent */
private static final String HEADER_NAME_USER_AGENT = "User-Agent";
/**
* Creates a new instance of HttpTag
*/
public HttpTagSupport() {
setParameters(new ArrayList());
setRequestHeaders(new ArrayList());
}
/**
* @return the url specified by the tag, either the url if not null, or
* a combination of the host, port and path
*/
public String getResolvedUrl() {
if (getUri() != null) {
return getUri();
} else {
// build it from path, host and optionally port
SessionTag session = (SessionTag) findAncestorWithClass(
SessionTag.class);
String host = session.getHost();
String port = session.getPort();
// short term hack, need to add port and security in
return "http://" + host + getPath();
}
}
/**
* A method that must be implemented by subclasses to provide the
* {@link HttpUrlMethod url method} implementation
*
* @return a HttpUrlMethod implementation
* @throws MalformedURLException when the {@link getUrl() url} or
* {@link #getPath() path} is invalid
*/
protected abstract HttpUrlMethod getHttpUrlMethod()
throws MalformedURLException;
/**
* Perform the tag functionality. In this case, get the http url method
* execute it and make it available for validation
*
* @param xmlOutput where to send output
* @throws Exception when an error occurs
*/
public void doTag(XMLOutput xmlOutput) throws Exception {
// allow nested tags first
invokeBody(xmlOutput);
HttpUrlMethod urlMethod = getConfiguredHttpMethod();
// track request execution
long start = System.currentTimeMillis();
getHttpClient().executeMethod(urlMethod);
long end = System.currentTimeMillis();
// set variable to value
if (getVar() != null) {
getContext().setVariable(getVar(), urlMethod);
getContext().setVariable(getVar() + ".responseTime",
String.valueOf(end - start));
}
}
/**
* retrieve the {@link HttpUrlMethod method} from the subclass and
* configure it ready for execution
*
* @return a configured {@link HttpUrlMethod method}
*/
private HttpUrlMethod getConfiguredHttpMethod() throws
MalformedURLException{
// retrieve and configure url method
HttpUrlMethod urlMethod = getHttpUrlMethod();
urlMethod.setFollowRedirects(isFollowRedirects());
// add request headers
NameValuePair header = null;
for (int index = 0; index < getRequestHeaders().size(); index++) {
header = (NameValuePair) getRequestHeaders().get(index);
urlMethod.addRequestHeader(header.getName(), header.getValue());
}
// add parameters
setParameters(urlMethod);
// add the default user agent to the list if one doesn't exist
// and the session tag does exist and have a user agent
if (urlMethod.getRequestHeader(HttpTagSupport.HEADER_NAME_USER_AGENT)
== null && getSessionTag() != null
&& getSessionTag().getUserAgent() != null) {
urlMethod.addRequestHeader(HttpTagSupport.HEADER_NAME_USER_AGENT,
getSessionTag().getUserAgent());
}
return urlMethod;
}
/**
* Set the current parameters on the url method ready for processing
*
* @throws MalformedURLException when {@link #getHttpUrlMethod()} does
*/
protected void setParameters(HttpUrlMethod method) throws
MalformedURLException {
if (getParameters().size() > 0) {
NameValuePair[] parameters = (NameValuePair[]) getParameters().
toArray(new NameValuePair[0]);
method.setQueryString(parameters);
}
}
/**
* retrieve the optional parent session tag
*
* @return the ancestor tag with class {@link SessionTag} or null if
* not found
*/
private SessionTag getSessionTag() {
SessionTag sessionTag = (SessionTag) findAncestorWithClass(
SessionTag.class);
return sessionTag;
}
/**
* return a HttpClient shared on the session tag, or a new one if no
* session tag exists
*
* @return the shared http client from the session tag, or create a new one.
*/
private HttpMultiClient getHttpClient() {
SessionTag session = getSessionTag();
HttpMultiClient client = null;
if (session != null) {
client = session.getHttpClient();
client.setStrictMode(session.isStrictMode());
} else {
client = new HttpMultiClient();
}
return client;
}
/**
* Add a parameter to the list
*
* @param name the parameter name
* @param value the parameter value
*/
public void addParameter(String name, String value) {
getParameters().add(new NameValuePair(name, value));
}
/**
* Add a request header to the list
*
* @param name the header name
* @param value the header value
*/
public void addRequestHeader(String name, String value) {
getRequestHeaders().add(new NameValuePair(name, value));
}
//--------------------------------------------------------------------------
// Property accessors/mutators
//--------------------------------------------------------------------------
/**
* Getter for property var.
*
* @return Value of property var.
*/
public String getVar() {
return _var;
}
/**
* Setter for property var.
*
* @param id New value of property var.
*/
public void setVar(String var) {
_var = var;
}
/**
* Getter for property path.
*
* @return Value of property path.
*/
public String getPath() {
return _path;
}
/**
* Setter for property path.
*
* @param path New value of property path.
*/
public void setPath(String path) {
_path = path;
}
/**
* Getter for property uri.
*
* @return Value of property uri.
*/
public String getUri() {
return _uri;
}
/**
* Setter for property uri.
*
* @param uri New value of property uri.
*/
public void setUri(String uri) {
_uri = uri;
}
/**
* Getter for property followRedirects.
*
* @return Value of property followRedirects.
*/
public boolean isFollowRedirects() {
return _followRedirects;
}
/**
* Setter for property followRedirects.
*
* @param followRedirects New value of property followRedirects.
*/
public void setFollowRedirects(boolean followRedirects) {
_followRedirects = followRedirects;
}
/**
* Getter for property parameters.
*
* @return Value of property parameters.
*/
public List getParameters() {
return _parameters;
}
/**
* Setter for property parameters.
*
* @param parameters New value of property parameters.
*/
public void setParameters(List parameters) {
_parameters = parameters;
}
/**
* Getter for property requestHeaders.
*
* @return Value of property requestHeaders.
*/
public List getRequestHeaders() {
return _requestHeaders;
}
/**
* Setter for property requestHeaders.
*
* @param requestHeaders New value of property requestHeaders.
*/
public void setRequestHeaders(List requestHeaders) {
_requestHeaders = requestHeaders;
}
}
1.1 jakarta-commons/latka/src/java/org/apache/commons/latka/jelly/HttpTagLibrary.java
Index: HttpTagLibrary.java
===================================================================
/*
* $Header: /home/cvs/jakarta-commons/latka/src/java/org/apache/commons/latka/jelly/HttpTagLibrary.java,v 1.1 2002/07/14 13:05:14 dion Exp $
* $Revision: 1.1 $
* $Date: 2002/07/14 13:05:14 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2001 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.latka.jelly;
import java.util.Map;
import org.apache.commons.jelly.TagLibrary;
/**
* The set of jelly tags provided by Latka
*
* @author dion
* @version $Id: HttpTagLibrary.java,v 1.1 2002/07/14 13:05:14 dion Exp $
*/
public class HttpTagLibrary extends TagLibrary {
/**
* Creates a new instance of LatkaTagLibrary
*/
public HttpTagLibrary() {
registerTag("session", SessionTag.class);
registerTag("get", GetTag.class);
registerTag("post", PostTag.class);
registerTag("delete", DeleteTag.class);
registerTag("head", HeadTag.class);
registerTag("options", OptionsTag.class);
registerTag("put", PutTag.class);
registerTag("parameter", ParameterTag.class);
registerTag("header", HeaderTag.class);
registerTag("body", BodyTag.class);
}
/**
* @see TagLibarary#getTagClasses()
*
* @return a Map of tag name to tag class
*/
public Map getTagClasses() {
return super.getTagClasses();
}
}
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>