http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/src-html/org/apache/juneau/http/AcceptCharset.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/http/AcceptCharset.html b/content/site/apidocs/src-html/org/apache/juneau/http/AcceptCharset.html new file mode 100644 index 0000000..6ea72b5 --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/http/AcceptCharset.html @@ -0,0 +1,154 @@ +<!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;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>import static org.apache.juneau.http.Constants.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span><a name="line.16"></a> +<span class="sourceLineNo">017</span>import org.apache.juneau.internal.*;<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>Accept-Charset</l> HTTP request header.<a name="line.20"></a> +<span class="sourceLineNo">021</span> * <p><a name="line.21"></a> +<span class="sourceLineNo">022</span> * Character sets that are acceptable.<a name="line.22"></a> +<span class="sourceLineNo">023</span> *<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <h6 class='figure'>Example</h6><a name="line.24"></a> +<span class="sourceLineNo">025</span> * <p class='bcode'><a name="line.25"></a> +<span class="sourceLineNo">026</span> * Accept-Charset: utf-8<a name="line.26"></a> +<span class="sourceLineNo">027</span> * </p><a name="line.27"></a> +<span class="sourceLineNo">028</span> *<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <h6 class='topic'>RFC2616 Specification</h6><a name="line.29"></a> +<span class="sourceLineNo">030</span> *<a name="line.30"></a> +<span class="sourceLineNo">031</span> * The Accept-Charset request-header field can be used to indicate what character sets are acceptable for the response.<a name="line.31"></a> +<span class="sourceLineNo">032</span> * <p><a name="line.32"></a> +<span class="sourceLineNo">033</span> * This field allows clients capable of understanding more comprehensive or special- purpose character sets to signal<a name="line.33"></a> +<span class="sourceLineNo">034</span> * that capability to a server which is capable of representing documents in those character sets.<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <p class='bcode'><a name="line.35"></a> +<span class="sourceLineNo">036</span> * Accept-Charset = "Accept-Charset" ":"<a name="line.36"></a> +<span class="sourceLineNo">037</span> * 1#( ( charset | "*" )[ ";" "q" "=" qvalue ] )<a name="line.37"></a> +<span class="sourceLineNo">038</span> * </p><a name="line.38"></a> +<span class="sourceLineNo">039</span> * <p><a name="line.39"></a> +<span class="sourceLineNo">040</span> * Character set values are described in section 3.4. Each charset MAY be given an associated quality value which<a name="line.40"></a> +<span class="sourceLineNo">041</span> * represents the user's preference for that charset.<a name="line.41"></a> +<span class="sourceLineNo">042</span> * The default value is q=1.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * An example is...<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <p class='bcode'><a name="line.44"></a> +<span class="sourceLineNo">045</span> * Accept-Charset: iso-8859-5, unicode-1-1;q=0.8<a name="line.45"></a> +<span class="sourceLineNo">046</span> * </p><a name="line.46"></a> +<span class="sourceLineNo">047</span> * <p><a name="line.47"></a> +<span class="sourceLineNo">048</span> * The special value "*", if present in the Accept-Charset field, matches every character set (including ISO-8859-1)<a name="line.48"></a> +<span class="sourceLineNo">049</span> * which is not mentioned elsewhere in the Accept-Charset field.<a name="line.49"></a> +<span class="sourceLineNo">050</span> * <p><a name="line.50"></a> +<span class="sourceLineNo">051</span> * If no "*" is present in an Accept-Charset field, then all character sets not explicitly mentioned get a quality<a name="line.51"></a> +<span class="sourceLineNo">052</span> * value of 0, except for ISO-8859-1, which gets a quality value of 1 if not explicitly mentioned.<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <p><a name="line.53"></a> +<span class="sourceLineNo">054</span> * If no Accept-Charset header is present, the default is that any character set is acceptable.<a name="line.54"></a> +<span class="sourceLineNo">055</span> * <p><a name="line.55"></a> +<span class="sourceLineNo">056</span> * If an Accept-Charset header is present, and if the server cannot send a response which is acceptable according to<a name="line.56"></a> +<span class="sourceLineNo">057</span> * the Accept-Charset header, then the server SHOULD send an error response with the 406 (not acceptable) status code,<a name="line.57"></a> +<span class="sourceLineNo">058</span> * though the sending of an unacceptable response is also allowed.<a name="line.58"></a> +<span class="sourceLineNo">059</span> */<a name="line.59"></a> +<span class="sourceLineNo">060</span>public final class AcceptCharset extends HeaderRangeArray {<a name="line.60"></a> +<span class="sourceLineNo">061</span><a name="line.61"></a> +<span class="sourceLineNo">062</span> private static final Cache<String,AcceptCharset> cache = new Cache<String,AcceptCharset>(NOCACHE, CACHE_MAX_SIZE);<a name="line.62"></a> +<span class="sourceLineNo">063</span><a name="line.63"></a> +<span class="sourceLineNo">064</span> /**<a name="line.64"></a> +<span class="sourceLineNo">065</span> * Returns a parsed <code>Accept-Charset</code> header.<a name="line.65"></a> +<span class="sourceLineNo">066</span> *<a name="line.66"></a> +<span class="sourceLineNo">067</span> * @param value The <code>Accept-Charset</code> header string.<a name="line.67"></a> +<span class="sourceLineNo">068</span> * @return The parsed <code>Accept-Charset</code> header, or <jk>null</jk> if the string was null.<a name="line.68"></a> +<span class="sourceLineNo">069</span> */<a name="line.69"></a> +<span class="sourceLineNo">070</span> public static AcceptCharset forString(String value) {<a name="line.70"></a> +<span class="sourceLineNo">071</span> if (value == null)<a name="line.71"></a> +<span class="sourceLineNo">072</span> return null;<a name="line.72"></a> +<span class="sourceLineNo">073</span> AcceptCharset a = cache.get(value);<a name="line.73"></a> +<span class="sourceLineNo">074</span> if (a == null)<a name="line.74"></a> +<span class="sourceLineNo">075</span> a = cache.put(value, new AcceptCharset(value));<a name="line.75"></a> +<span class="sourceLineNo">076</span> return a;<a name="line.76"></a> +<span class="sourceLineNo">077</span> }<a name="line.77"></a> +<span class="sourceLineNo">078</span><a name="line.78"></a> +<span class="sourceLineNo">079</span> private AcceptCharset(String value) {<a name="line.79"></a> +<span class="sourceLineNo">080</span> super(value);<a name="line.80"></a> +<span class="sourceLineNo">081</span> }<a name="line.81"></a> +<span class="sourceLineNo">082</span>}<a name="line.82"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/src-html/org/apache/juneau/http/AcceptEncoding.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/http/AcceptEncoding.html b/content/site/apidocs/src-html/org/apache/juneau/http/AcceptEncoding.html index bbf4248..ffa31cc 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/http/AcceptEncoding.html +++ b/content/site/apidocs/src-html/org/apache/juneau/http/AcceptEncoding.html @@ -20,145 +20,94 @@ <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> <span class="sourceLineNo">013</span>package org.apache.juneau.http;<a name="line.13"></a> <span class="sourceLineNo">014</span><a name="line.14"></a> -<span class="sourceLineNo">015</span>import java.util.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span>import java.util.concurrent.*;<a name="line.16"></a> -<span class="sourceLineNo">017</span><a name="line.17"></a> -<span class="sourceLineNo">018</span>import org.apache.juneau.internal.*;<a name="line.18"></a> -<span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>/**<a name="line.20"></a> -<span class="sourceLineNo">021</span> * Represents a parsed <code>Accept-Encoding:</code> HTTP header.<a name="line.21"></a> -<span class="sourceLineNo">022</span> * <p><a name="line.22"></a> -<span class="sourceLineNo">023</span> * The formal RFC2616 header field definition is as follows:<a name="line.23"></a> -<span class="sourceLineNo">024</span> * <p class='bcode'><a name="line.24"></a> -<span class="sourceLineNo">025</span> * The Accept-Encoding request-header field is similar to Accept, but restricts<a name="line.25"></a> -<span class="sourceLineNo">026</span> * the content-codings (section 3.5) that are acceptable in the response.<a name="line.26"></a> -<span class="sourceLineNo">027</span> *<a name="line.27"></a> -<span class="sourceLineNo">028</span> * Accept-Encoding = "Accept-Encoding" ":"<a name="line.28"></a> -<span class="sourceLineNo">029</span> * 1#( codings [ ";" "q" "=" qvalue ] )<a name="line.29"></a> -<span class="sourceLineNo">030</span> * codings = ( content-coding | "*" )<a name="line.30"></a> -<span class="sourceLineNo">031</span> *<a name="line.31"></a> -<span class="sourceLineNo">032</span> * Examples of its use are:<a name="line.32"></a> -<span class="sourceLineNo">033</span> *<a name="line.33"></a> -<span class="sourceLineNo">034</span> * Accept-Encoding: compress, gzip<a name="line.34"></a> -<span class="sourceLineNo">035</span> * Accept-Encoding:<a name="line.35"></a> -<span class="sourceLineNo">036</span> * Accept-Encoding: *<a name="line.36"></a> -<span class="sourceLineNo">037</span> * Accept-Encoding: compress;q=0.5, gzip;q=1.0<a name="line.37"></a> -<span class="sourceLineNo">038</span> * Accept-Encoding: gzip;q=1.0, identity; q=0.5, *;q=0<a name="line.38"></a> -<span class="sourceLineNo">039</span> *<a name="line.39"></a> -<span class="sourceLineNo">040</span> * A server tests whether a content-coding is acceptable, according to an<a name="line.40"></a> -<span class="sourceLineNo">041</span> * Accept-Encoding field, using these rules:<a name="line.41"></a> -<span class="sourceLineNo">042</span> *<a name="line.42"></a> -<span class="sourceLineNo">043</span> * 1. If the content-coding is one of the content-codings listed in<a name="line.43"></a> -<span class="sourceLineNo">044</span> * the Accept-Encoding field, then it is acceptable, unless it is<a name="line.44"></a> -<span class="sourceLineNo">045</span> * accompanied by a qvalue of 0. (As defined in section 3.9, a<a name="line.45"></a> -<span class="sourceLineNo">046</span> * qvalue of 0 means "not acceptable.")<a name="line.46"></a> -<span class="sourceLineNo">047</span> * 2. The special "*" symbol in an Accept-Encoding field matches any<a name="line.47"></a> -<span class="sourceLineNo">048</span> * available content-coding not explicitly listed in the header<a name="line.48"></a> -<span class="sourceLineNo">049</span> * field.<a name="line.49"></a> -<span class="sourceLineNo">050</span> * 3. If multiple content-codings are acceptable, then the acceptable<a name="line.50"></a> -<span class="sourceLineNo">051</span> * content-coding with the highest non-zero qvalue is preferred.<a name="line.51"></a> -<span class="sourceLineNo">052</span> * 4. The "identity" content-coding is always acceptable, unless<a name="line.52"></a> -<span class="sourceLineNo">053</span> * specifically refused because the Accept-Encoding field includes<a name="line.53"></a> -<span class="sourceLineNo">054</span> * "identity;q=0", or because the field includes "*;q=0" and does<a name="line.54"></a> -<span class="sourceLineNo">055</span> * not explicitly include the "identity" content-coding. If the<a name="line.55"></a> -<span class="sourceLineNo">056</span> * Accept-Encoding field-value is empty, then only the "identity"<a name="line.56"></a> -<span class="sourceLineNo">057</span> * encoding is acceptable.<a name="line.57"></a> -<span class="sourceLineNo">058</span> *<a name="line.58"></a> -<span class="sourceLineNo">059</span> * If an Accept-Encoding field is present in a request, and if the server cannot<a name="line.59"></a> -<span class="sourceLineNo">060</span> * send a response which is acceptable according to the Accept-Encoding header,<a name="line.60"></a> -<span class="sourceLineNo">061</span> * then the server SHOULD send an error response with the 406 (Not Acceptable) status code.<a name="line.61"></a> -<span class="sourceLineNo">062</span> *<a name="line.62"></a> -<span class="sourceLineNo">063</span> * If no Accept-Encoding field is present in a request, the server MAY assume<a name="line.63"></a> -<span class="sourceLineNo">064</span> * that the client will accept any content coding. In this case, if "identity"<a name="line.64"></a> -<span class="sourceLineNo">065</span> * is one of the available content-codings, then the server SHOULD use the "identity"<a name="line.65"></a> -<span class="sourceLineNo">066</span> * content-coding, unless it has additional information that a different content-coding<a name="line.66"></a> -<span class="sourceLineNo">067</span> * is meaningful to the client.<a name="line.67"></a> -<span class="sourceLineNo">068</span> *<a name="line.68"></a> -<span class="sourceLineNo">069</span> * Note: If the request does not include an Accept-Encoding field,<a name="line.69"></a> -<span class="sourceLineNo">070</span> * and if the "identity" content-coding is unavailable, then<a name="line.70"></a> -<span class="sourceLineNo">071</span> * content-codings commonly understood by HTTP/1.0 clients (i.e.,<a name="line.71"></a> -<span class="sourceLineNo">072</span> * "gzip" and "compress") are preferred; some older clients<a name="line.72"></a> -<span class="sourceLineNo">073</span> * improperly display messages sent with other content-codings. The<a name="line.73"></a> -<span class="sourceLineNo">074</span> * server might also make this decision based on information about<a name="line.74"></a> -<span class="sourceLineNo">075</span> * the particular user-agent or client.<a name="line.75"></a> -<span class="sourceLineNo">076</span> * Note: Most HTTP/1.0 applications do not recognize or obey qvalues<a name="line.76"></a> -<span class="sourceLineNo">077</span> * associated with content-codings. This means that qvalues will not<a name="line.77"></a> -<span class="sourceLineNo">078</span> * work and are not permitted with x-gzip or x-compress.<a name="line.78"></a> -<span class="sourceLineNo">079</span> * </p><a name="line.79"></a> -<span class="sourceLineNo">080</span> */<a name="line.80"></a> -<span class="sourceLineNo">081</span>public final class AcceptEncoding {<a name="line.81"></a> -<span class="sourceLineNo">082</span><a name="line.82"></a> -<span class="sourceLineNo">083</span> private static final boolean nocache = Boolean.getBoolean("juneau.http.AcceptEncoding.nocache");<a name="line.83"></a> -<span class="sourceLineNo">084</span> private static final ConcurrentHashMap<String,AcceptEncoding> cache = new ConcurrentHashMap<String,AcceptEncoding>();<a name="line.84"></a> -<span class="sourceLineNo">085</span><a name="line.85"></a> -<span class="sourceLineNo">086</span> private final TypeRange[] typeRanges;<a name="line.86"></a> -<span class="sourceLineNo">087</span> private final List<TypeRange> typeRangesList;<a name="line.87"></a> -<span class="sourceLineNo">088</span><a name="line.88"></a> -<span class="sourceLineNo">089</span> /**<a name="line.89"></a> -<span class="sourceLineNo">090</span> * Returns a parsed <code>Accept-Encoding</code> header.<a name="line.90"></a> -<span class="sourceLineNo">091</span> *<a name="line.91"></a> -<span class="sourceLineNo">092</span> * @param s The <code>Accept-Encoding</code> header string.<a name="line.92"></a> -<span class="sourceLineNo">093</span> * @return The parsed <code>Accept-Encoding</code> header, or <jk>null</jk> if the string was null.<a name="line.93"></a> -<span class="sourceLineNo">094</span> */<a name="line.94"></a> -<span class="sourceLineNo">095</span> public static AcceptEncoding forString(String s) {<a name="line.95"></a> -<span class="sourceLineNo">096</span> if (s == null)<a name="line.96"></a> -<span class="sourceLineNo">097</span> return null;<a name="line.97"></a> +<span class="sourceLineNo">015</span>import static org.apache.juneau.http.Constants.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span><a name="line.16"></a> +<span class="sourceLineNo">017</span>import org.apache.juneau.internal.*;<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>Accept-Encoding</l> HTTP request header.<a name="line.20"></a> +<span class="sourceLineNo">021</span> * <p><a name="line.21"></a> +<span class="sourceLineNo">022</span> * List of acceptable encodings.<a name="line.22"></a> +<span class="sourceLineNo">023</span> *<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <h6 class='figure'>Example</h6><a name="line.24"></a> +<span class="sourceLineNo">025</span> * <p class='bcode'><a name="line.25"></a> +<span class="sourceLineNo">026</span> * Accept-Encoding: gzip, deflate<a name="line.26"></a> +<span class="sourceLineNo">027</span> * </p><a name="line.27"></a> +<span class="sourceLineNo">028</span> *<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <h6 class='topic'>RFC2616 Specification</h6><a name="line.29"></a> +<span class="sourceLineNo">030</span> *<a name="line.30"></a> +<span class="sourceLineNo">031</span> * The Accept-Encoding request-header field is similar to Accept, but restricts the content-codings (section 3.5) that are acceptable in the response.<a name="line.31"></a> +<span class="sourceLineNo">032</span> *<a name="line.32"></a> +<span class="sourceLineNo">033</span> * <p class='bcode'><a name="line.33"></a> +<span class="sourceLineNo">034</span> * Accept-Encoding = "Accept-Encoding" ":"<a name="line.34"></a> +<span class="sourceLineNo">035</span> * 1#( codings [ ";" "q" "=" qvalue ] )<a name="line.35"></a> +<span class="sourceLineNo">036</span> * codings = ( content-coding | "*" )<a name="line.36"></a> +<span class="sourceLineNo">037</span> * </p><a name="line.37"></a> +<span class="sourceLineNo">038</span> * <p><a name="line.38"></a> +<span class="sourceLineNo">039</span> * Examples of its use are:<a name="line.39"></a> +<span class="sourceLineNo">040</span> * <p class='bcode'><a name="line.40"></a> +<span class="sourceLineNo">041</span> * Accept-Encoding: compress, gzip<a name="line.41"></a> +<span class="sourceLineNo">042</span> * Accept-Encoding:<a name="line.42"></a> +<span class="sourceLineNo">043</span> * Accept-Encoding: *<a name="line.43"></a> +<span class="sourceLineNo">044</span> * Accept-Encoding: compress;q=0.5, gzip;q=1.0<a name="line.44"></a> +<span class="sourceLineNo">045</span> * Accept-Encoding: gzip;q=1.0, identity; q=0.5, *;q=0<a name="line.45"></a> +<span class="sourceLineNo">046</span> * </p><a name="line.46"></a> +<span class="sourceLineNo">047</span> * <p><a name="line.47"></a> +<span class="sourceLineNo">048</span> * A server tests whether a content-coding is acceptable, according to an Accept-Encoding field, using these rules:<a name="line.48"></a> +<span class="sourceLineNo">049</span> * <ol><a name="line.49"></a> +<span class="sourceLineNo">050</span> * <li>If the content-coding is one of the content-codings listed in the Accept-Encoding field, then it is<a name="line.50"></a> +<span class="sourceLineNo">051</span> * acceptable, unless it is accompanied by a qvalue of 0.<a name="line.51"></a> +<span class="sourceLineNo">052</span> * (As defined in section 3.9, a qvalue of 0 means "not acceptable.")<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <li>The special "*" symbol in an Accept-Encoding field matches any available content-coding not explicitly listed<a name="line.53"></a> +<span class="sourceLineNo">054</span> * in the header field.<a name="line.54"></a> +<span class="sourceLineNo">055</span> * <li>If multiple content-codings are acceptable, then the acceptable content-coding with the highest non-zero<a name="line.55"></a> +<span class="sourceLineNo">056</span> * qvalue is preferred.<a name="line.56"></a> +<span class="sourceLineNo">057</span> * <li>The "identity" content-coding is always acceptable, unless specifically refused because the Accept-Encoding<a name="line.57"></a> +<span class="sourceLineNo">058</span> * field includes "identity;q=0", or because the field includes "*;q=0" and does not explicitly include the<a name="line.58"></a> +<span class="sourceLineNo">059</span> * "identity" content-coding.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * If the Accept-Encoding field-value is empty, then only the "identity" encoding is acceptable.<a name="line.60"></a> +<span class="sourceLineNo">061</span> * </ol><a name="line.61"></a> +<span class="sourceLineNo">062</span> * <p><a name="line.62"></a> +<span class="sourceLineNo">063</span> * If an Accept-Encoding field is present in a request, and if the server cannot send a response which is acceptable<a name="line.63"></a> +<span class="sourceLineNo">064</span> * according to the Accept-Encoding header, then the server SHOULD send an error response with the 406 (Not Acceptable)<a name="line.64"></a> +<span class="sourceLineNo">065</span> * status code.<a name="line.65"></a> +<span class="sourceLineNo">066</span> * <p><a name="line.66"></a> +<span class="sourceLineNo">067</span> * If no Accept-Encoding field is present in a request, the server MAY assume that the client will accept any content<a name="line.67"></a> +<span class="sourceLineNo">068</span> * coding.<a name="line.68"></a> +<span class="sourceLineNo">069</span> * In this case, if "identity" is one of the available content-codings, then the server SHOULD use the "identity"<a name="line.69"></a> +<span class="sourceLineNo">070</span> * content-coding, unless it has additional information that a different content-coding is meaningful to the client.<a name="line.70"></a> +<span class="sourceLineNo">071</span> * <p><a name="line.71"></a> +<span class="sourceLineNo">072</span> * Note: If the request does not include an Accept-Encoding field, and if the "identity" content-coding is unavailable,<a name="line.72"></a> +<span class="sourceLineNo">073</span> * then content-codings commonly understood by HTTP/1.0 clients (i.e.,"gzip" and "compress") are preferred; some older<a name="line.73"></a> +<span class="sourceLineNo">074</span> * clients improperly display messages sent with other content-codings.<a name="line.74"></a> +<span class="sourceLineNo">075</span> * The server might also make this decision based on information about the particular user-agent or client.<a name="line.75"></a> +<span class="sourceLineNo">076</span> * <p><a name="line.76"></a> +<span class="sourceLineNo">077</span> * Note: Most HTTP/1.0 applications do not recognize or obey qvalues associated with content-codings.<a name="line.77"></a> +<span class="sourceLineNo">078</span> * This means that qvalues will not work and are not permitted with x-gzip or x-compress.<a name="line.78"></a> +<span class="sourceLineNo">079</span> */<a name="line.79"></a> +<span class="sourceLineNo">080</span>public final class AcceptEncoding extends HeaderRangeArray {<a name="line.80"></a> +<span class="sourceLineNo">081</span><a name="line.81"></a> +<span class="sourceLineNo">082</span> private static final Cache<String,AcceptEncoding> cache = new Cache<String,AcceptEncoding>(NOCACHE, CACHE_MAX_SIZE);<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> * Returns a parsed <code>Accept-Encoding</code> header.<a name="line.85"></a> +<span class="sourceLineNo">086</span> *<a name="line.86"></a> +<span class="sourceLineNo">087</span> * @param value The <code>Accept-Encoding</code> header string.<a name="line.87"></a> +<span class="sourceLineNo">088</span> * @return The parsed <code>Accept-Encoding</code> header, or <jk>null</jk> if the string was null.<a name="line.88"></a> +<span class="sourceLineNo">089</span> */<a name="line.89"></a> +<span class="sourceLineNo">090</span> public static AcceptEncoding forString(String value) {<a name="line.90"></a> +<span class="sourceLineNo">091</span> if (value == null)<a name="line.91"></a> +<span class="sourceLineNo">092</span> return null;<a name="line.92"></a> +<span class="sourceLineNo">093</span> AcceptEncoding a = cache.get(value);<a name="line.93"></a> +<span class="sourceLineNo">094</span> if (a == null)<a name="line.94"></a> +<span class="sourceLineNo">095</span> a = cache.put(value, new AcceptEncoding(value));<a name="line.95"></a> +<span class="sourceLineNo">096</span> return a;<a name="line.96"></a> +<span class="sourceLineNo">097</span> }<a name="line.97"></a> <span class="sourceLineNo">098</span><a name="line.98"></a> -<span class="sourceLineNo">099</span> // Prevent OOM in case of DDOS<a name="line.99"></a> -<span class="sourceLineNo">100</span> if (cache.size() > 1000)<a name="line.100"></a> -<span class="sourceLineNo">101</span> cache.clear();<a name="line.101"></a> -<span class="sourceLineNo">102</span><a name="line.102"></a> -<span class="sourceLineNo">103</span> while (true) {<a name="line.103"></a> -<span class="sourceLineNo">104</span> AcceptEncoding a = cache.get(s);<a name="line.104"></a> -<span class="sourceLineNo">105</span> if (a != null)<a name="line.105"></a> -<span class="sourceLineNo">106</span> return a;<a name="line.106"></a> -<span class="sourceLineNo">107</span> a = new AcceptEncoding(s);<a name="line.107"></a> -<span class="sourceLineNo">108</span> if (nocache)<a name="line.108"></a> -<span class="sourceLineNo">109</span> return a;<a name="line.109"></a> -<span class="sourceLineNo">110</span> cache.putIfAbsent(s, a);<a name="line.110"></a> -<span class="sourceLineNo">111</span> }<a name="line.111"></a> -<span class="sourceLineNo">112</span> }<a name="line.112"></a> -<span class="sourceLineNo">113</span><a name="line.113"></a> -<span class="sourceLineNo">114</span> private AcceptEncoding(String raw) {<a name="line.114"></a> -<span class="sourceLineNo">115</span> this.typeRanges = TypeRange.parse(raw);<a name="line.115"></a> -<span class="sourceLineNo">116</span> this.typeRangesList = Collections.unmodifiableList(Arrays.asList(typeRanges));<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> * Returns the list of the types ranges that make up this header.<a name="line.120"></a> -<span class="sourceLineNo">121</span> * <p><a name="line.121"></a> -<span class="sourceLineNo">122</span> * The types ranges in the list are sorted by their q-value in descending order.<a name="line.122"></a> -<span class="sourceLineNo">123</span> *<a name="line.123"></a> -<span class="sourceLineNo">124</span> * @return An unmodifiable list of type ranges.<a name="line.124"></a> -<span class="sourceLineNo">125</span> */<a name="line.125"></a> -<span class="sourceLineNo">126</span> public List<TypeRange> getTypeRanges() {<a name="line.126"></a> -<span class="sourceLineNo">127</span> return typeRangesList;<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> * Given a list of content codings, returns the best match for this <code>Accept-Encoding</code> header.<a name="line.131"></a> -<span class="sourceLineNo">132</span> * <p><a name="line.132"></a> -<span class="sourceLineNo">133</span> *<a name="line.133"></a> -<span class="sourceLineNo">134</span> * @param contentCodings The codings to match against.<a name="line.134"></a> -<span class="sourceLineNo">135</span> * @return The index into the array of the best match, or <code>-1</code> if no suitable matches could be found.<a name="line.135"></a> -<span class="sourceLineNo">136</span> */<a name="line.136"></a> -<span class="sourceLineNo">137</span> public int findMatch(String[] contentCodings) {<a name="line.137"></a> -<span class="sourceLineNo">138</span><a name="line.138"></a> -<span class="sourceLineNo">139</span> // Type ranges are ordered by 'q'.<a name="line.139"></a> -<span class="sourceLineNo">140</span> // So we only need to search until we've found a match.<a name="line.140"></a> -<span class="sourceLineNo">141</span> for (TypeRange mr : typeRanges)<a name="line.141"></a> -<span class="sourceLineNo">142</span> for (int i = 0; i < contentCodings.length; i++)<a name="line.142"></a> -<span class="sourceLineNo">143</span> if (mr.matches(contentCodings[i]))<a name="line.143"></a> -<span class="sourceLineNo">144</span> return i;<a name="line.144"></a> -<span class="sourceLineNo">145</span><a name="line.145"></a> -<span class="sourceLineNo">146</span> return -1;<a name="line.146"></a> -<span class="sourceLineNo">147</span> }<a name="line.147"></a> -<span class="sourceLineNo">148</span><a name="line.148"></a> -<span class="sourceLineNo">149</span> @Override /* Object */<a name="line.149"></a> -<span class="sourceLineNo">150</span> public String toString() {<a name="line.150"></a> -<span class="sourceLineNo">151</span> return StringUtils.join(typeRanges, ',');<a name="line.151"></a> -<span class="sourceLineNo">152</span> }<a name="line.152"></a> -<span class="sourceLineNo">153</span>}<a name="line.153"></a> +<span class="sourceLineNo">099</span> private AcceptEncoding(String value) {<a name="line.99"></a> +<span class="sourceLineNo">100</span> super(value);<a name="line.100"></a> +<span class="sourceLineNo">101</span> }<a name="line.101"></a> +<span class="sourceLineNo">102</span>}<a name="line.102"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/src-html/org/apache/juneau/http/AcceptLanguage.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/http/AcceptLanguage.html b/content/site/apidocs/src-html/org/apache/juneau/http/AcceptLanguage.html new file mode 100644 index 0000000..af8dd66 --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/http/AcceptLanguage.html @@ -0,0 +1,182 @@ +<!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;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>import static org.apache.juneau.http.Constants.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span><a name="line.16"></a> +<span class="sourceLineNo">017</span>import org.apache.juneau.internal.*;<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>Accept-Language</l> HTTP request header.<a name="line.20"></a> +<span class="sourceLineNo">021</span> * <p><a name="line.21"></a> +<span class="sourceLineNo">022</span> * List of acceptable human languages for response.<a name="line.22"></a> +<span class="sourceLineNo">023</span> *<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <h6 class='figure'>Example</h6><a name="line.24"></a> +<span class="sourceLineNo">025</span> * <p class='bcode'><a name="line.25"></a> +<span class="sourceLineNo">026</span> * Accept-Language: en-US<a name="line.26"></a> +<span class="sourceLineNo">027</span> * </p><a name="line.27"></a> +<span class="sourceLineNo">028</span> *<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <h6 class='topic'>RFC2616 Specification</h6><a name="line.29"></a> +<span class="sourceLineNo">030</span> *<a name="line.30"></a> +<span class="sourceLineNo">031</span> * The Accept-Language request-header field is similar to Accept, but restricts the set of natural languages that are<a name="line.31"></a> +<span class="sourceLineNo">032</span> * preferred as a response to the request.<a name="line.32"></a> +<span class="sourceLineNo">033</span> * Language tags are defined in section 3.10.<a name="line.33"></a> +<span class="sourceLineNo">034</span> *<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <p class='bcode'><a name="line.35"></a> +<span class="sourceLineNo">036</span> * Accept-Language = "Accept-Language" ":"<a name="line.36"></a> +<span class="sourceLineNo">037</span> * 1#( language-range [ ";" "q" "=" qvalue ] )<a name="line.37"></a> +<span class="sourceLineNo">038</span> * language-range = ( ( 1*8ALPHA *( "-" 1*8ALPHA ) ) | "*" )<a name="line.38"></a> +<span class="sourceLineNo">039</span> * </p><a name="line.39"></a> +<span class="sourceLineNo">040</span> * <p><a name="line.40"></a> +<span class="sourceLineNo">041</span> * Each language-range MAY be given an associated quality value which represents an estimate of the user's preference<a name="line.41"></a> +<span class="sourceLineNo">042</span> * for the languages specified by that range.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * The quality value defaults to "q=1".<a name="line.43"></a> +<span class="sourceLineNo">044</span> * For example...<a name="line.44"></a> +<span class="sourceLineNo">045</span> * <p class='bcode'><a name="line.45"></a> +<span class="sourceLineNo">046</span> * Accept-Language: da, en-gb;q=0.8, en;q=0.7<a name="line.46"></a> +<span class="sourceLineNo">047</span> * </p><a name="line.47"></a> +<span class="sourceLineNo">048</span> * <p><a name="line.48"></a> +<span class="sourceLineNo">049</span> * ...would mean: "I prefer Danish, but will accept British English and other types of English."<a name="line.49"></a> +<span class="sourceLineNo">050</span> * <p><a name="line.50"></a> +<span class="sourceLineNo">051</span> * A language-range matches a language-tag if it exactly equals the tag, or if it exactly equals a prefix of the tag<a name="line.51"></a> +<span class="sourceLineNo">052</span> * such that the first tag character following the prefix is "-".<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <p><a name="line.53"></a> +<span class="sourceLineNo">054</span> * The special range "*", if present in the Accept-Language field, matches every tag not matched by any other range<a name="line.54"></a> +<span class="sourceLineNo">055</span> * present in the Accept-Language field.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <p><a name="line.56"></a> +<span class="sourceLineNo">057</span> * Note: This use of a prefix matching rule does not imply that language tags are assigned to languages in such a way<a name="line.57"></a> +<span class="sourceLineNo">058</span> * that it is always true that if a user understands a language with a certain<a name="line.58"></a> +<span class="sourceLineNo">059</span> * tag, then this user will also understand all languages with tags for which this tag is a prefix.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * The prefix rule simply allows the use of prefix tags if this is the case.<a name="line.60"></a> +<span class="sourceLineNo">061</span> * <p><a name="line.61"></a> +<span class="sourceLineNo">062</span> * The language quality factor assigned to a language-tag by the Accept-Language field is the quality value of the<a name="line.62"></a> +<span class="sourceLineNo">063</span> * longest language- range in the field that matches the language-tag.<a name="line.63"></a> +<span class="sourceLineNo">064</span> * <p><a name="line.64"></a> +<span class="sourceLineNo">065</span> * If no language- range in the field matches the tag, the language quality factor assigned is 0.<a name="line.65"></a> +<span class="sourceLineNo">066</span> * <p><a name="line.66"></a> +<span class="sourceLineNo">067</span> * If no Accept-Language header is present in the request, the server SHOULD assume that all languages are equally<a name="line.67"></a> +<span class="sourceLineNo">068</span> * acceptable.<a name="line.68"></a> +<span class="sourceLineNo">069</span> * <p><a name="line.69"></a> +<span class="sourceLineNo">070</span> * If an Accept-Language header is present, then all languages which are assigned a quality factor greater than 0 are<a name="line.70"></a> +<span class="sourceLineNo">071</span> * acceptable.<a name="line.71"></a> +<span class="sourceLineNo">072</span> * <p><a name="line.72"></a> +<span class="sourceLineNo">073</span> * It might be contrary to the privacy expectations of the user to send an Accept-Language header with the complete<a name="line.73"></a> +<span class="sourceLineNo">074</span> * linguistic preferences of the user in every request.<a name="line.74"></a> +<span class="sourceLineNo">075</span> * For a discussion of this issue, see section 15.1.4.<a name="line.75"></a> +<span class="sourceLineNo">076</span> * <p><a name="line.76"></a> +<span class="sourceLineNo">077</span> * As intelligibility is highly dependent on the individual user, it is recommended that client applications make the<a name="line.77"></a> +<span class="sourceLineNo">078</span> * choice of linguistic preference available to the user.<a name="line.78"></a> +<span class="sourceLineNo">079</span> * If the choice is not made available, then the Accept-Language header field MUST NOT be given in the request.<a name="line.79"></a> +<span class="sourceLineNo">080</span> * <p><a name="line.80"></a> +<span class="sourceLineNo">081</span> * Note: When making the choice of linguistic preference available to the user, we remind implementors of the fact that<a name="line.81"></a> +<span class="sourceLineNo">082</span> * users are not familiar with the details of language matching as described above, and should provide appropriate<a name="line.82"></a> +<span class="sourceLineNo">083</span> * guidance.<a name="line.83"></a> +<span class="sourceLineNo">084</span> * As an example, users might assume that on selecting "en-gb", they will be served any kind of English document if<a name="line.84"></a> +<span class="sourceLineNo">085</span> * British English is not available.<a name="line.85"></a> +<span class="sourceLineNo">086</span> * A user agent might suggest in such a case to add "en" to get the best matching behavior.<a name="line.86"></a> +<span class="sourceLineNo">087</span> */<a name="line.87"></a> +<span class="sourceLineNo">088</span>public final class AcceptLanguage extends HeaderRangeArray {<a name="line.88"></a> +<span class="sourceLineNo">089</span><a name="line.89"></a> +<span class="sourceLineNo">090</span> private static final Cache<String,AcceptLanguage> cache = new Cache<String,AcceptLanguage>(NOCACHE, CACHE_MAX_SIZE);<a name="line.90"></a> +<span class="sourceLineNo">091</span><a name="line.91"></a> +<span class="sourceLineNo">092</span> /**<a name="line.92"></a> +<span class="sourceLineNo">093</span> * Returns a parsed <code>Accept-Language</code> header.<a name="line.93"></a> +<span class="sourceLineNo">094</span> *<a name="line.94"></a> +<span class="sourceLineNo">095</span> * @param value The <code>Accept-Language</code> header string.<a name="line.95"></a> +<span class="sourceLineNo">096</span> * @return The parsed <code>Accept-Language</code> header, or <jk>null</jk> if the string was null.<a name="line.96"></a> +<span class="sourceLineNo">097</span> */<a name="line.97"></a> +<span class="sourceLineNo">098</span> public static AcceptLanguage forString(String value) {<a name="line.98"></a> +<span class="sourceLineNo">099</span> if (value == null)<a name="line.99"></a> +<span class="sourceLineNo">100</span> return null;<a name="line.100"></a> +<span class="sourceLineNo">101</span> AcceptLanguage a = cache.get(value);<a name="line.101"></a> +<span class="sourceLineNo">102</span> if (a == null)<a name="line.102"></a> +<span class="sourceLineNo">103</span> a = cache.put(value, new AcceptLanguage(value));<a name="line.103"></a> +<span class="sourceLineNo">104</span> return a;<a name="line.104"></a> +<span class="sourceLineNo">105</span> }<a name="line.105"></a> +<span class="sourceLineNo">106</span><a name="line.106"></a> +<span class="sourceLineNo">107</span> private AcceptLanguage(String raw) {<a name="line.107"></a> +<span class="sourceLineNo">108</span> super(raw);<a name="line.108"></a> +<span class="sourceLineNo">109</span> }<a name="line.109"></a> +<span class="sourceLineNo">110</span>}<a name="line.110"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/src-html/org/apache/juneau/http/AcceptRanges.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/http/AcceptRanges.html b/content/site/apidocs/src-html/org/apache/juneau/http/AcceptRanges.html new file mode 100644 index 0000000..14e002d --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/http/AcceptRanges.html @@ -0,0 +1,141 @@ +<!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;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>/**<a name="line.15"></a> +<span class="sourceLineNo">016</span> * Represents a parsed <l>Accept-Range</l> HTTP response header.<a name="line.16"></a> +<span class="sourceLineNo">017</span> * <p><a name="line.17"></a> +<span class="sourceLineNo">018</span> * What partial content range types this server supports via byte serving.<a name="line.18"></a> +<span class="sourceLineNo">019</span> *<a name="line.19"></a> +<span class="sourceLineNo">020</span> * <h6 class='figure'>Example</h6><a name="line.20"></a> +<span class="sourceLineNo">021</span> * <p class='bcode'><a name="line.21"></a> +<span class="sourceLineNo">022</span> * Accept-Ranges: bytes<a name="line.22"></a> +<span class="sourceLineNo">023</span> * </p><a name="line.23"></a> +<span class="sourceLineNo">024</span> *<a name="line.24"></a> +<span class="sourceLineNo">025</span> * <h6 class='topic'>RFC2616 Specification</h6><a name="line.25"></a> +<span class="sourceLineNo">026</span> *<a name="line.26"></a> +<span class="sourceLineNo">027</span> * The Accept-Ranges response-header field allows the server to indicate its acceptance of range requests for a<a name="line.27"></a> +<span class="sourceLineNo">028</span> * resource:<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <p class='bcode'><a name="line.29"></a> +<span class="sourceLineNo">030</span> * Accept-Ranges = "Accept-Ranges" ":" acceptable-ranges<a name="line.30"></a> +<span class="sourceLineNo">031</span> * acceptable-ranges = 1#range-unit | "none"<a name="line.31"></a> +<span class="sourceLineNo">032</span> * </p><a name="line.32"></a> +<span class="sourceLineNo">033</span> * <p><a name="line.33"></a> +<span class="sourceLineNo">034</span> * Origin servers that accept byte-range requests MAY send...<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <p class='bcode'><a name="line.35"></a> +<span class="sourceLineNo">036</span> * Accept-Ranges: bytes<a name="line.36"></a> +<span class="sourceLineNo">037</span> * </p><a name="line.37"></a> +<span class="sourceLineNo">038</span> * <p><a name="line.38"></a> +<span class="sourceLineNo">039</span> * ...but are not required to do so.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * <p><a name="line.40"></a> +<span class="sourceLineNo">041</span> * Clients MAY generate byte-range requests without having received this header for the resource involved.<a name="line.41"></a> +<span class="sourceLineNo">042</span> * <p><a name="line.42"></a> +<span class="sourceLineNo">043</span> * Range units are defined in section 3.12.<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <p><a name="line.44"></a> +<span class="sourceLineNo">045</span> * Servers that do not accept any kind of range request for a resource MAY send...<a name="line.45"></a> +<span class="sourceLineNo">046</span> * <p class='bcode'><a name="line.46"></a> +<span class="sourceLineNo">047</span> * Accept-Ranges: none<a name="line.47"></a> +<span class="sourceLineNo">048</span> * </p><a name="line.48"></a> +<span class="sourceLineNo">049</span> * <p><a name="line.49"></a> +<span class="sourceLineNo">050</span> * ...to advise the client not to attempt a range request.<a name="line.50"></a> +<span class="sourceLineNo">051</span> */<a name="line.51"></a> +<span class="sourceLineNo">052</span>public final class AcceptRanges extends HeaderString {<a name="line.52"></a> +<span class="sourceLineNo">053</span><a name="line.53"></a> +<span class="sourceLineNo">054</span> /**<a name="line.54"></a> +<span class="sourceLineNo">055</span> * Returns a parsed <code>Accept-Ranges</code> header.<a name="line.55"></a> +<span class="sourceLineNo">056</span> *<a name="line.56"></a> +<span class="sourceLineNo">057</span> * @param value The <code>Accept-Ranges</code> header string.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @return The parsed <code>Accept-Ranges</code> header, or <jk>null</jk> if the string was null.<a name="line.58"></a> +<span class="sourceLineNo">059</span> */<a name="line.59"></a> +<span class="sourceLineNo">060</span> public static AcceptRanges forString(String value) {<a name="line.60"></a> +<span class="sourceLineNo">061</span> if (value == null)<a name="line.61"></a> +<span class="sourceLineNo">062</span> return null;<a name="line.62"></a> +<span class="sourceLineNo">063</span> return new AcceptRanges(value);<a name="line.63"></a> +<span class="sourceLineNo">064</span> }<a name="line.64"></a> +<span class="sourceLineNo">065</span><a name="line.65"></a> +<span class="sourceLineNo">066</span> private AcceptRanges(String value) {<a name="line.66"></a> +<span class="sourceLineNo">067</span> super(value);<a name="line.67"></a> +<span class="sourceLineNo">068</span> }<a name="line.68"></a> +<span class="sourceLineNo">069</span>}<a name="line.69"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/src-html/org/apache/juneau/http/Age.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/http/Age.html b/content/site/apidocs/src-html/org/apache/juneau/http/Age.html new file mode 100644 index 0000000..9713768 --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/http/Age.html @@ -0,0 +1,136 @@ +<!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;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>/**<a name="line.15"></a> +<span class="sourceLineNo">016</span> * Represents a parsed <l>Age</l> HTTP response header.<a name="line.16"></a> +<span class="sourceLineNo">017</span> * <p><a name="line.17"></a> +<span class="sourceLineNo">018</span> * The age the object has been in a proxy cache in seconds.<a name="line.18"></a> +<span class="sourceLineNo">019</span> *<a name="line.19"></a> +<span class="sourceLineNo">020</span> * <h6 class='figure'>Example</h6><a name="line.20"></a> +<span class="sourceLineNo">021</span> * <p class='bcode'><a name="line.21"></a> +<span class="sourceLineNo">022</span> * Age: 12<a name="line.22"></a> +<span class="sourceLineNo">023</span> * </p><a name="line.23"></a> +<span class="sourceLineNo">024</span> *<a name="line.24"></a> +<span class="sourceLineNo">025</span> * <h6 class='topic'>RFC2616 Specification</h6><a name="line.25"></a> +<span class="sourceLineNo">026</span> *<a name="line.26"></a> +<span class="sourceLineNo">027</span> * The Age response-header field conveys the sender's estimate of the amount of time since the response (or its<a name="line.27"></a> +<span class="sourceLineNo">028</span> * revalidation) was generated at the origin server.<a name="line.28"></a> +<span class="sourceLineNo">029</span> * A cached response is "fresh" if its age does not exceed its freshness lifetime.<a name="line.29"></a> +<span class="sourceLineNo">030</span> * Age values are calculated as specified in section 13.2.3.<a name="line.30"></a> +<span class="sourceLineNo">031</span> *<a name="line.31"></a> +<span class="sourceLineNo">032</span> * <p class='bcode'><a name="line.32"></a> +<span class="sourceLineNo">033</span> * Age = "Age" ":" age-value<a name="line.33"></a> +<span class="sourceLineNo">034</span> * age-value = delta-seconds<a name="line.34"></a> +<span class="sourceLineNo">035</span> * </p><a name="line.35"></a> +<span class="sourceLineNo">036</span> * <p><a name="line.36"></a> +<span class="sourceLineNo">037</span> * Age values are non-negative decimal integers, representing time in seconds.<a name="line.37"></a> +<span class="sourceLineNo">038</span> * <p><a name="line.38"></a> +<span class="sourceLineNo">039</span> * If a cache receives a value larger than the largest positive integer it can represent, or if any of its age<a name="line.39"></a> +<span class="sourceLineNo">040</span> * calculations overflows, it MUST transmit an Age header with a value of 2147483648 (2^31).<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <p><a name="line.41"></a> +<span class="sourceLineNo">042</span> * An HTTP/1.1 server that includes a cache MUST include an Age header field in every response generated from its own<a name="line.42"></a> +<span class="sourceLineNo">043</span> * cache.<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <p><a name="line.44"></a> +<span class="sourceLineNo">045</span> * Caches SHOULD use an arithmetic type of at least 31 bits of range.<a name="line.45"></a> +<span class="sourceLineNo">046</span> */<a name="line.46"></a> +<span class="sourceLineNo">047</span>public final class Age extends HeaderInteger {<a name="line.47"></a> +<span class="sourceLineNo">048</span><a name="line.48"></a> +<span class="sourceLineNo">049</span> /**<a name="line.49"></a> +<span class="sourceLineNo">050</span> * Returns a parsed <code>Age</code> header.<a name="line.50"></a> +<span class="sourceLineNo">051</span> *<a name="line.51"></a> +<span class="sourceLineNo">052</span> * @param value The <code>Age</code> header string.<a name="line.52"></a> +<span class="sourceLineNo">053</span> * @return The parsed <code>Age</code> header, or <jk>null</jk> if the string was null.<a name="line.53"></a> +<span class="sourceLineNo">054</span> */<a name="line.54"></a> +<span class="sourceLineNo">055</span> public static Age forString(String value) {<a name="line.55"></a> +<span class="sourceLineNo">056</span> if (value == null)<a name="line.56"></a> +<span class="sourceLineNo">057</span> return null;<a name="line.57"></a> +<span class="sourceLineNo">058</span> return new Age(value);<a name="line.58"></a> +<span class="sourceLineNo">059</span> }<a name="line.59"></a> +<span class="sourceLineNo">060</span><a name="line.60"></a> +<span class="sourceLineNo">061</span> private Age(String value) {<a name="line.61"></a> +<span class="sourceLineNo">062</span> super(value);<a name="line.62"></a> +<span class="sourceLineNo">063</span> }<a name="line.63"></a> +<span class="sourceLineNo">064</span>}<a name="line.64"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/src-html/org/apache/juneau/http/Allow.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/http/Allow.html b/content/site/apidocs/src-html/org/apache/juneau/http/Allow.html new file mode 100644 index 0000000..93d8041 --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/http/Allow.html @@ -0,0 +1,144 @@ +<!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;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>/**<a name="line.15"></a> +<span class="sourceLineNo">016</span> * Represents a parsed <l>Allow</l> HTTP response header.<a name="line.16"></a> +<span class="sourceLineNo">017</span> * <p><a name="line.17"></a> +<span class="sourceLineNo">018</span> * Valid methods for a specified resource. To be used for a 405 Method not allowed.<a name="line.18"></a> +<span class="sourceLineNo">019</span> *<a name="line.19"></a> +<span class="sourceLineNo">020</span> * <h6 class='figure'>Example</h6><a name="line.20"></a> +<span class="sourceLineNo">021</span> * <p class='bcode'><a name="line.21"></a> +<span class="sourceLineNo">022</span> * Allow: GET, HEAD<a name="line.22"></a> +<span class="sourceLineNo">023</span> * </p><a name="line.23"></a> +<span class="sourceLineNo">024</span> *<a name="line.24"></a> +<span class="sourceLineNo">025</span> * <h6 class='topic'>RFC2616 Specification</h6><a name="line.25"></a> +<span class="sourceLineNo">026</span> *<a name="line.26"></a> +<span class="sourceLineNo">027</span> * The Allow entity-header field lists the set of methods supported by the resource identified by the Request-URI.<a name="line.27"></a> +<span class="sourceLineNo">028</span> * The purpose of this field is strictly to inform the recipient of valid methods associated with the resource.<a name="line.28"></a> +<span class="sourceLineNo">029</span> * An Allow header field MUST be present in a 405 (Method Not Allowed) response.<a name="line.29"></a> +<span class="sourceLineNo">030</span> *<a name="line.30"></a> +<span class="sourceLineNo">031</span> * <p class='bcode'><a name="line.31"></a> +<span class="sourceLineNo">032</span> * Allow = "Allow" ":" #Method<a name="line.32"></a> +<span class="sourceLineNo">033</span> * </p><a name="line.33"></a> +<span class="sourceLineNo">034</span> * <p><a name="line.34"></a> +<span class="sourceLineNo">035</span> * Example of use:<a name="line.35"></a> +<span class="sourceLineNo">036</span> * <p class='bcode'><a name="line.36"></a> +<span class="sourceLineNo">037</span> * Allow: GET, HEAD, PUT<a name="line.37"></a> +<span class="sourceLineNo">038</span> * </p><a name="line.38"></a> +<span class="sourceLineNo">039</span> * <p><a name="line.39"></a> +<span class="sourceLineNo">040</span> * This field cannot prevent a client from trying other methods.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * However, the indications given by the Allow header field value SHOULD be followed.<a name="line.41"></a> +<span class="sourceLineNo">042</span> * <p><a name="line.42"></a> +<span class="sourceLineNo">043</span> * The actual set of allowed methods is defined by the origin server at the time of each request.<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <p><a name="line.44"></a> +<span class="sourceLineNo">045</span> * The Allow header field MAY be provided with a PUT request to recommend the methods to be supported by the new or<a name="line.45"></a> +<span class="sourceLineNo">046</span> * modified resource.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <p><a name="line.47"></a> +<span class="sourceLineNo">048</span> * The server is not required to support these methods and SHOULD include an Allow header in the response giving the<a name="line.48"></a> +<span class="sourceLineNo">049</span> * actual supported methods.<a name="line.49"></a> +<span class="sourceLineNo">050</span> * <p><a name="line.50"></a> +<span class="sourceLineNo">051</span> * A proxy MUST NOT modify the Allow header field even if it does not understand all the methods specified, since the<a name="line.51"></a> +<span class="sourceLineNo">052</span> * user agent might<a name="line.52"></a> +<span class="sourceLineNo">053</span> * have other means of communicating with the origin server.<a name="line.53"></a> +<span class="sourceLineNo">054</span> */<a name="line.54"></a> +<span class="sourceLineNo">055</span>public final class Allow extends HeaderStringArray {<a name="line.55"></a> +<span class="sourceLineNo">056</span><a name="line.56"></a> +<span class="sourceLineNo">057</span> /**<a name="line.57"></a> +<span class="sourceLineNo">058</span> * Returns a parsed <code>Allow</code> header.<a name="line.58"></a> +<span class="sourceLineNo">059</span> *<a name="line.59"></a> +<span class="sourceLineNo">060</span> * @param value The <code>Allow</code> header string.<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @return The parsed <code>Allow</code> header, or <jk>null</jk> if the string was null.<a name="line.61"></a> +<span class="sourceLineNo">062</span> */<a name="line.62"></a> +<span class="sourceLineNo">063</span> public static Allow forString(String value) {<a name="line.63"></a> +<span class="sourceLineNo">064</span> if (value == null)<a name="line.64"></a> +<span class="sourceLineNo">065</span> return null;<a name="line.65"></a> +<span class="sourceLineNo">066</span> return new Allow(value);<a name="line.66"></a> +<span class="sourceLineNo">067</span> }<a name="line.67"></a> +<span class="sourceLineNo">068</span><a name="line.68"></a> +<span class="sourceLineNo">069</span> private Allow(String value) {<a name="line.69"></a> +<span class="sourceLineNo">070</span> super(value);<a name="line.70"></a> +<span class="sourceLineNo">071</span> }<a name="line.71"></a> +<span class="sourceLineNo">072</span>}<a name="line.72"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/src-html/org/apache/juneau/http/Authorization.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/http/Authorization.html b/content/site/apidocs/src-html/org/apache/juneau/http/Authorization.html new file mode 100644 index 0000000..446db39 --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/http/Authorization.html @@ -0,0 +1,150 @@ +<!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;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>/**<a name="line.15"></a> +<span class="sourceLineNo">016</span> * Represents a parsed <l>Authorization</l> HTTP request header.<a name="line.16"></a> +<span class="sourceLineNo">017</span> * <p><a name="line.17"></a> +<span class="sourceLineNo">018</span> * Authentication credentials for HTTP authentication.<a name="line.18"></a> +<span class="sourceLineNo">019</span> *<a name="line.19"></a> +<span class="sourceLineNo">020</span> * <h6 class='figure'>Example</h6><a name="line.20"></a> +<span class="sourceLineNo">021</span> * <p class='bcode'><a name="line.21"></a> +<span class="sourceLineNo">022</span> * Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==<a name="line.22"></a> +<span class="sourceLineNo">023</span> * </p><a name="line.23"></a> +<span class="sourceLineNo">024</span> *<a name="line.24"></a> +<span class="sourceLineNo">025</span> * <h6 class='topic'>RFC2616 Specification</h6><a name="line.25"></a> +<span class="sourceLineNo">026</span> *<a name="line.26"></a> +<span class="sourceLineNo">027</span> * A user agent that wishes to authenticate itself with a server--usually, but not necessarily, after receiving a 401<a name="line.27"></a> +<span class="sourceLineNo">028</span> * response--does so by including an Authorization request-header field with the request.<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <p><a name="line.29"></a> +<span class="sourceLineNo">030</span> * The Authorization field value consists of credentials containing the authentication information of the user agent for<a name="line.30"></a> +<span class="sourceLineNo">031</span> * the realm of the resource being requested.<a name="line.31"></a> +<span class="sourceLineNo">032</span> *<a name="line.32"></a> +<span class="sourceLineNo">033</span> * <p class='bcode'><a name="line.33"></a> +<span class="sourceLineNo">034</span> * Authorization = "Authorization" ":" credentials<a name="line.34"></a> +<span class="sourceLineNo">035</span> * </p><a name="line.35"></a> +<span class="sourceLineNo">036</span> * <p><a name="line.36"></a> +<span class="sourceLineNo">037</span> * HTTP access authentication is described in "HTTP Authentication: Basic and Digest Access Authentication".<a name="line.37"></a> +<span class="sourceLineNo">038</span> * <p><a name="line.38"></a> +<span class="sourceLineNo">039</span> * If a request is authenticated and a realm specified, the same credentials SHOULD be valid for all other requests<a name="line.39"></a> +<span class="sourceLineNo">040</span> * within this realm (assuming that the authentication scheme itself does not require otherwise, such as credentials<a name="line.40"></a> +<span class="sourceLineNo">041</span> * that vary according to a challenge value or using synchronized clocks).<a name="line.41"></a> +<span class="sourceLineNo">042</span> * <p><a name="line.42"></a> +<span class="sourceLineNo">043</span> * When a shared cache (see section 13.7) receives a request containing an Authorization field, it MUST NOT return the<a name="line.43"></a> +<span class="sourceLineNo">044</span> * corresponding response as a reply to any other request, unless one of the following specific exceptions holds:<a name="line.44"></a> +<span class="sourceLineNo">045</span> * <ol><a name="line.45"></a> +<span class="sourceLineNo">046</span> * <li>If the response includes the "s-maxage" cache-control directive, the cache MAY use that response in replying<a name="line.46"></a> +<span class="sourceLineNo">047</span> * to a subsequent request.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * But (if the specified maximum age has passed) a proxy cache MUST first revalidate it with the origin<a name="line.48"></a> +<span class="sourceLineNo">049</span> * server, using the request-headers from the new request to allow the origin server to authenticate the new<a name="line.49"></a> +<span class="sourceLineNo">050</span> * request.<a name="line.50"></a> +<span class="sourceLineNo">051</span> * (This is the defined behavior for s-maxage.)<a name="line.51"></a> +<span class="sourceLineNo">052</span> * If the response includes "s-maxage=0", the proxy MUST always revalidate it before re-using it.<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <li>If the response includes the "must-revalidate" cache-control directive, the cache MAY use that response in<a name="line.53"></a> +<span class="sourceLineNo">054</span> * replying to a subsequent request.<a name="line.54"></a> +<span class="sourceLineNo">055</span> * But if the response is stale, all caches MUST first revalidate it with the origin server, using the<a name="line.55"></a> +<span class="sourceLineNo">056</span> * request-headers from the new request to allow the origin server to authenticate the new request.<a name="line.56"></a> +<span class="sourceLineNo">057</span> * <li>If the response includes the "public" cache-control directive, it MAY be returned in reply to any subsequent<a name="line.57"></a> +<span class="sourceLineNo">058</span> * request.<a name="line.58"></a> +<span class="sourceLineNo">059</span> * </ol><a name="line.59"></a> +<span class="sourceLineNo">060</span> */<a name="line.60"></a> +<span class="sourceLineNo">061</span>public final class Authorization extends HeaderString {<a name="line.61"></a> +<span class="sourceLineNo">062</span><a name="line.62"></a> +<span class="sourceLineNo">063</span> /**<a name="line.63"></a> +<span class="sourceLineNo">064</span> * Returns a parsed <code>Authorization</code> header.<a name="line.64"></a> +<span class="sourceLineNo">065</span> *<a name="line.65"></a> +<span class="sourceLineNo">066</span> * @param value The <code>Authorization</code> header string.<a name="line.66"></a> +<span class="sourceLineNo">067</span> * @return The parsed <code>Authorization</code> header, or <jk>null</jk> if the string was null.<a name="line.67"></a> +<span class="sourceLineNo">068</span> */<a name="line.68"></a> +<span class="sourceLineNo">069</span> public static Authorization forString(String value) {<a name="line.69"></a> +<span class="sourceLineNo">070</span> if (value == null)<a name="line.70"></a> +<span class="sourceLineNo">071</span> return null;<a name="line.71"></a> +<span class="sourceLineNo">072</span> return new Authorization(value);<a name="line.72"></a> +<span class="sourceLineNo">073</span> }<a name="line.73"></a> +<span class="sourceLineNo">074</span><a name="line.74"></a> +<span class="sourceLineNo">075</span> private Authorization(String value) {<a name="line.75"></a> +<span class="sourceLineNo">076</span> super(value);<a name="line.76"></a> +<span class="sourceLineNo">077</span> }<a name="line.77"></a> +<span class="sourceLineNo">078</span>}<a name="line.78"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
