~testplan-team/testplan/source-collection

<a name="2" href="#2">2</a> * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/methods/OptionsMethod.java,v 1.15 2004/04/18 23:51:37 jsdever Exp $

<a name="3" href="#3">3</a> * $Revision: 480424 $

<a name="4" href="#4">4</a> * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $

<a name="5" href="#5">5</a> *

<a name="6" href="#6">6</a> * ====================================================================

<a name="7" href="#7">7</a> *

<a name="8" href="#8">8</a> * Licensed to the Apache Software Foundation (ASF) under one or more

<a name="9" href="#9">9</a> * contributor license agreements. See the NOTICE file distributed with

<a name="10" href="#10">10</a> * this work for additional information regarding copyright ownership.

<a name="11" href="#11">11</a> * The ASF licenses this file to You under the Apache License, Version 2.0

<a name="12" href="#12">12</a> * (the "License"); you may not use this file except in compliance with

<a name="13" href="#13">13</a> * the License. You may obtain a copy of the License at

<a name="14" href="#14">14</a> *

<a name="15" href="#15">15</a> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a>

<a name="16" href="#16">16</a> *

<a name="17" href="#17">17</a> * Unless required by applicable law or agreed to in writing, software

<a name="18" href="#18">18</a> * distributed under the License is distributed on an "AS IS" BASIS,

<a name="19" href="#19">19</a> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

<a name="20" href="#20">20</a> * See the License for the specific language governing permissions and

<a name="21" href="#21">21</a> * limitations under the License.

<a name="22" href="#22">22</a> * ====================================================================

<a name="23" href="#23">23</a> *

<a name="24" href="#24">24</a> * This software consists of voluntary contributions made by many

<a name="25" href="#25">25</a> * individuals on behalf of the Apache Software Foundation. For more

<a name="26" href="#26">26</a> * information on the Apache Software Foundation, please see

<a name="27" href="#27">27</a> * <<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.

<a name="28" href="#28">28</a> *

<a name="29" href="#29">29</a> */

<a name="31" href="#31">31</a> package org.apache.commons.httpclient.methods;

<a name="33" href="#33">33</a> import org.apache.commons.httpclient.Header;

<a name="34" href="#34">34</a> import org.apache.commons.httpclient.HttpConnection;

<a name="35" href="#35">35</a> import org.apache.commons.httpclient.HttpMethodBase;

<a name="36" href="#36">36</a> import org.apache.commons.httpclient.HttpState;

<a name="38" href="#38">38</a> import org.apache.commons.logging.LogFactory;

<a name="39" href="#39">39</a> import org.apache.commons.logging.Log;

<a name="40" href="#40">40</a> import java.util.Enumeration;

<a name="41" href="#41">41</a> import java.util.StringTokenizer;

<a name="42" href="#42">42</a> import java.util.Vector;

<a name="45" href="#45">45</a> /**

<a name="46" href="#46">46</a> * Implements the HTTP OPTIONS method.

<a name="47" href="#47">47</a> *

<a name="48" href="#48">48</a> * The HTTP OPTIONS method is defined in section 9.2 of

<a name="49" href="#49">49</a> * <a href="<a href="http://www.ietf.org/rfc/rfc2616.txt" target="alexandria_uri">http://www.ietf.org/rfc/rfc2616.txt</a>">RFC2616</a>:

<a name="51" href="#51">51</a> * The OPTIONS method represents a request for information about the

<a name="52" href="#52">52</a> * communication options available on the request/response chain

<a name="53" href="#53">53</a> * identified by the Request-URI. This method allows the client to

<a name="54" href="#54">54</a> * determine the options and/or requirements associated with a resource,

<a name="55" href="#55">55</a> * or the capabilities of a server, without implying a resource action

<a name="56" href="#56">56</a> * or initiating a resource retrieval.

<a name="58" href="#58">58</a> *

<a name="59" href="#59">59</a> *

<a name="60" href="#60">60</a> * @author <a href="<a href="mailto:remm@apache.org" target="alexandria_uri">mailto:remm@apache.org</a>">Remy Maucherat</a>

<a name="61" href="#61">61</a> * @author <a href="<a href="mailto:mbowler@GargoyleSoftware.com" target="alexandria_uri">mailto:mbowler@GargoyleSoftware.com</a>">Mike Bowler</a>

<a name="62" href="#62">62</a> * @author <a href="<a href="mailto:jsdever@apache.org" target="alexandria_uri">mailto:jsdever@apache.org</a>">Jeff Dever</a>

<a name="63" href="#63">63</a> *

<a name="64" href="#64">64</a> * @version $Revision: 480424 $

<a name="65" href="#65">65</a> * @since 1.0

<a name="66" href="#66">66</a> */

