| <!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.encoders;<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.internal.CollectionUtils.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span><a name="line.16"></a> |
| <span class="sourceLineNo">017</span>import java.util.*;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>import java.util.concurrent.*;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.apache.juneau.http.*;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>/**<a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * Represents the group of {@link Encoder encoders} keyed by codings.<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> *<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * <h5 class='topic'>Description</h5><a name="line.25"></a> |
| <span class="sourceLineNo">026</span> *<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * Maintains a set of encoders and the codings that they can handle.<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> *<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * <p><a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * The {@link #getEncoderMatch(String)} and {@link #getEncoder(String)} methods are then used to find appropriate<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * encoders for specific <c>Accept-Encoding</c> and <c>Content-Encoding</c> header values.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> *<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * <h5 class='topic'>Match ordering</h5><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> *<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * Encoders are matched against <c>Accept-Encoding</c> strings in the order they exist in this group.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> *<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * <p><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * Adding new entries will cause the entries to be prepended to the group.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * This allows for previous encoders to be overridden through subsequent calls.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> *<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <p><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * For example, calling <code>groupBuilder.append(E1.<jk>class</jk>,E2.<jk>class</jk>).append(E3.<jk>class</jk>,<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * E4.<jk>class</jk>)</code> will result in the order <c>E3, E4, E1, E2</c>.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> *<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <h5 class='section'>Example:</h5><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <p class='bcode w800'><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <jc>// Create an encoder group with support for gzip compression.</jc><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * EncoderGroup g = EncoderGroup.<jsm>create</jsm>().append(GzipEncoder.<jk>class</jk>).build();<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> *<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <jc>// Should return "gzip"</jc><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * String matchedCoding = g.findMatch(<js>"compress;q=1.0, gzip;q=0.8, identity;q=0.5, *;q=0"</js>);<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> *<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * <jc>// Get the encoder</jc><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * IEncoder encoder = g.getEncoder(matchedCoding);<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * </p><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span>public final class EncoderGroup {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> /**<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * A default encoder group consisting of identity and G-Zip encoding.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> public static final EncoderGroup DEFAULT = create().append(IdentityEncoder.class, GzipEncoder.class).build();<a name="line.62"></a> |
| <span class="sourceLineNo">063</span><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> // Maps Accept-Encoding headers to matching encoders.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> private final ConcurrentHashMap<String,EncoderMatch> cache = new ConcurrentHashMap<>();<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> private final String[] encodings;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> private final List<String> encodingsList;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> private final Encoder[] encodingsEncoders;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> private final List<Encoder> encoders;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> /**<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * Instantiates a new clean-slate {@link EncoderGroupBuilder} object.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> *<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * <p><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * This is equivalent to simply calling <code><jk>new</jk> EncoderGroupBuilder()</code>.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> *<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @return A new {@link EncoderGroupBuilder} object.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> public static EncoderGroupBuilder create() {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> return new EncoderGroupBuilder();<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> /**<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * Returns a builder that's a copy of the settings on this encoder group.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> *<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * @return A new {@link EncoderGroupBuilder} initialized to this group.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> */<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> public EncoderGroupBuilder builder() {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> return new EncoderGroupBuilder(this);<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> }<a name="line.91"></a> |
| <span class="sourceLineNo">092</span><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> /**<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * Constructor<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> *<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * @param encoders The encoders to add to this group.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> */<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> public EncoderGroup(Encoder[] encoders) {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> this.encoders = immutableList(encoders);<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> List<String> lc = new ArrayList<>();<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> List<Encoder> l = new ArrayList<>();<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> for (Encoder e : encoders) {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> for (String c: e.getCodings()) {<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> lc.add(c);<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> l.add(e);<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> }<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> this.encodings = lc.toArray(new String[lc.size()]);<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> this.encodingsList = unmodifiableList(lc);<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> this.encodingsEncoders = l.toArray(new Encoder[l.size()]);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> /**<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * Returns the coding string for the matching encoder that can handle the specified <c>Accept-Encoding</c><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * or <c>Content-Encoding</c> header value.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> *<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * <p><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * Returns <jk>null</jk> if no encoders can handle it.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> *<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * <p><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * This method is fully compliant with the RFC2616/14.3 and 14.11 specifications.<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> *<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * @param acceptEncoding The <c>Accept-Encoding</c> or <c>Content-Encoding</c> value.<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * @return The coding value (e.g. <js>"gzip"</js>).<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> */<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> public EncoderMatch getEncoderMatch(String acceptEncoding) {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> EncoderMatch em = cache.get(acceptEncoding);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> if (em != null)<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> return em;<a name="line.131"></a> |
| <span class="sourceLineNo">132</span><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> AcceptEncoding ae = AcceptEncoding.forString(acceptEncoding);<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> int match = ae.findMatch(encodings);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span><a name="line.135"></a> |
| <span class="sourceLineNo">136</span> if (match >= 0) {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> em = new EncoderMatch(encodings[match], encodingsEncoders[match]);<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> cache.putIfAbsent(acceptEncoding, em);<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> }<a name="line.139"></a> |
| <span class="sourceLineNo">140</span><a name="line.140"></a> |
| <span class="sourceLineNo">141</span> return cache.get(acceptEncoding);<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> /**<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * Returns the encoder registered with the specified coding (e.g. <js>"gzip"</js>).<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> *<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * @param encoding The coding string.<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * @return The encoder, or <jk>null</jk> if encoder isn't registered with that coding.<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> */<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> public Encoder getEncoder(String encoding) {<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> EncoderMatch em = getEncoderMatch(encoding);<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> return (em == null ? null : em.getEncoder());<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> }<a name="line.153"></a> |
| <span class="sourceLineNo">154</span><a name="line.154"></a> |
| <span class="sourceLineNo">155</span> /**<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * Returns the set of codings supported by all encoders in this group.<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> *<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * @return An unmodifiable list of codings supported by all encoders in this group. Never <jk>null</jk>.<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> */<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> public List<String> getSupportedEncodings() {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> return encodingsList;<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<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> * Returns the encoders in this group.<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> *<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * @return An unmodifiable list of encoders in this group.<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> */<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> public List<Encoder> getEncoders() {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> return encoders;<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> }<a name="line.171"></a> |
| <span class="sourceLineNo">172</span>}<a name="line.172"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
