34
34
<a name="25" href="#25">25</a> <em class="comment"> * information on the Apache Software Foundation, please see</em>
35
35
<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>
36
36
<a name="27" href="#27">27</a> <em class="comment"> *</em>
37
<a name="28" href="#28">28</a> <em class="comment"> * [Additional notices, if required by prior licensing conditions]</em>
38
<a name="29" href="#29">29</a> <em class="comment"> *</em>
39
<a name="30" href="#30">30</a> <em class="comment"> */</em>
37
<a name="28" href="#28">28</a> <em class="comment"> */</em>
38
<a name="29" href="#29">29</a>
39
<a name="30" href="#30">30</a> <strong>package</strong> <a href="../../../../../org/apache/commons/httpclient/auth/package-summary.html">org.apache.commons.httpclient.auth</a>;
40
40
<a name="31" href="#31">31</a>
41
<a name="32" href="#32">32</a> <strong>package</strong> <a href="../../../../../org/apache/commons/httpclient/auth/package-summary.html">org.apache.commons.httpclient.auth</a>;
41
<a name="32" href="#32">32</a> <strong>import</strong> java.util.Map;
42
42
<a name="33" href="#33">33</a>
43
<a name="34" href="#34">34</a> <strong>import</strong> java.util.Map;
44
<a name="35" href="#35">35</a>
45
<a name="36" href="#36">36</a> <em>/**<em>*</em></em>
46
<a name="37" href="#37">37</a> <em> * <p></em>
47
<a name="38" href="#38">38</a> <em> * Abstract authentication scheme class that lays foundation for all</em>
48
<a name="39" href="#39">39</a> <em> * RFC 2617 compliant authetication schemes and provides capabilities common </em>
49
<a name="40" href="#40">40</a> <em> * to all authentication schemes defined in RFC 2617.</em>
50
<a name="41" href="#41">41</a> <em> * </p></em>
51
<a name="42" href="#42">42</a> <em> *</em>
52
<a name="43" href="#43">43</a> <em> * @author <a href="<a href="mailto:oleg@ural.ru" target="alexandria_uri">mailto:oleg@ural.ru</a>">Oleg Kalnichevski</a></em>
53
<a name="44" href="#44">44</a> <em>*/</em>
54
<a name="45" href="#45">45</a> <strong>public</strong> <strong>abstract</strong> <strong>class</strong> RFC2617Scheme <strong>extends</strong> <a href="../../../../../org/apache/commons/httpclient/auth/AuthSchemeBase.html">AuthSchemeBase</a> {
55
<a name="46" href="#46">46</a>
56
<a name="47" href="#47">47</a> <em>/**<em>*</em></em>
57
<a name="48" href="#48">48</a> <em> * Authentication parameter map.</em>
58
<a name="49" href="#49">49</a> <em> */</em>
59
<a name="50" href="#50">50</a> <strong>private</strong> Map params = <strong>null</strong>;
60
<a name="51" href="#51">51</a>
61
<a name="52" href="#52">52</a> <em>/**<em>*</em></em>
62
<a name="53" href="#53">53</a> <em> * Default constructor for RFC2617 compliant authetication schemes.</em>
63
<a name="54" href="#54">54</a> <em> * </em>
64
<a name="55" href="#55">55</a> <em> * @param challenge authentication challenge</em>
65
<a name="56" href="#56">56</a> <em> * </em>
66
<a name="57" href="#57">57</a> <em> * @throws MalformedChallengeException is thrown if the authentication challenge</em>
67
<a name="58" href="#58">58</a> <em> * is malformed</em>
68
<a name="59" href="#59">59</a> <em> */</em>
69
<a name="60" href="#60">60</a> <strong>public</strong> RFC2617Scheme(<strong>final</strong> String challenge) throws MalformedChallengeException {
70
<a name="61" href="#61">61</a> <strong>super</strong>(challenge);
71
<a name="62" href="#62">62</a> String s = AuthChallengeParser.extractScheme(challenge);
72
<a name="63" href="#63">63</a> <strong>if</strong> (!s.equalsIgnoreCase(getSchemeName())) {
73
<a name="64" href="#64">64</a> <strong>throw</strong> <strong>new</strong> <a href="../../../../../org/apache/commons/httpclient/auth/MalformedChallengeException.html">MalformedChallengeException</a>(
74
<a name="65" href="#65">65</a> <span class="string">"Invalid "</span> + getSchemeName() + <span class="string">" challenge: "</span> + challenge);
75
<a name="66" href="#66">66</a> }
76
<a name="67" href="#67">67</a> <strong>this</strong>.params = AuthChallengeParser.extractParams(challenge);
77
<a name="68" href="#68">68</a> }
78
<a name="69" href="#69">69</a>
79
<a name="70" href="#70">70</a> <em>/**<em>*</em></em>
80
<a name="71" href="#71">71</a> <em> * Returns authentication parameters map. Keys in the map are lower-cased.</em>
81
<a name="72" href="#72">72</a> <em> * </em>
82
<a name="73" href="#73">73</a> <em> * @return the map of authentication parameters</em>
83
<a name="74" href="#74">74</a> <em> */</em>
84
<a name="75" href="#75">75</a> <strong>protected</strong> Map getParameters() {
85
<a name="76" href="#76">76</a> <strong>return</strong> <strong>this</strong>.params;
86
<a name="77" href="#77">77</a> }
87
<a name="78" href="#78">78</a>
88
<a name="79" href="#79">79</a> <em>/**<em>*</em></em>
89
<a name="80" href="#80">80</a> <em> * Returns authentication parameter with the given name, if available.</em>
43
<a name="34" href="#34">34</a> <em>/**<em>*</em></em>
44
<a name="35" href="#35">35</a> <em> * <p></em>
45
<a name="36" href="#36">36</a> <em> * Abstract authentication scheme class that lays foundation for all</em>
46
<a name="37" href="#37">37</a> <em> * RFC 2617 compliant authetication schemes and provides capabilities common </em>
47
<a name="38" href="#38">38</a> <em> * to all authentication schemes defined in RFC 2617.</em>
48
<a name="39" href="#39">39</a> <em> * </p></em>
49
<a name="40" href="#40">40</a> <em> *</em>
50
<a name="41" href="#41">41</a> <em> * @author <a href="<a href="mailto:oleg@ural.ru" target="alexandria_uri">mailto:oleg@ural.ru</a>">Oleg Kalnichevski</a></em>
51
<a name="42" href="#42">42</a> <em>*/</em>
52
<a name="43" href="#43">43</a> <strong>public</strong> <strong>abstract</strong> <strong>class</strong> RFC2617Scheme implements <a href="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html">AuthScheme</a> {
53
<a name="44" href="#44">44</a>
54
<a name="45" href="#45">45</a> <em>/**<em>*</em></em>
55
<a name="46" href="#46">46</a> <em> * Authentication parameter map.</em>
56
<a name="47" href="#47">47</a> <em> */</em>
57
<a name="48" href="#48">48</a> <strong>private</strong> Map params = <strong>null</strong>;
58
<a name="49" href="#49">49</a>
59
<a name="50" href="#50">50</a> <em>/**<em>*</em></em>
60
<a name="51" href="#51">51</a> <em> * Default constructor for RFC2617 compliant authetication schemes.</em>
61
<a name="52" href="#52">52</a> <em> * </em>
62
<a name="53" href="#53">53</a> <em> * @since 3.0</em>
63
<a name="54" href="#54">54</a> <em> */</em>
64
<a name="55" href="#55">55</a> <strong>public</strong> RFC2617Scheme() {
65
<a name="56" href="#56">56</a> <strong>super</strong>();
66
<a name="57" href="#57">57</a> }
67
<a name="58" href="#58">58</a>
68
<a name="59" href="#59">59</a> <em>/**<em>*</em></em>
69
<a name="60" href="#60">60</a> <em> * Default constructor for RFC2617 compliant authetication schemes.</em>
70
<a name="61" href="#61">61</a> <em> * </em>
71
<a name="62" href="#62">62</a> <em> * @param challenge authentication challenge</em>
72
<a name="63" href="#63">63</a> <em> * </em>
73
<a name="64" href="#64">64</a> <em> * @throws MalformedChallengeException is thrown if the authentication challenge</em>
74
<a name="65" href="#65">65</a> <em> * is malformed</em>
75
<a name="66" href="#66">66</a> <em> * </em>
76
<a name="67" href="#67">67</a> <em> * @deprecated Use parameterless constructor and {@link AuthScheme#processChallenge(String)} </em>
77
<a name="68" href="#68">68</a> <em> * method</em>
78
<a name="69" href="#69">69</a> <em> */</em>
79
<a name="70" href="#70">70</a> <strong>public</strong> RFC2617Scheme(<strong>final</strong> String challenge) throws MalformedChallengeException {
80
<a name="71" href="#71">71</a> <strong>super</strong>();
81
<a name="72" href="#72">72</a> processChallenge(challenge);
82
<a name="73" href="#73">73</a> }
83
<a name="74" href="#74">74</a>
84
<a name="75" href="#75">75</a> <em>/**<em>*</em></em>
85
<a name="76" href="#76">76</a> <em> * Processes the given challenge token. Some authentication schemes</em>
86
<a name="77" href="#77">77</a> <em> * may involve multiple challenge-response exchanges. Such schemes must be able </em>
87
<a name="78" href="#78">78</a> <em> * to maintain the state information when dealing with sequential challenges </em>
88
<a name="79" href="#79">79</a> <em> * </em>
89
<a name="80" href="#80">80</a> <em> * @param challenge the challenge string</em>
90
90
<a name="81" href="#81">81</a> <em> * </em>
91
<a name="82" href="#82">82</a> <em> * @param name The name of the parameter to be returned</em>
92
<a name="83" href="#83">83</a> <em> * </em>
93
<a name="84" href="#84">84</a> <em> * @return the parameter with the given name</em>
94
<a name="85" href="#85">85</a> <em> */</em>
95
<a name="86" href="#86">86</a> <strong>public</strong> String getParameter(String name) {
96
<a name="87" href="#87">87</a> <strong>if</strong> (name == <strong>null</strong>) {
97
<a name="88" href="#88">88</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Parameter name may not be null"</span>);
98
<a name="89" href="#89">89</a> }
99
<a name="90" href="#90">90</a> <strong>return</strong> (String) <strong>this</strong>.params.get(name.toLowerCase());
100
<a name="91" href="#91">91</a> }
101
<a name="92" href="#92">92</a>
102
<a name="93" href="#93">93</a> <em>/**<em>*</em></em>
103
<a name="94" href="#94">94</a> <em> * Returns authentication realm. The realm may not be null.</em>
104
<a name="95" href="#95">95</a> <em> * </em>
105
<a name="96" href="#96">96</a> <em> * @return the authentication realm</em>
106
<a name="97" href="#97">97</a> <em> */</em>
107
<a name="98" href="#98">98</a> <strong>public</strong> String getRealm() {
108
<a name="99" href="#99">99</a> <strong>return</strong> getParameter(<span class="string">"realm"</span>);
109
<a name="100" href="#100">100</a> }
110
<a name="101" href="#101">101</a>
111
<a name="102" href="#102">102</a> <em>/**<em>*</em></em>
112
<a name="103" href="#103">103</a> <em> * Returns a String identifying the authentication challenge. This is</em>
113
<a name="104" href="#104">104</a> <em> * used, in combination with the host and port to determine if</em>
114
<a name="105" href="#105">105</a> <em> * authorization has already been attempted or not. Schemes which</em>
115
<a name="106" href="#106">106</a> <em> * require multiple requests to complete the authentication should</em>
116
<a name="107" href="#107">107</a> <em> * return a different value for each stage in the request.</em>
117
<a name="108" href="#108">108</a> <em> * </em>
118
<a name="109" href="#109">109</a> <em> * <p>Additionally, the ID should take into account any changes to the</em>
119
<a name="110" href="#110">110</a> <em> * authentication challenge and return a different value when appropriate.</em>
120
<a name="111" href="#111">111</a> <em> * For example when the realm changes in basic authentication it should be</em>
121
<a name="112" href="#112">112</a> <em> * considered a different authentication attempt and a different value should</em>
122
<a name="113" href="#113">113</a> <em> * be returned.</p></em>
123
<a name="114" href="#114">114</a> <em> * </em>
124
<a name="115" href="#115">115</a> <em> * <p>This method simply returns the realm for the challenge.</p></em>
125
<a name="116" href="#116">116</a> <em> * </em>
126
<a name="117" href="#117">117</a> <em> * @return String a String identifying the authentication challenge. The</em>
127
<a name="118" href="#118">118</a> <em> * returned value may be null.</em>
128
<a name="119" href="#119">119</a> <em> */</em>
129
<a name="120" href="#120">120</a> <strong>public</strong> String getID() {
130
<a name="121" href="#121">121</a> <strong>return</strong> getRealm();
131
<a name="122" href="#122">122</a> }
132
<a name="123" href="#123">123</a> }
91
<a name="82" href="#82">82</a> <em> * @throws MalformedChallengeException is thrown if the authentication challenge</em>
92
<a name="83" href="#83">83</a> <em> * is malformed</em>
93
<a name="84" href="#84">84</a> <em> * </em>
94
<a name="85" href="#85">85</a> <em> * @since 3.0</em>
95
<a name="86" href="#86">86</a> <em> */</em>
96
<a name="87" href="#87">87</a> <strong>public</strong> <strong>void</strong> processChallenge(<strong>final</strong> String challenge) throws MalformedChallengeException {
97
<a name="88" href="#88">88</a> String s = AuthChallengeParser.extractScheme(challenge);
98
<a name="89" href="#89">89</a> <strong>if</strong> (!s.equalsIgnoreCase(getSchemeName())) {
99
<a name="90" href="#90">90</a> <strong>throw</strong> <strong>new</strong> <a href="../../../../../org/apache/commons/httpclient/auth/MalformedChallengeException.html">MalformedChallengeException</a>(
100
<a name="91" href="#91">91</a> <span class="string">"Invalid "</span> + getSchemeName() + <span class="string">" challenge: "</span> + challenge);
101
<a name="92" href="#92">92</a> }
102
<a name="93" href="#93">93</a> <strong>this</strong>.params = AuthChallengeParser.extractParams(challenge);
103
<a name="94" href="#94">94</a> }
104
<a name="95" href="#95">95</a>
105
<a name="96" href="#96">96</a> <em>/**<em>*</em></em>
106
<a name="97" href="#97">97</a> <em> * Returns authentication parameters map. Keys in the map are lower-cased.</em>
107
<a name="98" href="#98">98</a> <em> * </em>
108
<a name="99" href="#99">99</a> <em> * @return the map of authentication parameters</em>
109
<a name="100" href="#100">100</a> <em> */</em>
110
<a name="101" href="#101">101</a> <strong>protected</strong> Map getParameters() {
111
<a name="102" href="#102">102</a> <strong>return</strong> <strong>this</strong>.params;
112
<a name="103" href="#103">103</a> }
113
<a name="104" href="#104">104</a>
114
<a name="105" href="#105">105</a> <em>/**<em>*</em></em>
115
<a name="106" href="#106">106</a> <em> * Returns authentication parameter with the given name, if available.</em>
116
<a name="107" href="#107">107</a> <em> * </em>
117
<a name="108" href="#108">108</a> <em> * @param name The name of the parameter to be returned</em>
118
<a name="109" href="#109">109</a> <em> * </em>
119
<a name="110" href="#110">110</a> <em> * @return the parameter with the given name</em>
120
<a name="111" href="#111">111</a> <em> */</em>
121
<a name="112" href="#112">112</a> <strong>public</strong> String getParameter(String name) {
122
<a name="113" href="#113">113</a> <strong>if</strong> (name == <strong>null</strong>) {
123
<a name="114" href="#114">114</a> <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Parameter name may not be null"</span>);
124
<a name="115" href="#115">115</a> }
125
<a name="116" href="#116">116</a> <strong>if</strong> (<strong>this</strong>.params == <strong>null</strong>) {
126
<a name="117" href="#117">117</a> <strong>return</strong> <strong>null</strong>;
127
<a name="118" href="#118">118</a> }
128
<a name="119" href="#119">119</a> <strong>return</strong> (String) <strong>this</strong>.params.get(name.toLowerCase());
129
<a name="120" href="#120">120</a> }
130
<a name="121" href="#121">121</a>
131
<a name="122" href="#122">122</a> <em>/**<em>*</em></em>
132
<a name="123" href="#123">123</a> <em> * Returns authentication realm. The realm may not be null.</em>
133
<a name="124" href="#124">124</a> <em> * </em>
134
<a name="125" href="#125">125</a> <em> * @return the authentication realm</em>
135
<a name="126" href="#126">126</a> <em> */</em>
136
<a name="127" href="#127">127</a> <strong>public</strong> String getRealm() {
137
<a name="128" href="#128">128</a> <strong>return</strong> getParameter(<span class="string">"realm"</span>);
138
<a name="129" href="#129">129</a> }
139
<a name="130" href="#130">130</a>
140
<a name="131" href="#131">131</a> <em>/**<em>*</em></em>
141
<a name="132" href="#132">132</a> <em> * Returns a String identifying the authentication challenge. This is</em>
142
<a name="133" href="#133">133</a> <em> * used, in combination with the host and port to determine if</em>
143
<a name="134" href="#134">134</a> <em> * authorization has already been attempted or not. Schemes which</em>
144
<a name="135" href="#135">135</a> <em> * require multiple requests to complete the authentication should</em>
145
<a name="136" href="#136">136</a> <em> * return a different value for each stage in the request.</em>
146
<a name="137" href="#137">137</a> <em> * </em>
147
<a name="138" href="#138">138</a> <em> * <p>Additionally, the ID should take into account any changes to the</em>
148
<a name="139" href="#139">139</a> <em> * authentication challenge and return a different value when appropriate.</em>
149
<a name="140" href="#140">140</a> <em> * For example when the realm changes in basic authentication it should be</em>
150
<a name="141" href="#141">141</a> <em> * considered a different authentication attempt and a different value should</em>
151
<a name="142" href="#142">142</a> <em> * be returned.</p></em>
152
<a name="143" href="#143">143</a> <em> * </em>
153
<a name="144" href="#144">144</a> <em> * <p>This method simply returns the realm for the challenge.</p></em>
154
<a name="145" href="#145">145</a> <em> * </em>
155
<a name="146" href="#146">146</a> <em> * @return String a String identifying the authentication challenge. The</em>
156
<a name="147" href="#147">147</a> <em> * returned value may be null.</em>
157
<a name="148" href="#148">148</a> <em> * </em>
158
<a name="149" href="#149">149</a> <em> * @deprecated no longer used</em>
159
<a name="150" href="#150">150</a> <em> */</em>
160
<a name="151" href="#151">151</a> <strong>public</strong> String getID() {
161
<a name="152" href="#152">152</a> <strong>return</strong> getRealm();
162
<a name="153" href="#153">153</a> }
163
<a name="154" href="#154">154</a> }
134
165
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
added
removed
docs/xref/org/apache/commons/httpclient/auth/RFC2617Scheme.html
