📄 cookiespec.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /><title>CookieSpec xref</title><link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../../../apidocs/org/apache/commons/httpclient/cookie/CookieSpec.html">View Javadoc</a></div><pre><a name="1" href="#1">1</a> <em class="comment">/*</em><a name="2" href="#2">2</a> <em class="comment"> * $Header: /cvsroot/archive-crawler/ArchiveOpenCrawler/src/java/org/apache/commons/httpclient/cookie/CookieSpec.java,v 1.1 2005/06/06 17:50:02 gojomo Exp $</em><a name="3" href="#3">3</a> <em class="comment"> * $Revision: 1.1 $</em><a name="4" href="#4">4</a> <em class="comment"> * $Date: 2005/06/06 17:50:02 $</em><a name="5" href="#5">5</a> <em class="comment"> *</em><a name="6" href="#6">6</a> <em class="comment"> * ====================================================================</em><a name="7" href="#7">7</a> <em class="comment"> *</em><a name="8" href="#8">8</a> <em class="comment"> * Copyright 2002-2004 The Apache Software Foundation</em><a name="9" href="#9">9</a> <em class="comment"> *</em><a name="10" href="#10">10</a> <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em><a name="11" href="#11">11</a> <em class="comment"> * you may not use this file except in compliance with the License.</em><a name="12" href="#12">12</a> <em class="comment"> * You may obtain a copy of the License at</em><a name="13" href="#13">13</a> <em class="comment"> *</em><a name="14" href="#14">14</a> <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em><a name="15" href="#15">15</a> <em class="comment"> *</em><a name="16" href="#16">16</a> <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em><a name="17" href="#17">17</a> <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em><a name="18" href="#18">18</a> <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em><a name="19" href="#19">19</a> <em class="comment"> * See the License for the specific language governing permissions and</em><a name="20" href="#20">20</a> <em class="comment"> * limitations under the License.</em><a name="21" href="#21">21</a> <em class="comment"> * ====================================================================</em><a name="22" href="#22">22</a> <em class="comment"> *</em><a name="23" href="#23">23</a> <em class="comment"> * This software consists of voluntary contributions made by many</em><a name="24" href="#24">24</a> <em class="comment"> * individuals on behalf of the Apache Software Foundation. For more</em><a name="25" href="#25">25</a> <em class="comment"> * information on the Apache Software Foundation, please see</em><a name="26" href="#26">26</a> <em class="comment"> * <<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.</em><a name="27" href="#27">27</a> <em class="comment"> *</em><a name="28" href="#28">28</a> <em class="comment"> */</em><a name="29" href="#29">29</a> <a name="30" href="#30">30</a> <strong>package</strong> <a href="../../../../../org/apache/commons/httpclient/cookie/package-summary.html">org.apache.commons.httpclient.cookie</a>;<a name="31" href="#31">31</a> <a name="32" href="#32">32</a> <strong>import</strong> java.util.Collection;<a name="33" href="#33">33</a> <strong>import</strong> java.util.SortedMap;<a name="34" href="#34">34</a> <a name="35" href="#35">35</a> <strong>import</strong> org.apache.commons.httpclient.Header;<a name="36" href="#36">36</a> <strong>import</strong> org.apache.commons.httpclient.NameValuePair;<a name="37" href="#37">37</a> <strong>import</strong> org.apache.commons.httpclient.Cookie;<a name="38" href="#38">38</a> <a name="39" href="#39">39</a> <em>/**<em>*</em></em><a name="40" href="#40">40</a> <em> * Defines the cookie management specification.</em><a name="41" href="#41">41</a> <em> * <p>Cookie management specification must define</em><a name="42" href="#42">42</a> <em> * <ul></em><a name="43" href="#43">43</a> <em> * <li> rules of parsing "Set-Cookie" header</em><a name="44" href="#44">44</a> <em> * <li> rules of validation of parsed cookies</em><a name="45" href="#45">45</a> <em> * <li> formatting of "Cookie" header </em><a name="46" href="#46">46</a> <em> * </ul></em><a name="47" href="#47">47</a> <em> * for a given host, port and path of origin</em><a name="48" href="#48">48</a> <em> * </em><a name="49" href="#49">49</a> <em> * @author <a href="<a href="mailto:oleg@ural.ru" target="alexandria_uri">mailto:oleg@ural.ru</a>">Oleg Kalnichevski</a></em><a name="50" href="#50">50</a> <em> * @author <a href="<a href="mailto:jsdever@apache.org" target="alexandria_uri">mailto:jsdever@apache.org</a>">Jeff Dever</a></em><a name="51" href="#51">51</a> <em> *</em><a name="52" href="#52">52</a> <em> * @since 2.0</em><a name="53" href="#53">53</a> <em> */</em><a name="54" href="#54">54</a> <strong>public</strong> <strong>interface</strong> <a href="../../../../../org/apache/commons/httpclient/cookie/CookieSpec.html">CookieSpec</a> { <a name="55" href="#55">55</a> <a name="56" href="#56">56</a> <em>/**<em>* Path delimiter */</em></em><a name="57" href="#57">57</a> <strong>static</strong> <strong>final</strong> String PATH_DELIM = <span class="string">"/"</span>;<a name="58" href="#58">58</a> <a name="59" href="#59">59</a> <em>/**<em>* Path delimiting charachter */</em></em><a name="60" href="#60">60</a> <strong>static</strong> <strong>final</strong> <strong>char</strong> PATH_DELIM_CHAR = PATH_DELIM.<strong>char</strong>At(0);<a name="61" href="#61">61</a> <a name="62" href="#62">62</a> <em>/**<em>*</em></em><a name="63" href="#63">63</a> <em> * Parse the <tt>"Set-Cookie"</tt> header value into Cookie array.</em><a name="64" href="#64">64</a> <em> *</em><a name="65" href="#65">65</a> <em> * @param host the host which sent the <tt>Set-Cookie</tt> header</em><a name="66" href="#66">66</a> <em> * @param port the port which sent the <tt>Set-Cookie</tt> header</em><a name="67" href="#67">67</a> <em> * @param path the path which sent the <tt>Set-Cookie</tt> header</em><a name="68" href="#68">68</a> <em> * @param secure <tt>true</tt> when the <tt>Set-Cookie</tt> header </em><a name="69" href="#69">69</a> <em> * was received over secure conection</em><a name="70" href="#70">70</a> <em> * @param header the <tt>Set-Cookie</tt> received from the server</em><a name="71" href="#71">71</a> <em> * @return an array of <tt>Cookie</tt>s parsed from the Set-Cookie value</em><a name="72" href="#72">72</a> <em> * @throws MalformedCookieException if an exception occurs during parsing</em><a name="73" href="#73">73</a> <em> * @throws IllegalArgumentException if an input parameter is illegal</em><a name="74" href="#74">74</a> <em> */</em><a name="75" href="#75">75</a> <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] parse(String host, <strong>int</strong> port, String path, <strong>boolean</strong> secure,<a name="76" href="#76">76</a> <strong>final</strong> String header)<a name="77" href="#77">77</a> throws MalformedCookieException, IllegalArgumentException;<a name="78" href="#78">78</a> <a name="79" href="#79">79</a> <em>/**<em>*</em></em><a name="80" href="#80">80</a> <em> * Parse the <tt>"Set-Cookie"</tt> Header into an array of Cookies.</em><a name="81" href="#81">81</a> <em> *</em><a name="82" href="#82">82</a> <em> * @param host the host which sent the <tt>Set-Cookie</tt> header</em><a name="83" href="#83">83</a> <em> * @param port the port which sent the <tt>Set-Cookie</tt> header</em><a name="84" href="#84">84</a> <em> * @param path the path which sent the <tt>Set-Cookie</tt> header</em><a name="85" href="#85">85</a> <em> * @param secure <tt>true</tt> when the <tt>Set-Cookie</tt> header </em><a name="86" href="#86">86</a> <em> * was received over secure conection</em><a name="87" href="#87">87</a> <em> * @param header the <tt>Set-Cookie</tt> received from the server</em><a name="88" href="#88">88</a> <em> * @return an array of <tt>Cookie</tt>s parsed from the header</em><a name="89" href="#89">89</a> <em> * @throws MalformedCookieException if an exception occurs during parsing</em><a name="90" href="#90">90</a> <em> * @throws IllegalArgumentException if an input parameter is illegal</em><a name="91" href="#91">91</a> <em> */</em><a name="92" href="#92">92</a> <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a>[] parse(String host, <strong>int</strong> port, String path, <strong>boolean</strong> secure, <a name="93" href="#93">93</a> <strong>final</strong> Header header)<a name="94" href="#94">94</a> throws MalformedCookieException, IllegalArgumentException;<a name="95" href="#95">95</a> <a name="96" href="#96">96</a> <em>/**<em>*</em></em><a name="97" href="#97">97</a> <em> * Parse the cookie attribute and update the corresponsing Cookie </em><a name="98" href="#98">98</a> <em> * properties.</em><a name="99" href="#99">99</a> <em> *</em><a name="100" href="#100">100</a> <em> * @param attribute cookie attribute from the <tt>Set-Cookie</tt></em><a name="101" href="#101">101</a> <em> * @param cookie the to be updated</em><a name="102" href="#102">102</a> <em> * @throws MalformedCookieException if an exception occurs during parsing</em><a name="103" href="#103">103</a> <em> * @throws IllegalArgumentException if an input parameter is illegal</em><a name="104" href="#104">104</a> <em> */</em><a name="105" href="#105">105</a> <strong>void</strong> parseAttribute(NameValuePair attribute, <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookie)<a name="106" href="#106">106</a> throws MalformedCookieException, IllegalArgumentException;<a name="107" href="#107">107</a> <a name="108" href="#108">108</a> <em>/**<em>*</em></em><a name="109" href="#109">109</a> <em> * Validate the cookie according to validation rules defined by the </em><a name="110" href="#110">110</a> <em> * cookie specification.</em><a name="111" href="#111">111</a> <em> *</em><a name="112" href="#112">112</a> <em> * @param host the host from which the {@link Cookie} was received</em><a name="113" href="#113">113</a> <em> * @param port the port from which the {@link Cookie} was received</em><a name="114" href="#114">114</a> <em> * @param path the path from which the {@link Cookie} was received</em><a name="115" href="#115">115</a> <em> * @param secure <tt>true</tt> when the {@link Cookie} was received </em><a name="116" href="#116">116</a> <em> * using a secure connection</em><a name="117" href="#117">117</a> <em> * @param cookie the Cookie to validate</em><a name="118" href="#118">118</a> <em> * @throws MalformedCookieException if the cookie is invalid</em><a name="119" href="#119">119</a> <em> * @throws IllegalArgumentException if an input parameter is illegal</em><a name="120" href="#120">120</a> <em> */</em><a name="121" href="#121">121</a> <strong>void</strong> validate(String host, <strong>int</strong> port, String path, <strong>boolean</strong> secure, <a name="122" href="#122">122</a> <strong>final</strong> <a href="../../../../../org/apache/commons/httpclient/Cookie.html">Cookie</a> cookie) <a name="123" href="#123">123</a> throws MalformedCookieException, IllegalArgumentException;<a name="124" href="#124">124</a> <a name="125" href="#125">125</a> ⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -