| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> |
| <span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> |
| <span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> |
| <span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> |
| <span class="sourceLineNo">006</span>// * *<a name="line.6"></a> |
| <span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> |
| <span class="sourceLineNo">008</span>// * *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> |
| <span class="sourceLineNo">013</span>package org.apache.juneau.http.header;<a name="line.13"></a> |
| <span class="sourceLineNo">014</span><a name="line.14"></a> |
| <span class="sourceLineNo">015</span>import java.util.function.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span><a name="line.16"></a> |
| <span class="sourceLineNo">017</span>import org.apache.juneau.http.annotation.*;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>/**<a name="line.19"></a> |
| <span class="sourceLineNo">020</span> * Represents a parsed <l>Authorization</l> HTTP request header.<a name="line.20"></a> |
| <span class="sourceLineNo">021</span> *<a name="line.21"></a> |
| <span class="sourceLineNo">022</span> * <p><a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * Authentication credentials for HTTP authentication.<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> *<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * <h5 class='figure'>Example</h5><a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * <p class='bcode'><a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * </p><a name="line.28"></a> |
| <span class="sourceLineNo">029</span> *<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * <h5 class='topic'>RFC2616 Specification</h5><a name="line.30"></a> |
| <span class="sourceLineNo">031</span> *<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * A user agent that wishes to authenticate itself with a server--usually, but not necessarily, after receiving a 401<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * response--does so by including an Authorization request-header field with the request.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> *<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <p><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * The Authorization field value consists of credentials containing the authentication information of the user agent for<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * the realm of the resource being requested.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> *<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <p class='bcode'><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * Authorization = "Authorization" ":" credentials<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * </p><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> *<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <p><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * HTTP access authentication is described in "HTTP Authentication: Basic and Digest Access Authentication".<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> *<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <p><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * If a request is authenticated and a realm specified, the same credentials SHOULD be valid for all other requests<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * within this realm (assuming that the authentication scheme itself does not require otherwise, such as credentials<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * that vary according to a challenge value or using synchronized clocks).<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> *<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <p><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * When a shared cache (see section 13.7) receives a request containing an Authorization field, it MUST NOT return the<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * corresponding response as a reply to any other request, unless one of the following specific exceptions holds:<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * <ol><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <li>If the response includes the "s-maxage" cache-control directive, the cache MAY use that response in replying<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * to a subsequent request.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * But (if the specified maximum age has passed) a proxy cache MUST first revalidate it with the origin<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * server, using the request-headers from the new request to allow the origin server to authenticate the new<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * request.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * (This is the defined behavior for s-maxage.)<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * If the response includes "s-maxage=0", the proxy MUST always revalidate it before re-using it.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * <li>If the response includes the "must-revalidate" cache-control directive, the cache MAY use that response in<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * replying to a subsequent request.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * But if the response is stale, all caches MUST first revalidate it with the origin server, using the<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * request-headers from the new request to allow the origin server to authenticate the new request.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * <li>If the response includes the "public" cache-control directive, it MAY be returned in reply to any subsequent<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * request.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * </ol><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> *<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * <ul class='seealso'><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * <li class='link'>{@doc jm.HttpParts}<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * <li class='extlink'>{@doc ext.RFC2616}<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <li class='extlink'>{@source}<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * </ul><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> *<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * @serial exclude<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> */<a name="line.77"></a> |
| <span class="sourceLineNo">078</span>@Header("Authorization")<a name="line.78"></a> |
| <span class="sourceLineNo">079</span>public class Authorization extends BasicStringHeader {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> // Static<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> private static final long serialVersionUID = 1L;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> private static final String NAME = "Authorization";<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> /**<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * Static creator.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> *<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @param value<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * The header value.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * <br>Can be <jk>null</jk>.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @return A new header bean, or <jk>null</jk> if the value is <jk>null</jk>.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> public static Authorization of(String value) {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> return value == null ? null : new Authorization(value);<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> }<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> /**<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * Static creator with delayed value.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> *<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * <p><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * Header value is re-evaluated on each call to {@link #getValue()}.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> *<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @param value<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * The supplier of the header value.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * <br>Can be <jk>null</jk>.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @return A new header bean, or <jk>null</jk> if the value is <jk>null</jk>.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> */<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> public static Authorization of(Supplier<String> value) {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> return value == null ? null : new Authorization(value);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> // Instance<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.117"></a> |
| <span class="sourceLineNo">118</span><a name="line.118"></a> |
| <span class="sourceLineNo">119</span> /**<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * Constructor.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> *<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * @param value<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * The header value.<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * <br>Can be <jk>null</jk>.<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> */<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> public Authorization(String value) {<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> super(NAME, value);<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> }<a name="line.128"></a> |
| <span class="sourceLineNo">129</span><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> /**<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * Constructor with delayed value.<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> *<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * <p><a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * Header value is re-evaluated on each call to {@link #getValue()}.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> *<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * @param value<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * The supplier of the header value.<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * <br>Can be <jk>null</jk>.<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> */<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> public Authorization(Supplier<String> value) {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> super(NAME, value);<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span>}<a name="line.143"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
