1 /*
2 * $Header: $
3 * $Revision: $
4 * $Date: $
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.HttpMethodBase;
67
68 /***
69 * Implements the HTTP TRACE method.
70 * <p>
71 * The HTTP TRACE method is defined in section 9.6 of
72 * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
73 * <blockquote>
74 * The TRACE method is used to invoke a remote, application-layer loop-
75 * back of the request message. The final recipient of the request
76 * SHOULD reflect the message received back to the client as the
77 * entity-body of a 200 (OK) response. The final recipient is either the
78 * origin server or the first proxy or gateway to receive a Max-Forwards
79 * value of zero (0) in the request (see section 14.31). A TRACE request
80 * MUST NOT include an entity.
81 * </blockquote>
82 * </p>
83 *
84 * @author Sean C. Sullivan
85 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
86 * @author <a href="mailto:jsdever@apache.org">Jeff Dever</a>
87 *
88 * @version $Revision$
89 * @since 2.0
90 *
91 */
92 public class TraceMethod extends HttpMethodBase {
93
94 //~ Constructors
95
96 /***
97 * Constructor specifying a URI.
98 *
99 * @param uri either an absolute or relative URI
100 *
101 * @since 2.0
102 *
103 */
104 public TraceMethod(String uri) {
105 super(uri);
106 setFollowRedirects(false);
107 }
108
109 //~ Methods
110
111 /***
112 * Returns <tt>"TRACE"</tt>.
113 *
114 * @return <tt>"TRACE"</tt>
115 *
116 * @since 2.0
117 *
118 */
119 public String getName() {
120 return "TRACE";
121 }
122
123 /***
124 * Recycles the HTTP method so that it can be used again.
125 * Note that all of the instance variables will be reset
126 * once this method has been called. This method will also
127 * release the connection being used by this HTTP method.
128 *
129 * @see #releaseConnection()
130 *
131 * @since 2.0
132 *
133 */
134 public void recycle() {
135 super.recycle();
136 setFollowRedirects(false);
137 }
138
139 }
This page was automatically generated by Maven