📄 cookiespec.html
字号:
<a name="126" href="#126">126</a> <em>/**<em>*</em></em><a name="127" href="#127">127</a> <em> * Sets the {@link Collection} of date patterns used for parsing. The String patterns must be </em><a name="128" href="#128">128</a> <em> * compatible with {@link java.text.SimpleDateFormat}.</em><a name="129" href="#129">129</a> <em> *</em><a name="130" href="#130">130</a> <em> * @param datepatterns collection of date patterns</em><a name="131" href="#131">131</a> <em> */</em><a name="132" href="#132">132</a> <strong>void</strong> setValidDateFormats(Collection datepatterns);<a name="133" href="#133">133</a> <a name="134" href="#134">134</a> <em>/**<em>*</em></em><a name="135" href="#135">135</a> <em> * Returns the {@link Collection} of date patterns used for parsing. The String patterns are compatible </em><a name="136" href="#136">136</a> <em> * with the {@link java.text.SimpleDateFormat}.</em><a name="137" href="#137">137</a> <em> *</em><a name="138" href="#138">138</a> <em> * @return collection of date patterns</em><a name="139" href="#139">139</a> <em> */</em><a name="140" href="#140">140</a> Collection getValidDateFormats();<a name="141" href="#141">141</a> <a name="142" href="#142">142</a> <em>/**<em>*</em></em><a name="143" href="#143">143</a> <em> * Determines if a Cookie matches a location.</em><a name="144" href="#144">144</a> <em> *</em><a name="145" href="#145">145</a> <em> * @param host the host to which the request is being submitted</em><a name="146" href="#146">146</a> <em> * @param port the port to which the request is being submitted</em><a name="147" href="#147">147</a> <em> * @param path the path to which the request is being submitted</em><a name="148" href="#148">148</a> <em> * @param secure <tt>true</tt> if the request is using a secure connection</em><a name="149" href="#149">149</a> <em> * @param cookie the Cookie to be matched</em><a name="150" href="#150">150</a> <em> *</em><a name="151" href="#151">151</a> <em> * @return <tt>true</tt> if the cookie should be submitted with a request </em><a name="152" href="#152">152</a> <em> * with given attributes, <tt>false</tt> otherwise.</em><a name="153" href="#153">153</a> <em> */</em><a name="154" href="#154">154</a> <strong>boolean</strong> match(String host, <strong>int</strong> port, String path, <strong>boolean</strong> secure,<a name="155" href="#155">155</a> <strong>final</strong> <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookie);<a name="156" href="#156">156</a> <a name="157" href="#157">157</a> <em>/**<em>*</em></em><a name="158" href="#158">158</a> <em> * Determines which of an array of Cookies matches a location.</em><a name="159" href="#159">159</a> <em> *</em><a name="160" href="#160">160</a> <em> * @param host the host to which the request is being submitted</em><a name="161" href="#161">161</a> <em> * @param port the port to which the request is being submitted </em><a name="162" href="#162">162</a> <em> * (currenlty ignored)</em><a name="163" href="#163">163</a> <em> * @param path the path to which the request is being submitted</em><a name="164" href="#164">164</a> <em> * @param secure <tt>true</tt> if the request is using a secure protocol</em><a name="165" href="#165">165</a> <em> * @param cookies an array of <tt>Cookie</tt>s to be matched</em><a name="166" href="#166">166</a> <em> *</em><a name="167" href="#167">167</a> <em> * @return <tt>true</tt> if the cookie should be submitted with a request </em><a name="168" href="#168">168</a> <em> * with given attributes, <tt>false</tt> otherwise.</em><a name="169" href="#169">169</a> <em> * </em><a name="170" href="#170">170</a> <em>// BEGIN IA CHANGES</em><a name="171" href="#171">171</a> <em> * @deprecated use match(String, int, String, boolean, SortedMap)</em><a name="172" href="#172">172</a> <em>// END IA CHANGES</em><a name="173" href="#173">173</a> <em> */</em><a name="174" href="#174">174</a> <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] match(String host, <strong>int</strong> port, String path, <strong>boolean</strong> secure, <a name="175" href="#175">175</a> <strong>final</strong> <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookies[]);<a name="176" href="#176">176</a> <a name="177" href="#177">177</a> <em class="comment">// BEGIN IA CHANGES</em><a name="178" href="#178">178</a> <em>/**<em>*</em></em><a name="179" href="#179">179</a> <em> * Determines which of an array of Cookies matches a location.</em><a name="180" href="#180">180</a> <em> *</em><a name="181" href="#181">181</a> <em> * If the SortedMap comes from an HttpState and is not itself</em><a name="182" href="#182">182</a> <em> * thread-safe, it may be necessary to synchronize on the HttpState</em><a name="183" href="#183">183</a> <em> * instance to protect against concurrent modification. </em><a name="184" href="#184">184</a> <em> *</em><a name="185" href="#185">185</a> <em> * @param host the host to which the request is being submitted</em><a name="186" href="#186">186</a> <em> * @param port the port to which the request is being submitted </em><a name="187" href="#187">187</a> <em> * (currenlty ignored)</em><a name="188" href="#188">188</a> <em> * @param path the path to which the request is being submitted</em><a name="189" href="#189">189</a> <em> * @param secure <tt>true</tt> if the request is using a secure protocol</em><a name="190" href="#190">190</a> <em> * @param cookies SortedMap of <tt>Cookie</tt>s to be matched</em><a name="191" href="#191">191</a> <em> *</em><a name="192" href="#192">192</a> <em> * @return <tt>true</tt> if the cookie should be submitted with a request </em><a name="193" href="#193">193</a> <em> * with given attributes, <tt>false</tt> otherwise.</em><a name="194" href="#194">194</a> <em> */</em><a name="195" href="#195">195</a> <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] match(String domain, <strong>int</strong> port, String path, <strong>boolean</strong> secure, SortedMap cookiesMap);<a name="196" href="#196">196</a> <em class="comment">// END IA CHANGES</em><a name="197" href="#197">197</a> <a name="198" href="#198">198</a> <em>/**<em>*</em></em><a name="199" href="#199">199</a> <em> * Performs domain-match as defined by the cookie specification.</em><a name="200" href="#200">200</a> <em> * @param host The target host.</em><a name="201" href="#201">201</a> <em> * @param domain The cookie domain attribute.</em><a name="202" href="#202">202</a> <em> * @return true if the specified host matches the given domain.</em><a name="203" href="#203">203</a> <em> * </em><a name="204" href="#204">204</a> <em> * @since 3.0</em><a name="205" href="#205">205</a> <em> */</em><a name="206" href="#206">206</a> <strong>boolean</strong> domainMatch(String host, String domain);<a name="207" href="#207">207</a> <a name="208" href="#208">208</a> <em>/**<em>*</em></em><a name="209" href="#209">209</a> <em> * Performs path-match as defined by the cookie specification.</em><a name="210" href="#210">210</a> <em> * @param path The target path.</em><a name="211" href="#211">211</a> <em> * @param topmostPath The cookie path attribute.</em><a name="212" href="#212">212</a> <em> * @return true if the paths match</em><a name="213" href="#213">213</a> <em> * </em><a name="214" href="#214">214</a> <em> * @since 3.0</em><a name="215" href="#215">215</a> <em> */</em><a name="216" href="#216">216</a> <strong>boolean</strong> pathMatch(String path, String topmostPath);<a name="217" href="#217">217</a> <a name="218" href="#218">218</a> <em>/**<em>*</em></em><a name="219" href="#219">219</a> <em> * Create a <tt>"Cookie"</tt> header value for an array of cookies.</em><a name="220" href="#220">220</a> <em> *</em><a name="221" href="#221">221</a> <em> * @param cookie the cookie to be formatted as string</em><a name="222" href="#222">222</a> <em> * @return a string suitable for sending in a <tt>"Cookie"</tt> header.</em><a name="223" href="#223">223</a> <em> */</em><a name="224" href="#224">224</a> String formatCookie(<a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookie);<a name="225" href="#225">225</a> <a name="226" href="#226">226</a> <em>/**<em>*</em></em><a name="227" href="#227">227</a> <em> * Create a <tt>"Cookie"</tt> header value for an array of cookies.</em><a name="228" href="#228">228</a> <em> *</em><a name="229" href="#229">229</a> <em> * @param cookies the Cookies to be formatted</em><a name="230" href="#230">230</a> <em> * @return a string suitable for sending in a Cookie header.</em><a name="231" href="#231">231</a> <em> * @throws IllegalArgumentException if an input parameter is illegal</em><a name="232" href="#232">232</a> <em> */</em><a name="233" href="#233">233</a> String formatCookies(<a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] cookies) throws IllegalArgumentException;<a name="234" href="#234">234</a> <a name="235" href="#235">235</a> <em>/**<em>*</em></em><a name="236" href="#236">236</a> <em> * Create a <tt>"Cookie"</tt> Header for an array of Cookies.</em><a name="237" href="#237">237</a> <em> *</em><a name="238" href="#238">238</a> <em> * @param cookies the Cookies format into a Cookie header</em><a name="239" href="#239">239</a> <em> * @return a Header for the given Cookies.</em><a name="240" href="#240">240</a> <em> * @throws IllegalArgumentException if an input parameter is illegal</em><a name="241" href="#241">241</a> <em> */</em><a name="242" href="#242">242</a> Header formatCookieHeader(<a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] cookies) throws IllegalArgumentException;<a name="243" href="#243">243</a> <a name="244" href="#244">244</a> <em>/**<em>*</em></em><a name="245" href="#245">245</a> <em> * Create a <tt>"Cookie"</tt> Header for single Cookie.</em><a name="246" href="#246">246</a> <em> *</em><a name="247" href="#247">247</a> <em> * @param cookie the Cookie format as a <tt>Cookie</tt> header</em><a name="248" href="#248">248</a> <em> * @return a Cookie header.</em><a name="249" href="#249">249</a> <em> * @throws IllegalArgumentException if an input parameter is illegal</em><a name="250" href="#250">250</a> <em> */</em><a name="251" href="#251">251</a> Header formatCookieHeader(<a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookie) throws IllegalArgumentException;<a name="252" href="#252">252</a> <a name="253" href="#253">253</a> }</pre><hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body></html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -