http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/f1f17bc3/content/site/apidocs/src-html/org/apache/juneau/http/Server.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/http/Server.html b/content/site/apidocs/src-html/org/apache/juneau/http/Server.html new file mode 100644 index 0000000..1ab49c0 --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/http/Server.html @@ -0,0 +1,137 @@ +<!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>Server</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> * A name for the server.<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> * Server: Apache/2.4.1 (Unix)<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 Server response-header field contains information about the software used by the origin server to handle the<a name="line.27"></a> +<span class="sourceLineNo">028</span> * request.<a name="line.28"></a> +<span class="sourceLineNo">029</span> * The field can contain multiple product tokens (section 3.8) and comments identifying the server and any significant<a name="line.29"></a> +<span class="sourceLineNo">030</span> * subproducts.<a name="line.30"></a> +<span class="sourceLineNo">031</span> * The product tokens are listed in order of their significance for identifying the application.<a name="line.31"></a> +<span class="sourceLineNo">032</span> * <p class='bcode'><a name="line.32"></a> +<span class="sourceLineNo">033</span> * Server = "Server" ":" 1*( product | comment )<a name="line.33"></a> +<span class="sourceLineNo">034</span> * </p><a name="line.34"></a> +<span class="sourceLineNo">035</span> * <p><a name="line.35"></a> +<span class="sourceLineNo">036</span> * Example:<a name="line.36"></a> +<span class="sourceLineNo">037</span> * <p class='bcode'><a name="line.37"></a> +<span class="sourceLineNo">038</span> * Server: CERN/3.0 libwww/2.17<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> * If the response is being forwarded through a proxy, the proxy application MUST NOT modify the Server response-header.<a name="line.41"></a> +<span class="sourceLineNo">042</span> * Instead, it SHOULD include a Via field (as described in section 14.45).<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <p><a name="line.43"></a> +<span class="sourceLineNo">044</span> * Note: Revealing the specific software version of the server might allow the server machine to become more vulnerable<a name="line.44"></a> +<span class="sourceLineNo">045</span> * to attacks against software that is known to contain security holes.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * Server implementors are encouraged to make this field a configurable option.<a name="line.46"></a> +<span class="sourceLineNo">047</span> */<a name="line.47"></a> +<span class="sourceLineNo">048</span>public final class Server extends HeaderString {<a name="line.48"></a> +<span class="sourceLineNo">049</span><a name="line.49"></a> +<span class="sourceLineNo">050</span> /**<a name="line.50"></a> +<span class="sourceLineNo">051</span> * Returns a parsed <code>Server</code> header.<a name="line.51"></a> +<span class="sourceLineNo">052</span> *<a name="line.52"></a> +<span class="sourceLineNo">053</span> * @param value The <code>Server</code> header string.<a name="line.53"></a> +<span class="sourceLineNo">054</span> * @return The parsed <code>Server</code> header, or <jk>null</jk> if the string was null.<a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span> public static Server forString(String value) {<a name="line.56"></a> +<span class="sourceLineNo">057</span> if (value == null)<a name="line.57"></a> +<span class="sourceLineNo">058</span> return null;<a name="line.58"></a> +<span class="sourceLineNo">059</span> return new Server(value);<a name="line.59"></a> +<span class="sourceLineNo">060</span> }<a name="line.60"></a> +<span class="sourceLineNo">061</span><a name="line.61"></a> +<span class="sourceLineNo">062</span> private Server(String value) {<a name="line.62"></a> +<span class="sourceLineNo">063</span> super(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> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</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/SimpleRange.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/http/SimpleRange.html b/content/site/apidocs/src-html/org/apache/juneau/http/SimpleRange.html new file mode 100644 index 0000000..e373356 --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/http/SimpleRange.html @@ -0,0 +1,348 @@ +<!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 java.util.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import java.util.Map.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span><a name="line.17"></a> +<span class="sourceLineNo">018</span>import org.apache.juneau.annotation.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span>import org.apache.juneau.internal.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span><a name="line.20"></a> +<span class="sourceLineNo">021</span>/**<a name="line.21"></a> +<span class="sourceLineNo">022</span> * Represents a single value in a comma-delimited header value that optionally contains a quality<a name="line.22"></a> +<span class="sourceLineNo">023</span> * metric for comparison and extension parameters.<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> +<span class="sourceLineNo">025</span> * Similar in concept to {@link MediaTypeRange} except instead of media types (e.g. <js>"text/json"</js>),<a name="line.25"></a> +<span class="sourceLineNo">026</span> * it's a simple type (e.g. <js>"iso-8601"</js>).<a name="line.26"></a> +<span class="sourceLineNo">027</span> * <p><a name="line.27"></a> +<span class="sourceLineNo">028</span> * An example of a type range is a value in an <code>Accept-Encoding</code> header.<a name="line.28"></a> +<span class="sourceLineNo">029</span> */<a name="line.29"></a> +<span class="sourceLineNo">030</span>@BeanIgnore<a name="line.30"></a> +<span class="sourceLineNo">031</span>public final class SimpleRange implements Comparable<SimpleRange> {<a name="line.31"></a> +<span class="sourceLineNo">032</span><a name="line.32"></a> +<span class="sourceLineNo">033</span> private static final SimpleRange[] DEFAULT = new SimpleRange[]{new SimpleRange("*")};<a name="line.33"></a> +<span class="sourceLineNo">034</span><a name="line.34"></a> +<span class="sourceLineNo">035</span> private final String type;<a name="line.35"></a> +<span class="sourceLineNo">036</span> private final Float qValue;<a name="line.36"></a> +<span class="sourceLineNo">037</span> private final Map<String,Set<String>> extensions;<a name="line.37"></a> +<span class="sourceLineNo">038</span><a name="line.38"></a> +<span class="sourceLineNo">039</span> /**<a name="line.39"></a> +<span class="sourceLineNo">040</span> * Parses a header such as an <code>Accept-Encoding</code> header value into an array of type ranges.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <p><a name="line.41"></a> +<span class="sourceLineNo">042</span> * The syntax expected to be found in the referenced <code>value</code> complies with the syntax described in RFC2616, Section 14.1, as described below:<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <p class='bcode'><a name="line.43"></a> +<span class="sourceLineNo">044</span> * Accept-Encoding = "Accept-Encoding" ":"<a name="line.44"></a> +<span class="sourceLineNo">045</span> * 1#( codings [ ";" "q" "=" qvalue ] )<a name="line.45"></a> +<span class="sourceLineNo">046</span> * codings = ( content-coding | "*" )<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> * Examples of its use are:<a name="line.49"></a> +<span class="sourceLineNo">050</span> * <p class='bcode'><a name="line.50"></a> +<span class="sourceLineNo">051</span> * Accept-Encoding: compress, gzip<a name="line.51"></a> +<span class="sourceLineNo">052</span> * Accept-Encoding:<a name="line.52"></a> +<span class="sourceLineNo">053</span> * Accept-Encoding: *<a name="line.53"></a> +<span class="sourceLineNo">054</span> * Accept-Encoding: compress;q=0.5, gzip;q=1.0<a name="line.54"></a> +<span class="sourceLineNo">055</span> * Accept-Encoding: gzip;q=1.0, identity; q=0.5, *;q=0<a name="line.55"></a> +<span class="sourceLineNo">056</span> * </p><a name="line.56"></a> +<span class="sourceLineNo">057</span> *<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @param value The value to parse. If <jk>null</jk> or empty, returns a single <code>TypeRange</code> is returned that represents all types.<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @return The type ranges described by the string.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * <br>The ranges are sorted such that the most acceptable type is available at ordinal position <js>'0'</js>, and the least acceptable at position n-1.<a name="line.60"></a> +<span class="sourceLineNo">061</span> */<a name="line.61"></a> +<span class="sourceLineNo">062</span> public static SimpleRange[] parse(String value) {<a name="line.62"></a> +<span class="sourceLineNo">063</span><a name="line.63"></a> +<span class="sourceLineNo">064</span> if (value == null || value.length() == 0)<a name="line.64"></a> +<span class="sourceLineNo">065</span> return DEFAULT;<a name="line.65"></a> +<span class="sourceLineNo">066</span><a name="line.66"></a> +<span class="sourceLineNo">067</span> if (value.indexOf(',') == -1)<a name="line.67"></a> +<span class="sourceLineNo">068</span> return new SimpleRange[]{new SimpleRange(value)};<a name="line.68"></a> +<span class="sourceLineNo">069</span><a name="line.69"></a> +<span class="sourceLineNo">070</span> Set<SimpleRange> ranges = new TreeSet<SimpleRange>();<a name="line.70"></a> +<span class="sourceLineNo">071</span><a name="line.71"></a> +<span class="sourceLineNo">072</span> for (String r : StringUtils.split(value, ',')) {<a name="line.72"></a> +<span class="sourceLineNo">073</span> r = r.trim();<a name="line.73"></a> +<span class="sourceLineNo">074</span><a name="line.74"></a> +<span class="sourceLineNo">075</span> if (r.isEmpty())<a name="line.75"></a> +<span class="sourceLineNo">076</span> continue;<a name="line.76"></a> +<span class="sourceLineNo">077</span><a name="line.77"></a> +<span class="sourceLineNo">078</span> ranges.add(new SimpleRange(r));<a name="line.78"></a> +<span class="sourceLineNo">079</span> }<a name="line.79"></a> +<span class="sourceLineNo">080</span><a name="line.80"></a> +<span class="sourceLineNo">081</span> return ranges.toArray(new SimpleRange[ranges.size()]);<a name="line.81"></a> +<span class="sourceLineNo">082</span> }<a name="line.82"></a> +<span class="sourceLineNo">083</span><a name="line.83"></a> +<span class="sourceLineNo">084</span> @SuppressWarnings("unchecked")<a name="line.84"></a> +<span class="sourceLineNo">085</span> private SimpleRange(String token) {<a name="line.85"></a> +<span class="sourceLineNo">086</span> Builder b = new Builder(token);<a name="line.86"></a> +<span class="sourceLineNo">087</span> this.type = b.type;<a name="line.87"></a> +<span class="sourceLineNo">088</span> this.qValue = b.qValue;<a name="line.88"></a> +<span class="sourceLineNo">089</span> this.extensions = (b.extensions == null ? Collections.EMPTY_MAP : Collections.unmodifiableMap(b.extensions));<a name="line.89"></a> +<span class="sourceLineNo">090</span> }<a name="line.90"></a> +<span class="sourceLineNo">091</span><a name="line.91"></a> +<span class="sourceLineNo">092</span> private static class Builder {<a name="line.92"></a> +<span class="sourceLineNo">093</span> private String type;<a name="line.93"></a> +<span class="sourceLineNo">094</span> private Float qValue = 1f;<a name="line.94"></a> +<span class="sourceLineNo">095</span> private Map<String,Set<String>> extensions;<a name="line.95"></a> +<span class="sourceLineNo">096</span><a name="line.96"></a> +<span class="sourceLineNo">097</span> private Builder(String token) {<a name="line.97"></a> +<span class="sourceLineNo">098</span><a name="line.98"></a> +<span class="sourceLineNo">099</span> token = token.trim();<a name="line.99"></a> +<span class="sourceLineNo">100</span><a name="line.100"></a> +<span class="sourceLineNo">101</span> int i = token.indexOf(";q=");<a name="line.101"></a> +<span class="sourceLineNo">102</span><a name="line.102"></a> +<span class="sourceLineNo">103</span> if (i == -1) {<a name="line.103"></a> +<span class="sourceLineNo">104</span> type = token;<a name="line.104"></a> +<span class="sourceLineNo">105</span> return;<a name="line.105"></a> +<span class="sourceLineNo">106</span> }<a name="line.106"></a> +<span class="sourceLineNo">107</span><a name="line.107"></a> +<span class="sourceLineNo">108</span> type = token.substring(0, i);<a name="line.108"></a> +<span class="sourceLineNo">109</span><a name="line.109"></a> +<span class="sourceLineNo">110</span> String[] tokens = token.substring(i+1).split(";");<a name="line.110"></a> +<span class="sourceLineNo">111</span><a name="line.111"></a> +<span class="sourceLineNo">112</span> // Only the type of the range is specified<a name="line.112"></a> +<span class="sourceLineNo">113</span> if (tokens.length > 0) {<a name="line.113"></a> +<span class="sourceLineNo">114</span> boolean isInExtensions = false;<a name="line.114"></a> +<span class="sourceLineNo">115</span> for (int j = 0; j < tokens.length; j++) {<a name="line.115"></a> +<span class="sourceLineNo">116</span> String[] parm = tokens[j].split("=");<a name="line.116"></a> +<span class="sourceLineNo">117</span> if (parm.length == 2) {<a name="line.117"></a> +<span class="sourceLineNo">118</span> String k = parm[0], v = parm[1];<a name="line.118"></a> +<span class="sourceLineNo">119</span> if (isInExtensions) {<a name="line.119"></a> +<span class="sourceLineNo">120</span> if (extensions == null)<a name="line.120"></a> +<span class="sourceLineNo">121</span> extensions = new TreeMap<String,Set<String>>();<a name="line.121"></a> +<span class="sourceLineNo">122</span> if (! extensions.containsKey(k))<a name="line.122"></a> +<span class="sourceLineNo">123</span> extensions.put(k, new TreeSet<String>());<a name="line.123"></a> +<span class="sourceLineNo">124</span> extensions.get(k).add(v);<a name="line.124"></a> +<span class="sourceLineNo">125</span> } else if (k.equals("q")) {<a name="line.125"></a> +<span class="sourceLineNo">126</span> qValue = new Float(v);<a name="line.126"></a> +<span class="sourceLineNo">127</span> isInExtensions = true;<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> }<a name="line.131"></a> +<span class="sourceLineNo">132</span> }<a name="line.132"></a> +<span class="sourceLineNo">133</span> }<a name="line.133"></a> +<span class="sourceLineNo">134</span><a name="line.134"></a> +<span class="sourceLineNo">135</span> /**<a name="line.135"></a> +<span class="sourceLineNo">136</span> * Returns the type enclosed by this type range.<a name="line.136"></a> +<span class="sourceLineNo">137</span> *<a name="line.137"></a> +<span class="sourceLineNo">138</span> * <h5 class='section'>Examples:</h5><a name="line.138"></a> +<span class="sourceLineNo">139</span> * <ul><a name="line.139"></a> +<span class="sourceLineNo">140</span> * <li><js>"compress"</js><a name="line.140"></a> +<span class="sourceLineNo">141</span> * <li><js>"gzip"</js><a name="line.141"></a> +<span class="sourceLineNo">142</span> * <li><js>"*"</js><a name="line.142"></a> +<span class="sourceLineNo">143</span> * </ul><a name="line.143"></a> +<span class="sourceLineNo">144</span> *<a name="line.144"></a> +<span class="sourceLineNo">145</span> * @return The type of this type range, lowercased, never <jk>null</jk>.<a name="line.145"></a> +<span class="sourceLineNo">146</span> */<a name="line.146"></a> +<span class="sourceLineNo">147</span> public String getType() {<a name="line.147"></a> +<span class="sourceLineNo">148</span> return type;<a name="line.148"></a> +<span class="sourceLineNo">149</span> }<a name="line.149"></a> +<span class="sourceLineNo">150</span><a name="line.150"></a> +<span class="sourceLineNo">151</span> /**<a name="line.151"></a> +<span class="sourceLineNo">152</span> * Returns the <js>'q'</js> (quality) value for this type, as described in Section 3.9 of RFC2616.<a name="line.152"></a> +<span class="sourceLineNo">153</span> * <p><a name="line.153"></a> +<span class="sourceLineNo">154</span> * The quality value is a float between <code>0.0</code> (unacceptable) and <code>1.0</code> (most acceptable).<a name="line.154"></a> +<span class="sourceLineNo">155</span> * <p><a name="line.155"></a> +<span class="sourceLineNo">156</span> * If 'q' value doesn't make sense for the context (e.g. this range was extracted from a <js>"content-*"</js> header, as opposed to <js>"accept-*"</js><a name="line.156"></a> +<span class="sourceLineNo">157</span> * header, its value will always be <js>"1"</js>.<a name="line.157"></a> +<span class="sourceLineNo">158</span> *<a name="line.158"></a> +<span class="sourceLineNo">159</span> * @return The 'q' value for this type, never <jk>null</jk>.<a name="line.159"></a> +<span class="sourceLineNo">160</span> */<a name="line.160"></a> +<span class="sourceLineNo">161</span> public Float getQValue() {<a name="line.161"></a> +<span class="sourceLineNo">162</span> return qValue;<a name="line.162"></a> +<span class="sourceLineNo">163</span> }<a name="line.163"></a> +<span class="sourceLineNo">164</span><a name="line.164"></a> +<span class="sourceLineNo">165</span> /**<a name="line.165"></a> +<span class="sourceLineNo">166</span> * Returns the optional set of custom extensions defined for this type.<a name="line.166"></a> +<span class="sourceLineNo">167</span> * <p><a name="line.167"></a> +<span class="sourceLineNo">168</span> * Values are lowercase and never <jk>null</jk>.<a name="line.168"></a> +<span class="sourceLineNo">169</span> *<a name="line.169"></a> +<span class="sourceLineNo">170</span> * @return The optional list of extensions, never <jk>null</jk>.<a name="line.170"></a> +<span class="sourceLineNo">171</span> */<a name="line.171"></a> +<span class="sourceLineNo">172</span> public Map<String,Set<String>> getExtensions() {<a name="line.172"></a> +<span class="sourceLineNo">173</span> return extensions;<a name="line.173"></a> +<span class="sourceLineNo">174</span> }<a name="line.174"></a> +<span class="sourceLineNo">175</span><a name="line.175"></a> +<span class="sourceLineNo">176</span> /**<a name="line.176"></a> +<span class="sourceLineNo">177</span> * Provides a string representation of this media range, suitable for use as an <code>Accept</code> header value.<a name="line.177"></a> +<span class="sourceLineNo">178</span> * <p><a name="line.178"></a> +<span class="sourceLineNo">179</span> * The literal text generated will be all lowercase.<a name="line.179"></a> +<span class="sourceLineNo">180</span> *<a name="line.180"></a> +<span class="sourceLineNo">181</span> * @return A media range suitable for use as an Accept header value, never <code>null</code>.<a name="line.181"></a> +<span class="sourceLineNo">182</span> */<a name="line.182"></a> +<span class="sourceLineNo">183</span> @Override /* Object */<a name="line.183"></a> +<span class="sourceLineNo">184</span> public String toString() {<a name="line.184"></a> +<span class="sourceLineNo">185</span> StringBuffer sb = new StringBuffer().append(type);<a name="line.185"></a> +<span class="sourceLineNo">186</span><a name="line.186"></a> +<span class="sourceLineNo">187</span> // '1' is equivalent to specifying no qValue. If there's no extensions, then we won't include a qValue.<a name="line.187"></a> +<span class="sourceLineNo">188</span> if (qValue.floatValue() == 1.0) {<a name="line.188"></a> +<span class="sourceLineNo">189</span> if (! extensions.isEmpty()) {<a name="line.189"></a> +<span class="sourceLineNo">190</span> sb.append(";q=").append(qValue);<a name="line.190"></a> +<span class="sourceLineNo">191</span> for (Entry<String,Set<String>> e : extensions.entrySet()) {<a name="line.191"></a> +<span class="sourceLineNo">192</span> String k = e.getKey();<a name="line.192"></a> +<span class="sourceLineNo">193</span> for (String v : e.getValue())<a name="line.193"></a> +<span class="sourceLineNo">194</span> sb.append(';').append(k).append('=').append(v);<a name="line.194"></a> +<span class="sourceLineNo">195</span> }<a name="line.195"></a> +<span class="sourceLineNo">196</span> }<a name="line.196"></a> +<span class="sourceLineNo">197</span> } else {<a name="line.197"></a> +<span class="sourceLineNo">198</span> sb.append(";q=").append(qValue);<a name="line.198"></a> +<span class="sourceLineNo">199</span> for (Entry<String,Set<String>> e : extensions.entrySet()) {<a name="line.199"></a> +<span class="sourceLineNo">200</span> String k = e.getKey();<a name="line.200"></a> +<span class="sourceLineNo">201</span> for (String v : e.getValue())<a name="line.201"></a> +<span class="sourceLineNo">202</span> sb.append(';').append(k).append('=').append(v);<a name="line.202"></a> +<span class="sourceLineNo">203</span> }<a name="line.203"></a> +<span class="sourceLineNo">204</span> }<a name="line.204"></a> +<span class="sourceLineNo">205</span> return sb.toString();<a name="line.205"></a> +<span class="sourceLineNo">206</span> }<a name="line.206"></a> +<span class="sourceLineNo">207</span><a name="line.207"></a> +<span class="sourceLineNo">208</span> /**<a name="line.208"></a> +<span class="sourceLineNo">209</span> * Returns <jk>true</jk> if the specified object is also a <code>MediaType</code>, and has the same qValue, type, parameters, and extensions.<a name="line.209"></a> +<span class="sourceLineNo">210</span> *<a name="line.210"></a> +<span class="sourceLineNo">211</span> * @return <jk>true</jk> if object is equivalent.<a name="line.211"></a> +<span class="sourceLineNo">212</span> */<a name="line.212"></a> +<span class="sourceLineNo">213</span> @Override /* Object */<a name="line.213"></a> +<span class="sourceLineNo">214</span> public boolean equals(Object o) {<a name="line.214"></a> +<span class="sourceLineNo">215</span><a name="line.215"></a> +<span class="sourceLineNo">216</span> if (o == null || !(o instanceof SimpleRange))<a name="line.216"></a> +<span class="sourceLineNo">217</span> return false;<a name="line.217"></a> +<span class="sourceLineNo">218</span><a name="line.218"></a> +<span class="sourceLineNo">219</span> if (this == o)<a name="line.219"></a> +<span class="sourceLineNo">220</span> return true;<a name="line.220"></a> +<span class="sourceLineNo">221</span><a name="line.221"></a> +<span class="sourceLineNo">222</span> SimpleRange o2 = (SimpleRange) o;<a name="line.222"></a> +<span class="sourceLineNo">223</span> return qValue.equals(o2.qValue)<a name="line.223"></a> +<span class="sourceLineNo">224</span> && type.equals(o2.type)<a name="line.224"></a> +<span class="sourceLineNo">225</span> && extensions.equals(o2.extensions);<a name="line.225"></a> +<span class="sourceLineNo">226</span> }<a name="line.226"></a> +<span class="sourceLineNo">227</span><a name="line.227"></a> +<span class="sourceLineNo">228</span> /**<a name="line.228"></a> +<span class="sourceLineNo">229</span> * Returns a hash based on this instance's <code>media-type</code>.<a name="line.229"></a> +<span class="sourceLineNo">230</span> *<a name="line.230"></a> +<span class="sourceLineNo">231</span> * @return A hash based on this instance's <code>media-type</code>.<a name="line.231"></a> +<span class="sourceLineNo">232</span> */<a name="line.232"></a> +<span class="sourceLineNo">233</span> @Override /* Object */<a name="line.233"></a> +<span class="sourceLineNo">234</span> public int hashCode() {<a name="line.234"></a> +<span class="sourceLineNo">235</span> return type.hashCode();<a name="line.235"></a> +<span class="sourceLineNo">236</span> }<a name="line.236"></a> +<span class="sourceLineNo">237</span><a name="line.237"></a> +<span class="sourceLineNo">238</span> /**<a name="line.238"></a> +<span class="sourceLineNo">239</span> * Compares two MediaRanges for equality.<a name="line.239"></a> +<span class="sourceLineNo">240</span> * <p><a name="line.240"></a> +<span class="sourceLineNo">241</span> * The values are first compared according to <code>qValue</code> values.<a name="line.241"></a> +<span class="sourceLineNo">242</span> * Should those values be equal, the <code>type</code> is then lexicographically compared (case-insensitive) in ascending order,<a name="line.242"></a> +<span class="sourceLineNo">243</span> * with the <js>"*"</js> type demoted last in that order.<a name="line.243"></a> +<span class="sourceLineNo">244</span> * <code>TypeRanges</code> with the same types but with extensions are promoted over those same types with no extensions.<a name="line.244"></a> +<span class="sourceLineNo">245</span> *<a name="line.245"></a> +<span class="sourceLineNo">246</span> * @param o The range to compare to. Never <jk>null</jk>.<a name="line.246"></a> +<span class="sourceLineNo">247</span> */<a name="line.247"></a> +<span class="sourceLineNo">248</span> @Override /* Comparable */<a name="line.248"></a> +<span class="sourceLineNo">249</span> public int compareTo(SimpleRange o) {<a name="line.249"></a> +<span class="sourceLineNo">250</span><a name="line.250"></a> +<span class="sourceLineNo">251</span> // Compare q-values.<a name="line.251"></a> +<span class="sourceLineNo">252</span> int qCompare = Float.compare(o.qValue, qValue);<a name="line.252"></a> +<span class="sourceLineNo">253</span> if (qCompare != 0)<a name="line.253"></a> +<span class="sourceLineNo">254</span> return qCompare;<a name="line.254"></a> +<span class="sourceLineNo">255</span><a name="line.255"></a> +<span class="sourceLineNo">256</span> // Compare media-types.<a name="line.256"></a> +<span class="sourceLineNo">257</span> // Note that '*' comes alphabetically before letters, so just do a reverse-alphabetical comparison.<a name="line.257"></a> +<span class="sourceLineNo">258</span> int i = o.type.toString().compareTo(type.toString());<a name="line.258"></a> +<span class="sourceLineNo">259</span> return i;<a name="line.259"></a> +<span class="sourceLineNo">260</span> }<a name="line.260"></a> +<span class="sourceLineNo">261</span><a name="line.261"></a> +<span class="sourceLineNo">262</span> /**<a name="line.262"></a> +<span class="sourceLineNo">263</span> * Checks if the specified type matches this range.<a name="line.263"></a> +<span class="sourceLineNo">264</span> * <p><a name="line.264"></a> +<span class="sourceLineNo">265</span> * The type will match this range if the range type string is the same or <js>"*"</js>.<a name="line.265"></a> +<span class="sourceLineNo">266</span> *<a name="line.266"></a> +<span class="sourceLineNo">267</span> * @param type The type to match against this range.<a name="line.267"></a> +<span class="sourceLineNo">268</span> * @return <jk>true</jk> if the specified type matches this range.<a name="line.268"></a> +<span class="sourceLineNo">269</span> */<a name="line.269"></a> +<span class="sourceLineNo">270</span> @SuppressWarnings("hiding")<a name="line.270"></a> +<span class="sourceLineNo">271</span> public boolean matches(String type) {<a name="line.271"></a> +<span class="sourceLineNo">272</span> if (qValue == 0)<a name="line.272"></a> +<span class="sourceLineNo">273</span> return false;<a name="line.273"></a> +<span class="sourceLineNo">274</span> return this.type.equals(type) || this.type.equals("*");<a name="line.274"></a> +<span class="sourceLineNo">275</span> }<a name="line.275"></a> +<span class="sourceLineNo">276</span>}<a name="line.276"></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/StringRange.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/http/StringRange.html b/content/site/apidocs/src-html/org/apache/juneau/http/StringRange.html new file mode 100644 index 0000000..4759b1b --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/http/StringRange.html @@ -0,0 +1,348 @@ +<!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 java.util.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import java.util.Map.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span><a name="line.17"></a> +<span class="sourceLineNo">018</span>import org.apache.juneau.annotation.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span>import org.apache.juneau.internal.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span><a name="line.20"></a> +<span class="sourceLineNo">021</span>/**<a name="line.21"></a> +<span class="sourceLineNo">022</span> * Represents a single value in a comma-delimited header value that optionally contains a quality<a name="line.22"></a> +<span class="sourceLineNo">023</span> * metric for comparison and extension parameters.<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> +<span class="sourceLineNo">025</span> * Similar in concept to {@link MediaTypeRange} except instead of media types (e.g. <js>"text/json"</js>),<a name="line.25"></a> +<span class="sourceLineNo">026</span> * it's a simple type (e.g. <js>"iso-8601"</js>).<a name="line.26"></a> +<span class="sourceLineNo">027</span> * <p><a name="line.27"></a> +<span class="sourceLineNo">028</span> * An example of a type range is a value in an <code>Accept-Encoding</code> header.<a name="line.28"></a> +<span class="sourceLineNo">029</span> */<a name="line.29"></a> +<span class="sourceLineNo">030</span>@BeanIgnore<a name="line.30"></a> +<span class="sourceLineNo">031</span>public final class StringRange implements Comparable<StringRange> {<a name="line.31"></a> +<span class="sourceLineNo">032</span><a name="line.32"></a> +<span class="sourceLineNo">033</span> private static final StringRange[] DEFAULT = new StringRange[]{new StringRange("*")};<a name="line.33"></a> +<span class="sourceLineNo">034</span><a name="line.34"></a> +<span class="sourceLineNo">035</span> private final String type;<a name="line.35"></a> +<span class="sourceLineNo">036</span> private final Float qValue;<a name="line.36"></a> +<span class="sourceLineNo">037</span> private final Map<String,Set<String>> extensions;<a name="line.37"></a> +<span class="sourceLineNo">038</span><a name="line.38"></a> +<span class="sourceLineNo">039</span> /**<a name="line.39"></a> +<span class="sourceLineNo">040</span> * Parses a header such as an <code>Accept-Encoding</code> header value into an array of type ranges.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <p><a name="line.41"></a> +<span class="sourceLineNo">042</span> * The syntax expected to be found in the referenced <code>value</code> complies with the syntax described in RFC2616, Section 14.1, as described below:<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <p class='bcode'><a name="line.43"></a> +<span class="sourceLineNo">044</span> * Accept-Encoding = "Accept-Encoding" ":"<a name="line.44"></a> +<span class="sourceLineNo">045</span> * 1#( codings [ ";" "q" "=" qvalue ] )<a name="line.45"></a> +<span class="sourceLineNo">046</span> * codings = ( content-coding | "*" )<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> * Examples of its use are:<a name="line.49"></a> +<span class="sourceLineNo">050</span> * <p class='bcode'><a name="line.50"></a> +<span class="sourceLineNo">051</span> * Accept-Encoding: compress, gzip<a name="line.51"></a> +<span class="sourceLineNo">052</span> * Accept-Encoding:<a name="line.52"></a> +<span class="sourceLineNo">053</span> * Accept-Encoding: *<a name="line.53"></a> +<span class="sourceLineNo">054</span> * Accept-Encoding: compress;q=0.5, gzip;q=1.0<a name="line.54"></a> +<span class="sourceLineNo">055</span> * Accept-Encoding: gzip;q=1.0, identity; q=0.5, *;q=0<a name="line.55"></a> +<span class="sourceLineNo">056</span> * </p><a name="line.56"></a> +<span class="sourceLineNo">057</span> *<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @param value The value to parse. If <jk>null</jk> or empty, returns a single <code>TypeRange</code> is returned that represents all types.<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @return The type ranges described by the string.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * <br>The ranges are sorted such that the most acceptable type is available at ordinal position <js>'0'</js>, and the least acceptable at position n-1.<a name="line.60"></a> +<span class="sourceLineNo">061</span> */<a name="line.61"></a> +<span class="sourceLineNo">062</span> public static StringRange[] parse(String value) {<a name="line.62"></a> +<span class="sourceLineNo">063</span><a name="line.63"></a> +<span class="sourceLineNo">064</span> if (value == null || value.length() == 0)<a name="line.64"></a> +<span class="sourceLineNo">065</span> return DEFAULT;<a name="line.65"></a> +<span class="sourceLineNo">066</span><a name="line.66"></a> +<span class="sourceLineNo">067</span> if (value.indexOf(',') == -1)<a name="line.67"></a> +<span class="sourceLineNo">068</span> return new StringRange[]{new StringRange(value)};<a name="line.68"></a> +<span class="sourceLineNo">069</span><a name="line.69"></a> +<span class="sourceLineNo">070</span> Set<StringRange> ranges = new TreeSet<StringRange>();<a name="line.70"></a> +<span class="sourceLineNo">071</span><a name="line.71"></a> +<span class="sourceLineNo">072</span> for (String r : StringUtils.split(value, ',')) {<a name="line.72"></a> +<span class="sourceLineNo">073</span> r = r.trim();<a name="line.73"></a> +<span class="sourceLineNo">074</span><a name="line.74"></a> +<span class="sourceLineNo">075</span> if (r.isEmpty())<a name="line.75"></a> +<span class="sourceLineNo">076</span> continue;<a name="line.76"></a> +<span class="sourceLineNo">077</span><a name="line.77"></a> +<span class="sourceLineNo">078</span> ranges.add(new StringRange(r));<a name="line.78"></a> +<span class="sourceLineNo">079</span> }<a name="line.79"></a> +<span class="sourceLineNo">080</span><a name="line.80"></a> +<span class="sourceLineNo">081</span> return ranges.toArray(new StringRange[ranges.size()]);<a name="line.81"></a> +<span class="sourceLineNo">082</span> }<a name="line.82"></a> +<span class="sourceLineNo">083</span><a name="line.83"></a> +<span class="sourceLineNo">084</span> @SuppressWarnings("unchecked")<a name="line.84"></a> +<span class="sourceLineNo">085</span> private StringRange(String token) {<a name="line.85"></a> +<span class="sourceLineNo">086</span> Builder b = new Builder(token);<a name="line.86"></a> +<span class="sourceLineNo">087</span> this.type = b.type;<a name="line.87"></a> +<span class="sourceLineNo">088</span> this.qValue = b.qValue;<a name="line.88"></a> +<span class="sourceLineNo">089</span> this.extensions = (b.extensions == null ? Collections.EMPTY_MAP : Collections.unmodifiableMap(b.extensions));<a name="line.89"></a> +<span class="sourceLineNo">090</span> }<a name="line.90"></a> +<span class="sourceLineNo">091</span><a name="line.91"></a> +<span class="sourceLineNo">092</span> private static class Builder {<a name="line.92"></a> +<span class="sourceLineNo">093</span> private String type;<a name="line.93"></a> +<span class="sourceLineNo">094</span> private Float qValue = 1f;<a name="line.94"></a> +<span class="sourceLineNo">095</span> private Map<String,Set<String>> extensions;<a name="line.95"></a> +<span class="sourceLineNo">096</span><a name="line.96"></a> +<span class="sourceLineNo">097</span> private Builder(String token) {<a name="line.97"></a> +<span class="sourceLineNo">098</span><a name="line.98"></a> +<span class="sourceLineNo">099</span> token = token.trim();<a name="line.99"></a> +<span class="sourceLineNo">100</span><a name="line.100"></a> +<span class="sourceLineNo">101</span> int i = token.indexOf(";q=");<a name="line.101"></a> +<span class="sourceLineNo">102</span><a name="line.102"></a> +<span class="sourceLineNo">103</span> if (i == -1) {<a name="line.103"></a> +<span class="sourceLineNo">104</span> type = token;<a name="line.104"></a> +<span class="sourceLineNo">105</span> return;<a name="line.105"></a> +<span class="sourceLineNo">106</span> }<a name="line.106"></a> +<span class="sourceLineNo">107</span><a name="line.107"></a> +<span class="sourceLineNo">108</span> type = token.substring(0, i);<a name="line.108"></a> +<span class="sourceLineNo">109</span><a name="line.109"></a> +<span class="sourceLineNo">110</span> String[] tokens = token.substring(i+1).split(";");<a name="line.110"></a> +<span class="sourceLineNo">111</span><a name="line.111"></a> +<span class="sourceLineNo">112</span> // Only the type of the range is specified<a name="line.112"></a> +<span class="sourceLineNo">113</span> if (tokens.length > 0) {<a name="line.113"></a> +<span class="sourceLineNo">114</span> boolean isInExtensions = false;<a name="line.114"></a> +<span class="sourceLineNo">115</span> for (int j = 0; j < tokens.length; j++) {<a name="line.115"></a> +<span class="sourceLineNo">116</span> String[] parm = tokens[j].split("=");<a name="line.116"></a> +<span class="sourceLineNo">117</span> if (parm.length == 2) {<a name="line.117"></a> +<span class="sourceLineNo">118</span> String k = parm[0], v = parm[1];<a name="line.118"></a> +<span class="sourceLineNo">119</span> if (isInExtensions) {<a name="line.119"></a> +<span class="sourceLineNo">120</span> if (extensions == null)<a name="line.120"></a> +<span class="sourceLineNo">121</span> extensions = new TreeMap<String,Set<String>>();<a name="line.121"></a> +<span class="sourceLineNo">122</span> if (! extensions.containsKey(k))<a name="line.122"></a> +<span class="sourceLineNo">123</span> extensions.put(k, new TreeSet<String>());<a name="line.123"></a> +<span class="sourceLineNo">124</span> extensions.get(k).add(v);<a name="line.124"></a> +<span class="sourceLineNo">125</span> } else if (k.equals("q")) {<a name="line.125"></a> +<span class="sourceLineNo">126</span> qValue = new Float(v);<a name="line.126"></a> +<span class="sourceLineNo">127</span> isInExtensions = true;<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> }<a name="line.131"></a> +<span class="sourceLineNo">132</span> }<a name="line.132"></a> +<span class="sourceLineNo">133</span> }<a name="line.133"></a> +<span class="sourceLineNo">134</span><a name="line.134"></a> +<span class="sourceLineNo">135</span> /**<a name="line.135"></a> +<span class="sourceLineNo">136</span> * Returns the type enclosed by this type range.<a name="line.136"></a> +<span class="sourceLineNo">137</span> *<a name="line.137"></a> +<span class="sourceLineNo">138</span> * <h5 class='section'>Examples:</h5><a name="line.138"></a> +<span class="sourceLineNo">139</span> * <ul><a name="line.139"></a> +<span class="sourceLineNo">140</span> * <li><js>"compress"</js><a name="line.140"></a> +<span class="sourceLineNo">141</span> * <li><js>"gzip"</js><a name="line.141"></a> +<span class="sourceLineNo">142</span> * <li><js>"*"</js><a name="line.142"></a> +<span class="sourceLineNo">143</span> * </ul><a name="line.143"></a> +<span class="sourceLineNo">144</span> *<a name="line.144"></a> +<span class="sourceLineNo">145</span> * @return The type of this type range, lowercased, never <jk>null</jk>.<a name="line.145"></a> +<span class="sourceLineNo">146</span> */<a name="line.146"></a> +<span class="sourceLineNo">147</span> public String getType() {<a name="line.147"></a> +<span class="sourceLineNo">148</span> return type;<a name="line.148"></a> +<span class="sourceLineNo">149</span> }<a name="line.149"></a> +<span class="sourceLineNo">150</span><a name="line.150"></a> +<span class="sourceLineNo">151</span> /**<a name="line.151"></a> +<span class="sourceLineNo">152</span> * Returns the <js>'q'</js> (quality) value for this type, as described in Section 3.9 of RFC2616.<a name="line.152"></a> +<span class="sourceLineNo">153</span> * <p><a name="line.153"></a> +<span class="sourceLineNo">154</span> * The quality value is a float between <code>0.0</code> (unacceptable) and <code>1.0</code> (most acceptable).<a name="line.154"></a> +<span class="sourceLineNo">155</span> * <p><a name="line.155"></a> +<span class="sourceLineNo">156</span> * If 'q' value doesn't make sense for the context (e.g. this range was extracted from a <js>"content-*"</js> header, as opposed to <js>"accept-*"</js><a name="line.156"></a> +<span class="sourceLineNo">157</span> * header, its value will always be <js>"1"</js>.<a name="line.157"></a> +<span class="sourceLineNo">158</span> *<a name="line.158"></a> +<span class="sourceLineNo">159</span> * @return The 'q' value for this type, never <jk>null</jk>.<a name="line.159"></a> +<span class="sourceLineNo">160</span> */<a name="line.160"></a> +<span class="sourceLineNo">161</span> public Float getQValue() {<a name="line.161"></a> +<span class="sourceLineNo">162</span> return qValue;<a name="line.162"></a> +<span class="sourceLineNo">163</span> }<a name="line.163"></a> +<span class="sourceLineNo">164</span><a name="line.164"></a> +<span class="sourceLineNo">165</span> /**<a name="line.165"></a> +<span class="sourceLineNo">166</span> * Returns the optional set of custom extensions defined for this type.<a name="line.166"></a> +<span class="sourceLineNo">167</span> * <p><a name="line.167"></a> +<span class="sourceLineNo">168</span> * Values are lowercase and never <jk>null</jk>.<a name="line.168"></a> +<span class="sourceLineNo">169</span> *<a name="line.169"></a> +<span class="sourceLineNo">170</span> * @return The optional list of extensions, never <jk>null</jk>.<a name="line.170"></a> +<span class="sourceLineNo">171</span> */<a name="line.171"></a> +<span class="sourceLineNo">172</span> public Map<String,Set<String>> getExtensions() {<a name="line.172"></a> +<span class="sourceLineNo">173</span> return extensions;<a name="line.173"></a> +<span class="sourceLineNo">174</span> }<a name="line.174"></a> +<span class="sourceLineNo">175</span><a name="line.175"></a> +<span class="sourceLineNo">176</span> /**<a name="line.176"></a> +<span class="sourceLineNo">177</span> * Provides a string representation of this media range, suitable for use as an <code>Accept</code> header value.<a name="line.177"></a> +<span class="sourceLineNo">178</span> * <p><a name="line.178"></a> +<span class="sourceLineNo">179</span> * The literal text generated will be all lowercase.<a name="line.179"></a> +<span class="sourceLineNo">180</span> *<a name="line.180"></a> +<span class="sourceLineNo">181</span> * @return A media range suitable for use as an Accept header value, never <code>null</code>.<a name="line.181"></a> +<span class="sourceLineNo">182</span> */<a name="line.182"></a> +<span class="sourceLineNo">183</span> @Override /* Object */<a name="line.183"></a> +<span class="sourceLineNo">184</span> public String toString() {<a name="line.184"></a> +<span class="sourceLineNo">185</span> StringBuffer sb = new StringBuffer().append(type);<a name="line.185"></a> +<span class="sourceLineNo">186</span><a name="line.186"></a> +<span class="sourceLineNo">187</span> // '1' is equivalent to specifying no qValue. If there's no extensions, then we won't include a qValue.<a name="line.187"></a> +<span class="sourceLineNo">188</span> if (qValue.floatValue() == 1.0) {<a name="line.188"></a> +<span class="sourceLineNo">189</span> if (! extensions.isEmpty()) {<a name="line.189"></a> +<span class="sourceLineNo">190</span> sb.append(";q=").append(qValue);<a name="line.190"></a> +<span class="sourceLineNo">191</span> for (Entry<String,Set<String>> e : extensions.entrySet()) {<a name="line.191"></a> +<span class="sourceLineNo">192</span> String k = e.getKey();<a name="line.192"></a> +<span class="sourceLineNo">193</span> for (String v : e.getValue())<a name="line.193"></a> +<span class="sourceLineNo">194</span> sb.append(';').append(k).append('=').append(v);<a name="line.194"></a> +<span class="sourceLineNo">195</span> }<a name="line.195"></a> +<span class="sourceLineNo">196</span> }<a name="line.196"></a> +<span class="sourceLineNo">197</span> } else {<a name="line.197"></a> +<span class="sourceLineNo">198</span> sb.append(";q=").append(qValue);<a name="line.198"></a> +<span class="sourceLineNo">199</span> for (Entry<String,Set<String>> e : extensions.entrySet()) {<a name="line.199"></a> +<span class="sourceLineNo">200</span> String k = e.getKey();<a name="line.200"></a> +<span class="sourceLineNo">201</span> for (String v : e.getValue())<a name="line.201"></a> +<span class="sourceLineNo">202</span> sb.append(';').append(k).append('=').append(v);<a name="line.202"></a> +<span class="sourceLineNo">203</span> }<a name="line.203"></a> +<span class="sourceLineNo">204</span> }<a name="line.204"></a> +<span class="sourceLineNo">205</span> return sb.toString();<a name="line.205"></a> +<span class="sourceLineNo">206</span> }<a name="line.206"></a> +<span class="sourceLineNo">207</span><a name="line.207"></a> +<span class="sourceLineNo">208</span> /**<a name="line.208"></a> +<span class="sourceLineNo">209</span> * Returns <jk>true</jk> if the specified object is also a <code>MediaType</code>, and has the same qValue, type, parameters, and extensions.<a name="line.209"></a> +<span class="sourceLineNo">210</span> *<a name="line.210"></a> +<span class="sourceLineNo">211</span> * @return <jk>true</jk> if object is equivalent.<a name="line.211"></a> +<span class="sourceLineNo">212</span> */<a name="line.212"></a> +<span class="sourceLineNo">213</span> @Override /* Object */<a name="line.213"></a> +<span class="sourceLineNo">214</span> public boolean equals(Object o) {<a name="line.214"></a> +<span class="sourceLineNo">215</span><a name="line.215"></a> +<span class="sourceLineNo">216</span> if (o == null || !(o instanceof StringRange))<a name="line.216"></a> +<span class="sourceLineNo">217</span> return false;<a name="line.217"></a> +<span class="sourceLineNo">218</span><a name="line.218"></a> +<span class="sourceLineNo">219</span> if (this == o)<a name="line.219"></a> +<span class="sourceLineNo">220</span> return true;<a name="line.220"></a> +<span class="sourceLineNo">221</span><a name="line.221"></a> +<span class="sourceLineNo">222</span> StringRange o2 = (StringRange) o;<a name="line.222"></a> +<span class="sourceLineNo">223</span> return qValue.equals(o2.qValue)<a name="line.223"></a> +<span class="sourceLineNo">224</span> && type.equals(o2.type)<a name="line.224"></a> +<span class="sourceLineNo">225</span> && extensions.equals(o2.extensions);<a name="line.225"></a> +<span class="sourceLineNo">226</span> }<a name="line.226"></a> +<span class="sourceLineNo">227</span><a name="line.227"></a> +<span class="sourceLineNo">228</span> /**<a name="line.228"></a> +<span class="sourceLineNo">229</span> * Returns a hash based on this instance's <code>media-type</code>.<a name="line.229"></a> +<span class="sourceLineNo">230</span> *<a name="line.230"></a> +<span class="sourceLineNo">231</span> * @return A hash based on this instance's <code>media-type</code>.<a name="line.231"></a> +<span class="sourceLineNo">232</span> */<a name="line.232"></a> +<span class="sourceLineNo">233</span> @Override /* Object */<a name="line.233"></a> +<span class="sourceLineNo">234</span> public int hashCode() {<a name="line.234"></a> +<span class="sourceLineNo">235</span> return type.hashCode();<a name="line.235"></a> +<span class="sourceLineNo">236</span> }<a name="line.236"></a> +<span class="sourceLineNo">237</span><a name="line.237"></a> +<span class="sourceLineNo">238</span> /**<a name="line.238"></a> +<span class="sourceLineNo">239</span> * Compares two MediaRanges for equality.<a name="line.239"></a> +<span class="sourceLineNo">240</span> * <p><a name="line.240"></a> +<span class="sourceLineNo">241</span> * The values are first compared according to <code>qValue</code> values.<a name="line.241"></a> +<span class="sourceLineNo">242</span> * Should those values be equal, the <code>type</code> is then lexicographically compared (case-insensitive) in ascending order,<a name="line.242"></a> +<span class="sourceLineNo">243</span> * with the <js>"*"</js> type demoted last in that order.<a name="line.243"></a> +<span class="sourceLineNo">244</span> * <code>TypeRanges</code> with the same types but with extensions are promoted over those same types with no extensions.<a name="line.244"></a> +<span class="sourceLineNo">245</span> *<a name="line.245"></a> +<span class="sourceLineNo">246</span> * @param o The range to compare to. Never <jk>null</jk>.<a name="line.246"></a> +<span class="sourceLineNo">247</span> */<a name="line.247"></a> +<span class="sourceLineNo">248</span> @Override /* Comparable */<a name="line.248"></a> +<span class="sourceLineNo">249</span> public int compareTo(StringRange o) {<a name="line.249"></a> +<span class="sourceLineNo">250</span><a name="line.250"></a> +<span class="sourceLineNo">251</span> // Compare q-values.<a name="line.251"></a> +<span class="sourceLineNo">252</span> int qCompare = Float.compare(o.qValue, qValue);<a name="line.252"></a> +<span class="sourceLineNo">253</span> if (qCompare != 0)<a name="line.253"></a> +<span class="sourceLineNo">254</span> return qCompare;<a name="line.254"></a> +<span class="sourceLineNo">255</span><a name="line.255"></a> +<span class="sourceLineNo">256</span> // Compare media-types.<a name="line.256"></a> +<span class="sourceLineNo">257</span> // Note that '*' comes alphabetically before letters, so just do a reverse-alphabetical comparison.<a name="line.257"></a> +<span class="sourceLineNo">258</span> int i = o.type.toString().compareTo(type.toString());<a name="line.258"></a> +<span class="sourceLineNo">259</span> return i;<a name="line.259"></a> +<span class="sourceLineNo">260</span> }<a name="line.260"></a> +<span class="sourceLineNo">261</span><a name="line.261"></a> +<span class="sourceLineNo">262</span> /**<a name="line.262"></a> +<span class="sourceLineNo">263</span> * Checks if the specified type matches this range.<a name="line.263"></a> +<span class="sourceLineNo">264</span> * <p><a name="line.264"></a> +<span class="sourceLineNo">265</span> * The type will match this range if the range type string is the same or <js>"*"</js>.<a name="line.265"></a> +<span class="sourceLineNo">266</span> *<a name="line.266"></a> +<span class="sourceLineNo">267</span> * @param type The type to match against this range.<a name="line.267"></a> +<span class="sourceLineNo">268</span> * @return <jk>true</jk> if the specified type matches this range.<a name="line.268"></a> +<span class="sourceLineNo">269</span> */<a name="line.269"></a> +<span class="sourceLineNo">270</span> @SuppressWarnings("hiding")<a name="line.270"></a> +<span class="sourceLineNo">271</span> public boolean matches(String type) {<a name="line.271"></a> +<span class="sourceLineNo">272</span> if (qValue == 0)<a name="line.272"></a> +<span class="sourceLineNo">273</span> return false;<a name="line.273"></a> +<span class="sourceLineNo">274</span> return this.type.equals(type) || this.type.equals("*");<a name="line.274"></a> +<span class="sourceLineNo">275</span> }<a name="line.275"></a> +<span class="sourceLineNo">276</span>}<a name="line.276"></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/TE.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/http/TE.html b/content/site/apidocs/src-html/org/apache/juneau/http/TE.html new file mode 100644 index 0000000..5e74119 --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/http/TE.html @@ -0,0 +1,169 @@ +<!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>TE</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> * The transfer encodings the user agent is willing to accept: the same values as for the response header field<a name="line.22"></a> +<span class="sourceLineNo">023</span> * Transfer-Encoding can be used, plus the "trailers" value (related to the "chunked" transfer method) to notify the<a name="line.23"></a> +<span class="sourceLineNo">024</span> * server it expects to receive additional fields in the trailer after the last, zero-sized, chunk.<a name="line.24"></a> +<span class="sourceLineNo">025</span> *<a name="line.25"></a> +<span class="sourceLineNo">026</span> * <h6 class='figure'>Example</h6><a name="line.26"></a> +<span class="sourceLineNo">027</span> * <p class='bcode'><a name="line.27"></a> +<span class="sourceLineNo">028</span> * TE: trailers, deflate<a name="line.28"></a> +<span class="sourceLineNo">029</span> * </p><a name="line.29"></a> +<span class="sourceLineNo">030</span> *<a name="line.30"></a> +<span class="sourceLineNo">031</span> * <h6 class='topic'>RFC2616 Specification</h6><a name="line.31"></a> +<span class="sourceLineNo">032</span> *<a name="line.32"></a> +<span class="sourceLineNo">033</span> * The TE request-header field indicates what extension transfer-codings it is willing to accept in the response and<a name="line.33"></a> +<span class="sourceLineNo">034</span> * whether or not it is willing to accept trailer fields in a chunked transfer-coding.<a name="line.34"></a> +<span class="sourceLineNo">035</span> * Its value may consist of the keyword "trailers" and/or a comma-separated list of extension transfer-coding names<a name="line.35"></a> +<span class="sourceLineNo">036</span> * with optional accept parameters (as described in section 3.6).<a name="line.36"></a> +<span class="sourceLineNo">037</span> * <p class='bcode'><a name="line.37"></a> +<span class="sourceLineNo">038</span> * TE = "TE" ":" #( t-codings )<a name="line.38"></a> +<span class="sourceLineNo">039</span> * t-codings = "trailers" | ( transfer-extension [ accept-params ] )<a name="line.39"></a> +<span class="sourceLineNo">040</span> * </p><a name="line.40"></a> +<span class="sourceLineNo">041</span> * The presence of the keyword "trailers" indicates that the client is willing to accept trailer fields in a chunked<a name="line.41"></a> +<span class="sourceLineNo">042</span> * transfer-coding, as defined in section 3.6.1.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * This keyword is reserved for use with transfer-coding values even though it does not itself represent a transfer-coding.<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <p><a name="line.44"></a> +<span class="sourceLineNo">045</span> * Examples of its use are:<a name="line.45"></a> +<span class="sourceLineNo">046</span> * <p class='bcode'><a name="line.46"></a> +<span class="sourceLineNo">047</span> * TE: deflate<a name="line.47"></a> +<span class="sourceLineNo">048</span> * TE:<a name="line.48"></a> +<span class="sourceLineNo">049</span> * TE: trailers, deflate;q=0.5<a name="line.49"></a> +<span class="sourceLineNo">050</span> * </p><a name="line.50"></a> +<span class="sourceLineNo">051</span> * <p><a name="line.51"></a> +<span class="sourceLineNo">052</span> * The TE header field only applies to the immediate connection.<a name="line.52"></a> +<span class="sourceLineNo">053</span> * Therefore, the keyword MUST be supplied within a Connection header field (section 14.10) whenever TE is present in<a name="line.53"></a> +<span class="sourceLineNo">054</span> * an HTTP/1.1 message.<a name="line.54"></a> +<span class="sourceLineNo">055</span> * <p><a name="line.55"></a> +<span class="sourceLineNo">056</span> * A server tests whether a transfer-coding is acceptable, according to a TE field, using these rules:<a name="line.56"></a> +<span class="sourceLineNo">057</span> * <ol><a name="line.57"></a> +<span class="sourceLineNo">058</span> * <li>The "chunked" transfer-coding is always acceptable.<a name="line.58"></a> +<span class="sourceLineNo">059</span> * If the keyword "trailers" is listed, the client indicates that it is willing to accept trailer fields in the<a name="line.59"></a> +<span class="sourceLineNo">060</span> * chunked response on behalf of itself and any downstream clients.<a name="line.60"></a> +<span class="sourceLineNo">061</span> * The implication is that, if given, the client is stating that either all downstream clients are willing to accept<a name="line.61"></a> +<span class="sourceLineNo">062</span> * trailer fields in the forwarded response, or that it will attempt to buffer the response on behalf of downstream<a name="line.62"></a> +<span class="sourceLineNo">063</span> * recipients.<a name="line.63"></a> +<span class="sourceLineNo">064</span> * Note: HTTP/1.1 does not define any means to limit the size of a chunked response such that a client can be assured<a name="line.64"></a> +<span class="sourceLineNo">065</span> * of buffering the entire response.<a name="line.65"></a> +<span class="sourceLineNo">066</span> * <li>If the transfer-coding being tested is one of the transfer-codings listed in the TE field, then it is acceptable<a name="line.66"></a> +<span class="sourceLineNo">067</span> * unless it is accompanied by a qvalue of 0. (As defined in section 3.9, a qvalue of 0 means "not acceptable.")<a name="line.67"></a> +<span class="sourceLineNo">068</span> * <li>If multiple transfer-codings are acceptable, then the acceptable transfer-coding with the highest non-zero<a name="line.68"></a> +<span class="sourceLineNo">069</span> * qvalue is preferred.<a name="line.69"></a> +<span class="sourceLineNo">070</span> * The "chunked" transfer-coding always has a qvalue of 1.<a name="line.70"></a> +<span class="sourceLineNo">071</span> * </ol><a name="line.71"></a> +<span class="sourceLineNo">072</span> * If the TE field-value is empty or if no TE field is present, the only transfer-coding is "chunked".<a name="line.72"></a> +<span class="sourceLineNo">073</span> * A message with no transfer-coding is always acceptable.<a name="line.73"></a> +<span class="sourceLineNo">074</span> */<a name="line.74"></a> +<span class="sourceLineNo">075</span>public final class TE extends HeaderRangeArray {<a name="line.75"></a> +<span class="sourceLineNo">076</span><a name="line.76"></a> +<span class="sourceLineNo">077</span> private static final Cache<String,TE> cache = new Cache<String,TE>(NOCACHE, CACHE_MAX_SIZE);<a name="line.77"></a> +<span class="sourceLineNo">078</span><a name="line.78"></a> +<span class="sourceLineNo">079</span> /**<a name="line.79"></a> +<span class="sourceLineNo">080</span> * Returns a parsed <code>Accept</code> header.<a name="line.80"></a> +<span class="sourceLineNo">081</span> *<a name="line.81"></a> +<span class="sourceLineNo">082</span> * @param value The <code>Accept</code> header string.<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @return The parsed <code>Accept</code> header, or <jk>null</jk> if the string was null.<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span> public static TE forString(String value) {<a name="line.85"></a> +<span class="sourceLineNo">086</span> if (value == null)<a name="line.86"></a> +<span class="sourceLineNo">087</span> return null;<a name="line.87"></a> +<span class="sourceLineNo">088</span> TE te = cache.get(value);<a name="line.88"></a> +<span class="sourceLineNo">089</span> if (te == null)<a name="line.89"></a> +<span class="sourceLineNo">090</span> te = cache.put(value, new TE(value));<a name="line.90"></a> +<span class="sourceLineNo">091</span> return te;<a name="line.91"></a> +<span class="sourceLineNo">092</span> }<a name="line.92"></a> +<span class="sourceLineNo">093</span><a name="line.93"></a> +<span class="sourceLineNo">094</span> private TE(String value) {<a name="line.94"></a> +<span class="sourceLineNo">095</span> super(value);<a name="line.95"></a> +<span class="sourceLineNo">096</span> }<a name="line.96"></a> +<span class="sourceLineNo">097</span>}<a name="line.97"></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/Trailer.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/http/Trailer.html b/content/site/apidocs/src-html/org/apache/juneau/http/Trailer.html new file mode 100644 index 0000000..433b092 --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/http/Trailer.html @@ -0,0 +1,137 @@ +<!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>Trailer</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 Trailer general field value indicates that the given set of header fields is present in the trailer of a message<a name="line.18"></a> +<span class="sourceLineNo">019</span> * encoded with chunked transfer coding.<a name="line.19"></a> +<span class="sourceLineNo">020</span> *<a name="line.20"></a> +<span class="sourceLineNo">021</span> * <h6 class='figure'>Example</h6><a name="line.21"></a> +<span class="sourceLineNo">022</span> * <p class='bcode'><a name="line.22"></a> +<span class="sourceLineNo">023</span> * Trailer: Max-Forwards<a name="line.23"></a> +<span class="sourceLineNo">024</span> * </p><a name="line.24"></a> +<span class="sourceLineNo">025</span> *<a name="line.25"></a> +<span class="sourceLineNo">026</span> * <h6 class='topic'>RFC2616 Specification</h6><a name="line.26"></a> +<span class="sourceLineNo">027</span> *<a name="line.27"></a> +<span class="sourceLineNo">028</span> * The Trailer general field value indicates that the given set of header fields is present in the trailer of a message<a name="line.28"></a> +<span class="sourceLineNo">029</span> * encoded with chunked transfer-coding.<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <p class='bcode'><a name="line.30"></a> +<span class="sourceLineNo">031</span> * Trailer = "Trailer" ":" 1#field-name<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> * An HTTP/1.1 message SHOULD include a Trailer header field in a message using chunked transfer-coding with a non-empty<a name="line.34"></a> +<span class="sourceLineNo">035</span> * trailer.<a name="line.35"></a> +<span class="sourceLineNo">036</span> * Doing so allows the recipient to know which header fields to expect in the trailer.<a name="line.36"></a> +<span class="sourceLineNo">037</span> * <p><a name="line.37"></a> +<span class="sourceLineNo">038</span> * If no Trailer header field is present, the trailer SHOULD NOT include any header fields.<a name="line.38"></a> +<span class="sourceLineNo">039</span> * See section 3.6.1 for restrictions on the use of trailer fields in a "chunked" transfer-coding.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * <p><a name="line.40"></a> +<span class="sourceLineNo">041</span> * Message header fields listed in the Trailer header field MUST NOT include the following header fields:<a name="line.41"></a> +<span class="sourceLineNo">042</span> * <ul><a name="line.42"></a> +<span class="sourceLineNo">043</span> * <li>Transfer-Encoding<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <li>Content-Length<a name="line.44"></a> +<span class="sourceLineNo">045</span> * <li>Trailer<a name="line.45"></a> +<span class="sourceLineNo">046</span> * </ul><a name="line.46"></a> +<span class="sourceLineNo">047</span> */<a name="line.47"></a> +<span class="sourceLineNo">048</span>public final class Trailer extends HeaderString {<a name="line.48"></a> +<span class="sourceLineNo">049</span><a name="line.49"></a> +<span class="sourceLineNo">050</span> /**<a name="line.50"></a> +<span class="sourceLineNo">051</span> * Returns a parsed <code>Trailer</code> header.<a name="line.51"></a> +<span class="sourceLineNo">052</span> *<a name="line.52"></a> +<span class="sourceLineNo">053</span> * @param value The <code>Trailer</code> header string.<a name="line.53"></a> +<span class="sourceLineNo">054</span> * @return The parsed <code>Trailer</code> header, or <jk>null</jk> if the string was null.<a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span> public static Trailer forString(String value) {<a name="line.56"></a> +<span class="sourceLineNo">057</span> if (value == null)<a name="line.57"></a> +<span class="sourceLineNo">058</span> return null;<a name="line.58"></a> +<span class="sourceLineNo">059</span> return new Trailer(value);<a name="line.59"></a> +<span class="sourceLineNo">060</span> }<a name="line.60"></a> +<span class="sourceLineNo">061</span><a name="line.61"></a> +<span class="sourceLineNo">062</span> private Trailer(String value) {<a name="line.62"></a> +<span class="sourceLineNo">063</span> super(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> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
