View Javadoc
1 /* 2 * $Header: /home/cvs/jakarta-commons-sandbox/jelly/src/taglibs/beanshell/src/java/org/apache/commons/jelly/tags/beanshell/BeanShellExpressionFactory.java,v 1.1 2002/05/21 07:58:55 jstrachan Exp $ 3 * $Revision: 1.1 $ 4 * $Date: 2002/05/21 07:58:55 $ 5 * 6 * ==================================================================== 7 * 8 * The Apache Software License, Version 1.1 9 * 10 * Copyright (c) 1999-2002 The Apache Software Foundation. All rights 11 * reserved. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 17 * 1. Redistributions of source code must retain the above copyright 18 * notice, this list of conditions and the following disclaimer. 19 * 20 * 2. Redistributions in binary form must reproduce the above copyright 21 * notice, this list of conditions and the following disclaimer in 22 * the documentation and/or other materials provided with the 23 * distribution. 24 * 25 * 3. The end-user documentation included with the redistribution, if 26 * any, must include the following acknowlegement: 27 * "This product includes software developed by the 28 * Apache Software Foundation (http://www.apache.org/)." 29 * Alternately, this acknowlegement may appear in the software itself, 30 * if and wherever such third-party acknowlegements normally appear. 31 * 32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software 33 * Foundation" must not be used to endorse or promote products derived 34 * from this software without prior written permission. For written 35 * permission, please contact apache@apache.org. 36 * 37 * 5. Products derived from this software may not be called "Apache" 38 * nor may "Apache" appear in their names without prior written 39 * permission of the Apache Group. 40 * 41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 52 * SUCH DAMAGE. 53 * ==================================================================== 54 * 55 * This software consists of voluntary contributions made by many 56 * individuals on behalf of the Apache Software Foundation. For more 57 * information on the Apache Software Foundation, please see 58 * <http://www.apache.org/>;. 59 * 60 * $Id: BeanShellExpressionFactory.java,v 1.1 2002/05/21 07:58:55 jstrachan Exp $ 61 */ 62 package org.apache.commons.jelly.tags.http; 63 64 import java.net.MalformedURLException; 65 66 import org.apache.commons.jelly.JellyException; 67 import org.apache.commons.jelly.TagSupport; 68 import org.apache.commons.jelly.XMLOutput; 69 70 import org.apache.commons.httpclient.HttpConnection; 71 import org.apache.commons.httpclient.HttpConnectionManager; 72 import org.apache.commons.httpclient.HttpException; 73 import org.apache.commons.httpclient.HttpMethod; 74 import org.apache.commons.httpclient.HttpState; 75 76 /*** 77 * Abstract base class for a tag which invokes a HTTP method 78 * 79 * @author <a href="mailto:jstrachan@apache.org">James Strachan</a> 80 * @version $Revision: 1.1 $ 81 */ 82 public abstract class MethodSupportTag extends TagSupport { 83 84 /*** The variable name to create the HttpMethod object */ 85 private String var; 86 87 /*** Sets the URL of this request */ 88 private String url; 89 90 /*** The HTTP client used to invoke methods */ 91 private HttpConnection connection; 92 93 /*** the HTTP connection factory used create HTTP connections */ 94 private HttpConnectionManager connectionManager; 95 96 /*** The state for this http request, cookies etc. */ 97 private HttpState state; 98 99 public void addHeader(String name, String value) throws HttpException, MalformedURLException { 100 getMethod().addRequestHeader(name, value); 101 } 102 103 // Tag interface 104 //------------------------------------------------------------------------- 105 public void doTag(XMLOutput output) throws Exception { 106 // ### should probably use HttpClient instead 107 /* 108 HttpClient client = getHttpClient(); 109 client.startSession( getUrl() ); 110 111 try { 112 // must use inner tags to extract the output.... 113 invokeBody(output) 114 } 115 finally { 116 client.endSession(); 117 } 118 119 */ 120 121 HttpConnection connection = getConnection(); 122 if ( connection == null ) { 123 throw new JellyException( 124 "No HTTP connection available. " 125 + "This tag should have a 'uri' attribute or be nested inside " 126 + "a <http:connection> tag" 127 ); 128 } 129 130 HttpMethod method = getMethod(); 131 if ( method == null ) { 132 throw new JellyException( "No HTTP Method available for this tag to execute" ); 133 } 134 int result = method.execute(getState(), connection); 135 136 if ( var != null ) { 137 context.setVariable(var, method); 138 } 139 } 140 141 142 // Properties 143 //------------------------------------------------------------------------- 144 145 /*** 146 * @return the HTTP method to invoke 147 */ 148 public abstract HttpMethod getMethod() throws HttpException, MalformedURLException; 149 150 /*** 151 * @return the state of this HTTP request, the cookies used etc 152 */ 153 public HttpState getState() { 154 if ( state == null ) { 155 state = new HttpState(); 156 } 157 return state; 158 } 159 160 161 /*** 162 * @return the HTTP connection, creating one if required 163 */ 164 public HttpConnection getConnection() throws HttpException, MalformedURLException { 165 if ( connection == null ) { 166 connection = createConnection(); 167 } 168 return connection; 169 } 170 171 /*** 172 * Sets the HTTP connection used to perform the HTTP operation 173 * 174 * @jelly:optional 175 */ 176 public void setConnection(HttpConnection connection) { 177 this.connection = connection; 178 } 179 180 /*** 181 * @return the HTTP connection factory, creating one if required 182 */ 183 public HttpConnectionManager getConnectionManager() { 184 if ( connectionManager == null ) { 185 connectionManager = new HttpConnectionManager(); 186 } 187 return connectionManager; 188 } 189 190 /*** 191 * Sets the HTTP connection factory used to create HTTP connections 192 * 193 * @jelly:optional 194 */ 195 public void setConnectionManager(HttpConnectionManager connectionManager) { 196 this.connectionManager = connectionManager; 197 } 198 199 /*** Sets the variable name for the HttpMethod object 200 * 201 * @jelly:optional 202 */ 203 public void setVar(String var) { 204 this.var = var; 205 } 206 207 208 /*** 209 * @return the URL of this HTTP request 210 */ 211 public String getUrl() { 212 return url; 213 } 214 215 /*** 216 * Sets the URL of this request 217 * 218 * @jelly:required 219 */ 220 public void setUrl(String url) { 221 this.url = url; 222 } 223 224 225 // Implementation methods 226 //------------------------------------------------------------------------- 227 228 /*** 229 * A Factory method to create a new HTTP connection 230 */ 231 protected HttpConnection createConnection() throws HttpException, MalformedURLException { 232 return getConnectionManager().getConnection( getUrl() ); 233 } 234 }

This page was automatically generated by Maven