| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> |
| <span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> |
| <span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> |
| <span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> |
| <span class="sourceLineNo">006</span>// * *<a name="line.6"></a> |
| <span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> |
| <span class="sourceLineNo">008</span>// * *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> |
| <span class="sourceLineNo">013</span>package org.apache.juneau.http.header;<a name="line.13"></a> |
| <span class="sourceLineNo">014</span><a name="line.14"></a> |
| <span class="sourceLineNo">015</span>import java.util.function.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span><a name="line.16"></a> |
| <span class="sourceLineNo">017</span>import org.apache.juneau.http.annotation.*;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>/**<a name="line.19"></a> |
| <span class="sourceLineNo">020</span> * Represents a parsed <l>Content-Encoding</l> HTTP response header.<a name="line.20"></a> |
| <span class="sourceLineNo">021</span> *<a name="line.21"></a> |
| <span class="sourceLineNo">022</span> * <p><a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * The type of encoding used on the data.<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> *<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * <h5 class='figure'>Example</h5><a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * <p class='bcode'><a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * Content-Encoding: gzip<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * </p><a name="line.28"></a> |
| <span class="sourceLineNo">029</span> *<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * <h5 class='topic'>RFC2616 Specification</h5><a name="line.30"></a> |
| <span class="sourceLineNo">031</span> *<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * The Content-Encoding entity-header field is used as a modifier to the media-type.<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * When present, its value indicates what additional content codings have been applied to the entity-body, and thus<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * what decoding mechanisms must be applied in order to obtain the media-type referenced by the Content-Type header<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * field.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * Content-Encoding is primarily used to allow a document to be compressed without losing the identity of its<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * underlying media type.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <p class='bcode'><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * Content-Encoding = "Content-Encoding" ":" 1#content-coding<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * </p><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <p><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * Content codings are defined in section 3.5. An example of its use is...<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <p class='bcode'><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * Content-Encoding: gzip<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * </p><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> *<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <p><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * The content-coding is a characteristic of the entity identified by the Request-URI.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * Typically, the entity-body is stored with this encoding and is only decoded before rendering or analogous usage.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * However, a non-transparent proxy MAY modify the content-coding if the new coding is known to be acceptable to the<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * recipient, unless the "no-transform" cache-control directive is present in the message.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> *<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * <p><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * If the content-coding of an entity is not "identity", then the response MUST include a Content-Encoding<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * entity-header (section 14.11) that lists the non-identity content-coding(s) used.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> *<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * <p><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * If the content-coding of an entity in a request message is not acceptable to the origin server, the server SHOULD<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * respond with a status code of 415 (Unsupported Media Type).<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> *<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * <p><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * If multiple encodings have been applied to an entity, the content codings MUST be listed in the order in which they<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * were applied.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * Additional information about the encoding parameters MAY be provided.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> *<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * <ul class='seealso'><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * <li class='link'>{@doc jm.HttpParts}<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <li class='extlink'>{@doc ext.RFC2616}<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * <li class='extlink'>{@source}<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * </ul><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> *<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @serial exclude<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> */<a name="line.74"></a> |
| <span class="sourceLineNo">075</span>@Header("Content-Encoding")<a name="line.75"></a> |
| <span class="sourceLineNo">076</span>@Schema(_enum={"gzip","compress","deflate","identity","other"})<a name="line.76"></a> |
| <span class="sourceLineNo">077</span>public class ContentEncoding extends BasicStringHeader {<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> // Static<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> |
| <span class="sourceLineNo">083</span> private static final long serialVersionUID = 1L;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> private static final String NAME = "Content-Encoding";<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> /**<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * Static creator.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> *<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @param value<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * The header value.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * <br>Can be <jk>null</jk>.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @return A new header bean, or <jk>null</jk> if the value is <jk>null</jk>.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> */<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> public static ContentEncoding of(String value) {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> return value == null ? null : new ContentEncoding(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> |
| <span class="sourceLineNo">098</span> /**<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * Static creator with delayed value.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> *<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * <p><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * Header value is re-evaluated on each call to {@link #getValue()}.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> *<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @param value<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * The supplier of the header value.<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * <br>Can be <jk>null</jk>.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @return A new header bean, or <jk>null</jk> if the value is <jk>null</jk>.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> */<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> public static ContentEncoding of(Supplier<String> value) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> return value == null ? null : new ContentEncoding(value);<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> // Instance<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.115"></a> |
| <span class="sourceLineNo">116</span><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> /**<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * Constructor.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> *<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * @param value<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * The header value.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * <br>Can be <jk>null</jk>.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> */<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> public ContentEncoding(String value) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> super(NAME, value);<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> }<a name="line.126"></a> |
| <span class="sourceLineNo">127</span><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> /**<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * Constructor with delayed value.<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> *<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * <p><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * Header value is re-evaluated on each call to {@link #getValue()}.<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> *<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @param value<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * The supplier of the header value.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * <br>Can be <jk>null</jk>.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> */<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> public ContentEncoding(Supplier<String> value) {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> super(NAME, value);<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> }<a name="line.140"></a> |
| <span class="sourceLineNo">141</span>}<a name="line.141"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
