| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (18) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.juneau, class: MediaRanges"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">// ***************************************************************************************************************************</span> |
| <span class="source-line-no">002</span><span id="line-2">// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *</span> |
| <span class="source-line-no">003</span><span id="line-3">// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *</span> |
| <span class="source-line-no">004</span><span id="line-4">// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *</span> |
| <span class="source-line-no">005</span><span id="line-5">// * with the License. You may obtain a copy of the License at *</span> |
| <span class="source-line-no">006</span><span id="line-6">// * *</span> |
| <span class="source-line-no">007</span><span id="line-7">// * http://www.apache.org/licenses/LICENSE-2.0 *</span> |
| <span class="source-line-no">008</span><span id="line-8">// * *</span> |
| <span class="source-line-no">009</span><span id="line-9">// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *</span> |
| <span class="source-line-no">010</span><span id="line-10">// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *</span> |
| <span class="source-line-no">011</span><span id="line-11">// * specific language governing permissions and limitations under the License. *</span> |
| <span class="source-line-no">012</span><span id="line-12">// ***************************************************************************************************************************</span> |
| <span class="source-line-no">013</span><span id="line-13">package org.apache.juneau;</span> |
| <span class="source-line-no">014</span><span id="line-14"></span> |
| <span class="source-line-no">015</span><span id="line-15">import static org.apache.juneau.common.internal.StringUtils.*;</span> |
| <span class="source-line-no">016</span><span id="line-16">import static org.apache.juneau.internal.CollectionUtils.*;</span> |
| <span class="source-line-no">017</span><span id="line-17"></span> |
| <span class="source-line-no">018</span><span id="line-18">import java.util.*;</span> |
| <span class="source-line-no">019</span><span id="line-19">import java.util.function.*;</span> |
| <span class="source-line-no">020</span><span id="line-20"></span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.http.*;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.http.message.*;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.juneau.annotation.*;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.juneau.common.internal.*;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.juneau.internal.*;</span> |
| <span class="source-line-no">026</span><span id="line-26"></span> |
| <span class="source-line-no">027</span><span id="line-27">/**</span> |
| <span class="source-line-no">028</span><span id="line-28"> * A parsed <c>Accept</c> or similar header value.</span> |
| <span class="source-line-no">029</span><span id="line-29"> *</span> |
| <span class="source-line-no">030</span><span id="line-30"> * <p></span> |
| <span class="source-line-no">031</span><span id="line-31"> * The returned media ranges are sorted such that the most acceptable media is available at ordinal position</span> |
| <span class="source-line-no">032</span><span id="line-32"> * <js>'0'</js>, and the least acceptable at position n-1.</span> |
| <span class="source-line-no">033</span><span id="line-33"> *</span> |
| <span class="source-line-no">034</span><span id="line-34"> * <p></span> |
| <span class="source-line-no">035</span><span id="line-35"> * The syntax expected to be found in the referenced <c>value</c> complies with the syntax described in</span> |
| <span class="source-line-no">036</span><span id="line-36"> * RFC2616, Section 14.1, as described below:</span> |
| <span class="source-line-no">037</span><span id="line-37"> * <p class='bcode'></span> |
| <span class="source-line-no">038</span><span id="line-38"> * Accept = "Accept" ":"</span> |
| <span class="source-line-no">039</span><span id="line-39"> * #( media-range [ accept-params ] )</span> |
| <span class="source-line-no">040</span><span id="line-40"> *</span> |
| <span class="source-line-no">041</span><span id="line-41"> * media-range = ( "*\/*"</span> |
| <span class="source-line-no">042</span><span id="line-42"> * | ( type "/" "*" )</span> |
| <span class="source-line-no">043</span><span id="line-43"> * | ( type "/" subtype )</span> |
| <span class="source-line-no">044</span><span id="line-44"> * ) *( ";" parameter )</span> |
| <span class="source-line-no">045</span><span id="line-45"> * accept-params = ";" "q" "=" qvalue *( accept-extension )</span> |
| <span class="source-line-no">046</span><span id="line-46"> * accept-extension = ";" token [ "=" ( token | quoted-string ) ]</span> |
| <span class="source-line-no">047</span><span id="line-47"> * </p></span> |
| <span class="source-line-no">048</span><span id="line-48"> *</span> |
| <span class="source-line-no">049</span><span id="line-49"> * <h5 class='section'>See Also:</h5><ul></span> |
| <span class="source-line-no">050</span><span id="line-50"> * <li class='link'><a class="doclink" href="../../../index.html#juneau-rest-common">juneau-rest-common</a></span> |
| <span class="source-line-no">051</span><span id="line-51"> * <li class='extlink'><a class="doclink" href="https://www.w3.org/Protocols/rfc2616/rfc2616.html">Hypertext Transfer Protocol -- HTTP/1.1</a></span> |
| <span class="source-line-no">052</span><span id="line-52"> * </ul></span> |
| <span class="source-line-no">053</span><span id="line-53"> */</span> |
| <span class="source-line-no">054</span><span id="line-54">@BeanIgnore</span> |
| <span class="source-line-no">055</span><span id="line-55">public class MediaRanges {</span> |
| <span class="source-line-no">056</span><span id="line-56"></span> |
| <span class="source-line-no">057</span><span id="line-57"> //-----------------------------------------------------------------------------------------------------------------</span> |
| <span class="source-line-no">058</span><span id="line-58"> // Static</span> |
| <span class="source-line-no">059</span><span id="line-59"> //-----------------------------------------------------------------------------------------------------------------</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> /** Represents an empty media ranges object. */</span> |
| <span class="source-line-no">062</span><span id="line-62"> public static final MediaRanges EMPTY = new MediaRanges("");</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> private static final Cache<String,MediaRanges> CACHE = Cache.of(String.class, MediaRanges.class).build();</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> private final MediaRange[] ranges;</span> |
| <span class="source-line-no">067</span><span id="line-67"> private final String string;</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> /**</span> |
| <span class="source-line-no">070</span><span id="line-70"> * Returns a parsed <c>Accept</c> header value.</span> |
| <span class="source-line-no">071</span><span id="line-71"> *</span> |
| <span class="source-line-no">072</span><span id="line-72"> * @param value The raw <c>Accept</c> header value.</span> |
| <span class="source-line-no">073</span><span id="line-73"> * @return A parsed <c>Accept</c> header value.</span> |
| <span class="source-line-no">074</span><span id="line-74"> */</span> |
| <span class="source-line-no">075</span><span id="line-75"> public static MediaRanges of(String value) {</span> |
| <span class="source-line-no">076</span><span id="line-76"> return isEmpty(value) ? EMPTY : CACHE.get(value, ()->new MediaRanges(value));</span> |
| <span class="source-line-no">077</span><span id="line-77"> }</span> |
| <span class="source-line-no">078</span><span id="line-78"></span> |
| <span class="source-line-no">079</span><span id="line-79"> //-----------------------------------------------------------------------------------------------------------------</span> |
| <span class="source-line-no">080</span><span id="line-80"> // Instance</span> |
| <span class="source-line-no">081</span><span id="line-81"> //-----------------------------------------------------------------------------------------------------------------</span> |
| <span class="source-line-no">082</span><span id="line-82"></span> |
| <span class="source-line-no">083</span><span id="line-83"> /**</span> |
| <span class="source-line-no">084</span><span id="line-84"> * Constructor.</span> |
| <span class="source-line-no">085</span><span id="line-85"> *</span> |
| <span class="source-line-no">086</span><span id="line-86"> * @param value The <c>Accept</c> header value.</span> |
| <span class="source-line-no">087</span><span id="line-87"> */</span> |
| <span class="source-line-no">088</span><span id="line-88"> public MediaRanges(String value) {</span> |
| <span class="source-line-no">089</span><span id="line-89"> this(parse(value));</span> |
| <span class="source-line-no">090</span><span id="line-90"> }</span> |
| <span class="source-line-no">091</span><span id="line-91"></span> |
| <span class="source-line-no">092</span><span id="line-92"> /**</span> |
| <span class="source-line-no">093</span><span id="line-93"> * Constructor.</span> |
| <span class="source-line-no">094</span><span id="line-94"> *</span> |
| <span class="source-line-no">095</span><span id="line-95"> * @param e The parsed header value.</span> |
| <span class="source-line-no">096</span><span id="line-96"> */</span> |
| <span class="source-line-no">097</span><span id="line-97"> public MediaRanges(HeaderElement[] e) {</span> |
| <span class="source-line-no">098</span><span id="line-98"></span> |
| <span class="source-line-no">099</span><span id="line-99"> ranges = new MediaRange[e.length];</span> |
| <span class="source-line-no">100</span><span id="line-100"> for (int i = 0; i < e.length; i++)</span> |
| <span class="source-line-no">101</span><span id="line-101"> ranges[i] = new MediaRange(e[i]);</span> |
| <span class="source-line-no">102</span><span id="line-102"> Arrays.sort(ranges, RANGE_COMPARATOR);</span> |
| <span class="source-line-no">103</span><span id="line-103"></span> |
| <span class="source-line-no">104</span><span id="line-104"> this.string = ranges.length == 1 ? ranges[0].toString() : StringUtils.join(ranges, ',');</span> |
| <span class="source-line-no">105</span><span id="line-105"> }</span> |
| <span class="source-line-no">106</span><span id="line-106"></span> |
| <span class="source-line-no">107</span><span id="line-107"> /**</span> |
| <span class="source-line-no">108</span><span id="line-108"> * Compares two MediaRanges for equality.</span> |
| <span class="source-line-no">109</span><span id="line-109"> *</span> |
| <span class="source-line-no">110</span><span id="line-110"> * <p></span> |
| <span class="source-line-no">111</span><span id="line-111"> * The values are first compared according to <c>qValue</c> values.</span> |
| <span class="source-line-no">112</span><span id="line-112"> * Should those values be equal, the <c>type</c> is then lexicographically compared (case-insensitive) in</span> |
| <span class="source-line-no">113</span><span id="line-113"> * ascending order, with the <js>"*"</js> type demoted last in that order.</span> |
| <span class="source-line-no">114</span><span id="line-114"> * <c>MediaRanges</c> with the same type but different sub-types are compared - a more specific subtype is</span> |
| <span class="source-line-no">115</span><span id="line-115"> * promoted over the 'wildcard' subtype.</span> |
| <span class="source-line-no">116</span><span id="line-116"> * <c>MediaRanges</c> with the same types but with extensions are promoted over those same types with no</span> |
| <span class="source-line-no">117</span><span id="line-117"> * extensions.</span> |
| <span class="source-line-no">118</span><span id="line-118"> */</span> |
| <span class="source-line-no">119</span><span id="line-119"> private static final Comparator<MediaRange> RANGE_COMPARATOR = new Comparator<>() {</span> |
| <span class="source-line-no">120</span><span id="line-120"> @Override</span> |
| <span class="source-line-no">121</span><span id="line-121"> public int compare(MediaRange o1, MediaRange o2) {</span> |
| <span class="source-line-no">122</span><span id="line-122"> // Compare q-values.</span> |
| <span class="source-line-no">123</span><span id="line-123"> int qCompare = Float.compare(o2.getQValue(), o1.getQValue());</span> |
| <span class="source-line-no">124</span><span id="line-124"> if (qCompare != 0)</span> |
| <span class="source-line-no">125</span><span id="line-125"> return qCompare;</span> |
| <span class="source-line-no">126</span><span id="line-126"></span> |
| <span class="source-line-no">127</span><span id="line-127"> // Compare media-types.</span> |
| <span class="source-line-no">128</span><span id="line-128"> // Note that '*' comes alphabetically before letters, so just do a reverse-alphabetical comparison.</span> |
| <span class="source-line-no">129</span><span id="line-129"> int i = o2.toString().compareTo(o1.toString());</span> |
| <span class="source-line-no">130</span><span id="line-130"> return i;</span> |
| <span class="source-line-no">131</span><span id="line-131"> }</span> |
| <span class="source-line-no">132</span><span id="line-132"> };</span> |
| <span class="source-line-no">133</span><span id="line-133"></span> |
| <span class="source-line-no">134</span><span id="line-134"> /**</span> |
| <span class="source-line-no">135</span><span id="line-135"> * Given a list of media types, returns the best match for this <c>Accept</c> header.</span> |
| <span class="source-line-no">136</span><span id="line-136"> *</span> |
| <span class="source-line-no">137</span><span id="line-137"> * <p></span> |
| <span class="source-line-no">138</span><span id="line-138"> * Note that fuzzy matching is allowed on the media types where the <c>Accept</c> header may</span> |
| <span class="source-line-no">139</span><span id="line-139"> * contain additional subtype parts.</span> |
| <span class="source-line-no">140</span><span id="line-140"> * <br>For example, given identical q-values and an <c>Accept</c> value of <js>"text/json+activity"</js>,</span> |
| <span class="source-line-no">141</span><span id="line-141"> * the media type <js>"text/json"</js> will match if <js>"text/json+activity"</js> or <js>"text/activity+json"</js></span> |
| <span class="source-line-no">142</span><span id="line-142"> * isn't found.</span> |
| <span class="source-line-no">143</span><span id="line-143"> * <br>The purpose for this is to allow serializers to match when artifacts such as <c>id</c> properties are</span> |
| <span class="source-line-no">144</span><span id="line-144"> * present in the header.</span> |
| <span class="source-line-no">145</span><span id="line-145"> *</span> |
| <span class="source-line-no">146</span><span id="line-146"> * <p></span> |
| <span class="source-line-no">147</span><span id="line-147"> * See <a class="doclink" href="https://www.w3.org/TR/activitypub/#retrieving-objects">ActivityPub / Retrieving Objects</a></span> |
| <span class="source-line-no">148</span><span id="line-148"> *</span> |
| <span class="source-line-no">149</span><span id="line-149"> * @param mediaTypes The media types to match against.</span> |
| <span class="source-line-no">150</span><span id="line-150"> * @return The index into the array of the best match, or <c>-1</c> if no suitable matches could be found.</span> |
| <span class="source-line-no">151</span><span id="line-151"> */</span> |
| <span class="source-line-no">152</span><span id="line-152"> public int match(List<? extends MediaType> mediaTypes) {</span> |
| <span class="source-line-no">153</span><span id="line-153"> if (string.isEmpty() || mediaTypes == null)</span> |
| <span class="source-line-no">154</span><span id="line-154"> return -1;</span> |
| <span class="source-line-no">155</span><span id="line-155"></span> |
| <span class="source-line-no">156</span><span id="line-156"> int matchQuant = 0, matchIndex = -1;</span> |
| <span class="source-line-no">157</span><span id="line-157"> float q = 0f;</span> |
| <span class="source-line-no">158</span><span id="line-158"></span> |
| <span class="source-line-no">159</span><span id="line-159"> // Media ranges are ordered by 'q'.</span> |
| <span class="source-line-no">160</span><span id="line-160"> // So we only need to search until we've found a match.</span> |
| <span class="source-line-no">161</span><span id="line-161"> for (MediaRange mr : ranges) {</span> |
| <span class="source-line-no">162</span><span id="line-162"> float q2 = mr.getQValue();</span> |
| <span class="source-line-no">163</span><span id="line-163"></span> |
| <span class="source-line-no">164</span><span id="line-164"> if (q2 < q || q2 == 0)</span> |
| <span class="source-line-no">165</span><span id="line-165"> break;</span> |
| <span class="source-line-no">166</span><span id="line-166"></span> |
| <span class="source-line-no">167</span><span id="line-167"> for (int i = 0; i < mediaTypes.size(); i++) {</span> |
| <span class="source-line-no">168</span><span id="line-168"> MediaType mt = mediaTypes.get(i);</span> |
| <span class="source-line-no">169</span><span id="line-169"> int matchQuant2 = mr.match(mt, false);</span> |
| <span class="source-line-no">170</span><span id="line-170"></span> |
| <span class="source-line-no">171</span><span id="line-171"> if (matchQuant2 > matchQuant) {</span> |
| <span class="source-line-no">172</span><span id="line-172"> matchIndex = i;</span> |
| <span class="source-line-no">173</span><span id="line-173"> matchQuant = matchQuant2;</span> |
| <span class="source-line-no">174</span><span id="line-174"> q = q2;</span> |
| <span class="source-line-no">175</span><span id="line-175"> }</span> |
| <span class="source-line-no">176</span><span id="line-176"> }</span> |
| <span class="source-line-no">177</span><span id="line-177"> }</span> |
| <span class="source-line-no">178</span><span id="line-178"></span> |
| <span class="source-line-no">179</span><span id="line-179"> return matchIndex;</span> |
| <span class="source-line-no">180</span><span id="line-180"> }</span> |
| <span class="source-line-no">181</span><span id="line-181"></span> |
| <span class="source-line-no">182</span><span id="line-182"> /**</span> |
| <span class="source-line-no">183</span><span id="line-183"> * Returns the {@link MediaRange} at the specified index.</span> |
| <span class="source-line-no">184</span><span id="line-184"> *</span> |
| <span class="source-line-no">185</span><span id="line-185"> * @param index The index position of the media range.</span> |
| <span class="source-line-no">186</span><span id="line-186"> * @return The {@link MediaRange} at the specified index or <jk>null</jk> if the index is out of range.</span> |
| <span class="source-line-no">187</span><span id="line-187"> */</span> |
| <span class="source-line-no">188</span><span id="line-188"> public MediaRange getRange(int index) {</span> |
| <span class="source-line-no">189</span><span id="line-189"> if (index < 0 || index >= ranges.length)</span> |
| <span class="source-line-no">190</span><span id="line-190"> return null;</span> |
| <span class="source-line-no">191</span><span id="line-191"> return ranges[index];</span> |
| <span class="source-line-no">192</span><span id="line-192"> }</span> |
| <span class="source-line-no">193</span><span id="line-193"></span> |
| <span class="source-line-no">194</span><span id="line-194"> /**</span> |
| <span class="source-line-no">195</span><span id="line-195"> * Convenience method for searching through all of the subtypes of all the media ranges in this header for the</span> |
| <span class="source-line-no">196</span><span id="line-196"> * presence of a subtype fragment.</span> |
| <span class="source-line-no">197</span><span id="line-197"> *</span> |
| <span class="source-line-no">198</span><span id="line-198"> * <p></span> |
| <span class="source-line-no">199</span><span id="line-199"> * For example, given the header <js>"text/json+activity"</js>, calling</span> |
| <span class="source-line-no">200</span><span id="line-200"> * <code>hasSubtypePart(<js>"activity"</js>)</code> returns <jk>true</jk>.</span> |
| <span class="source-line-no">201</span><span id="line-201"> *</span> |
| <span class="source-line-no">202</span><span id="line-202"> * @param part The media type subtype fragment.</span> |
| <span class="source-line-no">203</span><span id="line-203"> * @return <jk>true</jk> if subtype fragment exists.</span> |
| <span class="source-line-no">204</span><span id="line-204"> */</span> |
| <span class="source-line-no">205</span><span id="line-205"> public boolean hasSubtypePart(String part) {</span> |
| <span class="source-line-no">206</span><span id="line-206"></span> |
| <span class="source-line-no">207</span><span id="line-207"> for (MediaRange mr : ranges)</span> |
| <span class="source-line-no">208</span><span id="line-208"> if (mr.getQValue() > 0 && mr.getSubTypes().indexOf(part) >= 0)</span> |
| <span class="source-line-no">209</span><span id="line-209"> return true;</span> |
| <span class="source-line-no">210</span><span id="line-210"></span> |
| <span class="source-line-no">211</span><span id="line-211"> return false;</span> |
| <span class="source-line-no">212</span><span id="line-212"> }</span> |
| <span class="source-line-no">213</span><span id="line-213"></span> |
| <span class="source-line-no">214</span><span id="line-214"> /**</span> |
| <span class="source-line-no">215</span><span id="line-215"> * Returns the media ranges that make up this object.</span> |
| <span class="source-line-no">216</span><span id="line-216"> *</span> |
| <span class="source-line-no">217</span><span id="line-217"> * @return The media ranges that make up this object.</span> |
| <span class="source-line-no">218</span><span id="line-218"> */</span> |
| <span class="source-line-no">219</span><span id="line-219"> public List<MediaRange> toList() {</span> |
| <span class="source-line-no">220</span><span id="line-220"> return ulist(ranges);</span> |
| <span class="source-line-no">221</span><span id="line-221"> }</span> |
| <span class="source-line-no">222</span><span id="line-222"></span> |
| <span class="source-line-no">223</span><span id="line-223"> /**</span> |
| <span class="source-line-no">224</span><span id="line-224"> * Performs an action on the media ranges that make up this object.</span> |
| <span class="source-line-no">225</span><span id="line-225"> *</span> |
| <span class="source-line-no">226</span><span id="line-226"> * @param action The action to perform.</span> |
| <span class="source-line-no">227</span><span id="line-227"> * @return This object.</span> |
| <span class="source-line-no">228</span><span id="line-228"> */</span> |
| <span class="source-line-no">229</span><span id="line-229"> public MediaRanges forEachRange(Consumer<MediaRange> action) {</span> |
| <span class="source-line-no">230</span><span id="line-230"> for (MediaRange r : ranges)</span> |
| <span class="source-line-no">231</span><span id="line-231"> action.accept(r);</span> |
| <span class="source-line-no">232</span><span id="line-232"> return this;</span> |
| <span class="source-line-no">233</span><span id="line-233"> }</span> |
| <span class="source-line-no">234</span><span id="line-234"></span> |
| <span class="source-line-no">235</span><span id="line-235"> private static HeaderElement[] parse(String value) {</span> |
| <span class="source-line-no">236</span><span id="line-236"> return BasicHeaderValueParser.parseElements(emptyIfNull(trim(value)), null);</span> |
| <span class="source-line-no">237</span><span id="line-237"> }</span> |
| <span class="source-line-no">238</span><span id="line-238"></span> |
| <span class="source-line-no">239</span><span id="line-239"> @Override /* Object */</span> |
| <span class="source-line-no">240</span><span id="line-240"> public String toString() {</span> |
| <span class="source-line-no">241</span><span id="line-241"> return string;</span> |
| <span class="source-line-no">242</span><span id="line-242"> }</span> |
| <span class="source-line-no">243</span><span id="line-243">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