<a name="67" href="#67">67</a> public class <a href="../../../../../org/apache/commons/httpclient/methods/OptionsMethod.html">OptionsMethod</a>

<a name="68" href="#68">68</a> extends <a href="../../../../../org/apache/commons/httpclient/HttpMethodBase.html">HttpMethodBase</a> {

<a name="71" href="#71">71</a> // --------------------------------------------------------- Class Variables

<a name="73" href="#73">73</a> /** Log object for this class. */

<a name="74" href="#74">74</a> private static final Log LOG = LogFactory.getLog(OptionsMethod.class);

<a name="76" href="#76">76</a> // ----------------------------------------------------------- Constructors

<a name="79" href="#79">79</a> /**

<a name="80" href="#80">80</a> * Method constructor.

<a name="81" href="#81">81</a> *

<a name="82" href="#82">82</a> * @since 1.0

<a name="83" href="#83">83</a> */

<a name="84" href="#84">84</a> public <a href="../../../../../org/apache/commons/httpclient/methods/OptionsMethod.html">OptionsMethod</a>() {

<a name="85" href="#85">85</a> }

<a name="88" href="#88">88</a> /**

<a name="89" href="#89">89</a> * Constructor specifying a URI.

<a name="90" href="#90">90</a> *

100

<a name="91" href="#91">91</a> * @param uri either an absolute or relative URI

101

<a name="92" href="#92">92</a> *

102

<a name="93" href="#93">93</a> * @since 1.0

103

<a name="94" href="#94">94</a> */

104

<a name="95" href="#95">95</a> public <a href="../../../../../org/apache/commons/httpclient/methods/OptionsMethod.html">OptionsMethod</a>(String uri) {

105

<a name="96" href="#96">96</a> super(uri);

106

<a name="97" href="#97">97</a> }

107

108

109

<a name="100" href="#100">100</a> // ----------------------------------------------------- Instance Variables

110

111

112

<a name="103" href="#103">103</a> /**

113

<a name="104" href="#104">104</a> * Methods allowed.

114

<a name="105" href="#105">105</a> */

115

<a name="106" href="#106">106</a> private Vector methodsAllowed = new Vector();

116

117

118

<a name="109" href="#109">109</a> // --------------------------------------------------------- Public Methods

119

120

<a name="111" href="#111">111</a> /**

121

<a name="112" href="#112">112</a> * Get the name.

122

<a name="113" href="#113">113</a> * @return "OPTIONS"

123

<a name="114" href="#114">114</a> * @since 2.0

124

<a name="115" href="#115">115</a> */

125

<a name="116" href="#116">116</a> public String getName() {

126

<a name="117" href="#117">117</a> return "OPTIONS";

127

<a name="118" href="#118">118</a> }

128

129

130

<a name="121" href="#121">121</a> /**

131

<a name="122" href="#122">122</a> * Is the specified method allowed ?

132

<a name="123" href="#123">123</a> *

133

<a name="124" href="#124">124</a> * @param method The method to check.

134

<a name="125" href="#125">125</a> * @return true if the specified method is allowed.

135

<a name="126" href="#126">126</a> * @since 1.0

136

<a name="127" href="#127">127</a> */

137

<a name="128" href="#128">128</a> public boolean isAllowed(String method) {

138

<a name="129" href="#129">129</a> checkUsed();

139

<a name="130" href="#130">130</a> return methodsAllowed.contains(method);

140

<a name="131" href="#131">131</a> }

141

142

143

<a name="134" href="#134">134</a> /**

144

<a name="135" href="#135">135</a> * Get a list of allowed methods.

145

<a name="136" href="#136">136</a> * @return An enumeration of all the allowed methods.

146

<a name="137" href="#137">137</a> *

147

<a name="138" href="#138">138</a> * @since 1.0

148

<a name="139" href="#139">139</a> */

149

<a name="140" href="#140">140</a> public Enumeration getAllowedMethods() {

150

<a name="141" href="#141">141</a> checkUsed();

151

<a name="142" href="#142">142</a> return methodsAllowed.elements();

152

<a name="143" href="#143">143</a> }

153

154

155

<a name="146" href="#146">146</a> // ----------------------------------------------------- HttpMethod Methods

156

157

<a name="148" href="#148">148</a> /**

158

<a name="149" href="#149">149</a> *

159

<a name="150" href="#150">150</a> * This implementation will parse the <tt>Allow</tt> header to obtain

160

<a name="151" href="#151">151</a> * the set of methods supported by the resource identified by the Request-URI.

161

<a name="152" href="#152">152</a> *

162

<a name="153" href="#153">153</a> *

163

<a name="154" href="#154">154</a> * @param state the {@link HttpState state} information associated with this method

164

<a name="155" href="#155">155</a> * @param conn the {@link HttpConnection connection} used to execute

165

<a name="156" href="#156">156</a> * this HTTP method

166

<a name="157" href="#157">157</a> *

167

<a name="158" href="#158">158</a> * @see #readResponse

168

<a name="159" href="#159">159</a> * @see #readResponseHeaders

169

<a name="160" href="#160">160</a> * @since 2.0

170

<a name="161" href="#161">161</a> */

171

<a name="162" href="#162">162</a> protected void processResponseHeaders(<a href="../../../../../org/apache/commons/httpclient/HttpState.html">HttpState</a> state, <a href="../../../../../org/apache/commons/httpclient/HttpConnection.html">HttpConnection</a> conn) {

172

<a name="163" href="#163">163</a> LOG.trace("enter OptionsMethod.processResponseHeaders(HttpState, HttpConnection)");

173

174

<a name="165" href="#165">165</a> <a href="../../../../../org/apache/commons/httpclient/Header.html">Header</a> allowHeader = getResponseHeader("allow");

175

<a name="166" href="#166">166</a> if (allowHeader != null) {

176

<a name="167" href="#167">167</a> String allowHeaderValue = allowHeader.getValue();

177

<a name="168" href="#168">168</a> StringTokenizer tokenizer =

178

<a name="169" href="#169">169</a> new StringTokenizer(allowHeaderValue, ",");

179

<a name="170" href="#170">170</a> while (tokenizer.hasMoreElements()) {

180

<a name="171" href="#171">171</a> String methodAllowed =

181

<a name="172" href="#172">172</a> tokenizer.nextToken().trim().toUpperCase();

182

<a name="173" href="#173">173</a> methodsAllowed.addElement(methodAllowed);

183

<a name="174" href="#174">174</a> }

184

<a name="175" href="#175">175</a> }

185

<a name="176" href="#176">176</a> }

186

187

<a name="178" href="#178">178</a> /**

188

<a name="179" href="#179">179</a> * Return true if the method needs a content-length header in the request.

189

<a name="180" href="#180">180</a> *

190

<a name="181" href="#181">181</a> * @return true if a content-length header will be expected by the server

191

<a name="182" href="#182">182</a> *

192

<a name="183" href="#183">183</a> * @since 1.0

193

<a name="184" href="#184">184</a> *

194

<a name="185" href="#185">185</a> * @deprecated only entity enclosing methods set content length header

195

<a name="186" href="#186">186</a> */

196

<a name="187" href="#187">187</a> public boolean needContentLength() {

197

<a name="188" href="#188">188</a> return false;

198

<a name="189" href="#189">189</a> }

199

200

201

<a name="192" href="#192">192</a> }

202

</pre>

203

<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>

204

</html>

205

Older »