1 /*
2 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/UrlGetMethod.java,v 1.12 2003/01/30 05:01:56 jsdever Exp $
3 * $Revision: 1.12 $
4 * $Date: 2003/01/30 05:01:56 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2003 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 * [Additional notices, if required by prior licensing conditions]
61 *
62 */
63
64 package org.apache.commons.httpclient.methods;
65
66 import org.apache.commons.httpclient.HttpUrlMethod;
67 import org.apache.commons.httpclient.util.URIUtil;
68
69 import java.io.File;
70 import java.net.MalformedURLException;
71
72 /***
73 * Implements the URL version of GetMethod. It serves the
74 * same purpose as GetMethod but it takes URL instead of
75 * a path.
76 *
77 * @deprecated use GetMethod
78 *
79 * @author Marc A. Saegesser
80 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
81 */
82 public class UrlGetMethod extends GetMethod implements HttpUrlMethod {
83 // ----------------------------------------------------- Instance Variables
84 /*** The URL */
85 private String url;
86
87 /***
88 * No-arg constructor.
89 */
90 public UrlGetMethod() {
91 super();
92 }
93
94 /***
95 * Create an instance with the specified URL
96 * @param url The URL
97 * @throws MalformedURLException If the url isn't valid.
98 */
99 public UrlGetMethod(String url) throws MalformedURLException {
100 super(URIUtil.getPath(url));
101 setUrl(url);
102 }
103
104 /***
105 * Create an instance with the specified URL and temporary directory.
106 * @param url The URL
107 * @param tempDir The temporary directory
108 * @throws MalformedURLException If the url isn't valid.
109 */
110 public UrlGetMethod(String url, String tempDir) throws MalformedURLException {
111 super(URIUtil.getPath(url), tempDir);
112 setUrl(url);
113 }
114
115 /***
116 * Constructor.
117 * @param url the path of the request
118 * @param tempDir the directory in which to store temporary files
119 * @param tempFile the file (under tempDir) to buffer contents to
120 * @throws MalformedURLException If the url isn't valid.
121 */
122 public UrlGetMethod(String url, String tempDir, String tempFile)
123 throws MalformedURLException {
124 super(URIUtil.getPath(url), tempDir, tempFile);
125 setUrl(url);
126 }
127
128 /***
129 * Constructor.
130 * @param url the path of the request
131 * @param fileData the file to buffer contents to
132 * @throws MalformedURLException If the url isn't valid.
133 */
134 public UrlGetMethod(String url, File fileData)
135 throws MalformedURLException {
136 super(URIUtil.getPath(url), fileData);
137 setUrl(url);
138 }
139
140 /***
141 * Sets the URL. Calls the underlying HttpMethod.setPath()
142 * with the url's path. If the url contains a query string
143 * the underlying HttpMethod.setQueryString() is called.
144 *
145 * @param url - the URL for this request.
146 * @throws MalformedURLException If the url isn't valid.
147 */
148 public void setUrl(String url) throws MalformedURLException {
149 super.setPath(URIUtil.getPath(url));
150 this.url = url;
151 String query = URIUtil.getQuery(url);
152 if (query != null && query.length() > 0) {
153 super.setQueryString(query);
154 }
155 }
156
157 /***
158 * Returns this request's URL.
159 *
160 * @return the request's URL.
161 */
162 public String getUrl() {
163 return url;
164 }
165 }
This page was automatically generated by Maven