001/* 002 * Copyright (C) 2011 The Guava Authors 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except 005 * in compliance with the License. You may obtain a copy of the License at 006 * 007 * http://www.apache.org/licenses/LICENSE-2.0 008 * 009 * Unless required by applicable law or agreed to in writing, software distributed under the License 010 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express 011 * or implied. See the License for the specific language governing permissions and limitations under 012 * the License. 013 */ 014 015package com.google.common.net; 016 017import static com.google.common.base.CharMatcher.ascii; 018import static com.google.common.base.CharMatcher.javaIsoControl; 019import static com.google.common.base.Charsets.UTF_8; 020import static com.google.common.base.Preconditions.checkArgument; 021import static com.google.common.base.Preconditions.checkNotNull; 022import static com.google.common.base.Preconditions.checkState; 023 024import com.google.common.annotations.Beta; 025import com.google.common.annotations.GwtCompatible; 026import com.google.common.base.Ascii; 027import com.google.common.base.CharMatcher; 028import com.google.common.base.Function; 029import com.google.common.base.Joiner; 030import com.google.common.base.Joiner.MapJoiner; 031import com.google.common.base.MoreObjects; 032import com.google.common.base.Objects; 033import com.google.common.base.Optional; 034import com.google.common.collect.ImmutableListMultimap; 035import com.google.common.collect.ImmutableMultiset; 036import com.google.common.collect.ImmutableSet; 037import com.google.common.collect.Maps; 038import com.google.common.collect.Multimap; 039import com.google.common.collect.Multimaps; 040import com.google.errorprone.annotations.Immutable; 041import com.google.errorprone.annotations.concurrent.LazyInit; 042import java.nio.charset.Charset; 043import java.nio.charset.IllegalCharsetNameException; 044import java.nio.charset.UnsupportedCharsetException; 045import java.util.Collection; 046import java.util.Map; 047import java.util.Map.Entry; 048import org.checkerframework.checker.nullness.qual.Nullable; 049 050/** 051 * Represents an <a href="http://en.wikipedia.org/wiki/Internet_media_type">Internet Media Type</a> 052 * (also known as a MIME Type or Content Type). This class also supports the concept of media ranges 053 * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">defined by HTTP/1.1</a>. 054 * As such, the {@code *} character is treated as a wildcard and is used to represent any acceptable 055 * type or subtype value. A media type may not have wildcard type with a declared subtype. The 056 * {@code *} character has no special meaning as part of a parameter. All values for type, subtype, 057 * parameter attributes or parameter values must be valid according to RFCs <a 058 * href="http://www.ietf.org/rfc/rfc2045.txt">2045</a> and <a 059 * href="http://www.ietf.org/rfc/rfc2046.txt">2046</a>. 060 * 061 * <p>All portions of the media type that are case-insensitive (type, subtype, parameter attributes) 062 * are normalized to lowercase. The value of the {@code charset} parameter is normalized to 063 * lowercase, but all others are left as-is. 064 * 065 * <p>Note that this specifically does <strong>not</strong> represent the value of the MIME {@code 066 * Content-Type} header and as such has no support for header-specific considerations such as line 067 * folding and comments. 068 * 069 * <p>For media types that take a charset the predefined constants default to UTF-8 and have a 070 * "_UTF_8" suffix. To get a version without a character set, use {@link #withoutParameters}. 071 * 072 * @since 12.0 073 * @author Gregory Kick 074 */ 075@Beta 076@GwtCompatible 077@Immutable 078public final class MediaType { 079 private static final String CHARSET_ATTRIBUTE = "charset"; 080 private static final ImmutableListMultimap<String, String> UTF_8_CONSTANT_PARAMETERS = 081 ImmutableListMultimap.of(CHARSET_ATTRIBUTE, Ascii.toLowerCase(UTF_8.name())); 082 083 /** Matcher for type, subtype and attributes. */ 084 private static final CharMatcher TOKEN_MATCHER = 085 ascii() 086 .and(javaIsoControl().negate()) 087 .and(CharMatcher.isNot(' ')) 088 .and(CharMatcher.noneOf("()<>@,;:\\\"/[]?=")); 089 090 private static final CharMatcher QUOTED_TEXT_MATCHER = ascii().and(CharMatcher.noneOf("\"\\\r")); 091 092 /* 093 * This matches the same characters as linear-white-space from RFC 822, but we make no effort to 094 * enforce any particular rules with regards to line folding as stated in the class docs. 095 */ 096 private static final CharMatcher LINEAR_WHITE_SPACE = CharMatcher.anyOf(" \t\r\n"); 097 098 // TODO(gak): make these public? 099 private static final String APPLICATION_TYPE = "application"; 100 private static final String AUDIO_TYPE = "audio"; 101 private static final String IMAGE_TYPE = "image"; 102 private static final String TEXT_TYPE = "text"; 103 private static final String VIDEO_TYPE = "video"; 104 105 private static final String WILDCARD = "*"; 106 107 private static final Map<MediaType, MediaType> KNOWN_TYPES = Maps.newHashMap(); 108 109 private static MediaType createConstant(String type, String subtype) { 110 MediaType mediaType = 111 addKnownType(new MediaType(type, subtype, ImmutableListMultimap.<String, String>of())); 112 mediaType.parsedCharset = Optional.absent(); 113 return mediaType; 114 } 115 116 private static MediaType createConstantUtf8(String type, String subtype) { 117 MediaType mediaType = addKnownType(new MediaType(type, subtype, UTF_8_CONSTANT_PARAMETERS)); 118 mediaType.parsedCharset = Optional.of(UTF_8); 119 return mediaType; 120 } 121 122 private static MediaType addKnownType(MediaType mediaType) { 123 KNOWN_TYPES.put(mediaType, mediaType); 124 return mediaType; 125 } 126 127 /* 128 * The following constants are grouped by their type and ordered alphabetically by the constant 129 * name within that type. The constant name should be a sensible identifier that is closest to the 130 * "common name" of the media. This is often, but not necessarily the same as the subtype. 131 * 132 * Be sure to declare all constants with the type and subtype in all lowercase. For types that 133 * take a charset (e.g. all text/* types), default to UTF-8 and suffix the constant name with 134 * "_UTF_8". 135 */ 136 137 public static final MediaType ANY_TYPE = createConstant(WILDCARD, WILDCARD); 138 public static final MediaType ANY_TEXT_TYPE = createConstant(TEXT_TYPE, WILDCARD); 139 public static final MediaType ANY_IMAGE_TYPE = createConstant(IMAGE_TYPE, WILDCARD); 140 public static final MediaType ANY_AUDIO_TYPE = createConstant(AUDIO_TYPE, WILDCARD); 141 public static final MediaType ANY_VIDEO_TYPE = createConstant(VIDEO_TYPE, WILDCARD); 142 public static final MediaType ANY_APPLICATION_TYPE = createConstant(APPLICATION_TYPE, WILDCARD); 143 144 /* text types */ 145 public static final MediaType CACHE_MANIFEST_UTF_8 = 146 createConstantUtf8(TEXT_TYPE, "cache-manifest"); 147 public static final MediaType CSS_UTF_8 = createConstantUtf8(TEXT_TYPE, "css"); 148 public static final MediaType CSV_UTF_8 = createConstantUtf8(TEXT_TYPE, "csv"); 149 public static final MediaType HTML_UTF_8 = createConstantUtf8(TEXT_TYPE, "html"); 150 public static final MediaType I_CALENDAR_UTF_8 = createConstantUtf8(TEXT_TYPE, "calendar"); 151 public static final MediaType PLAIN_TEXT_UTF_8 = createConstantUtf8(TEXT_TYPE, "plain"); 152 153 /** 154 * <a href="http://www.rfc-editor.org/rfc/rfc4329.txt">RFC 4329</a> declares {@link 155 * #JAVASCRIPT_UTF_8 application/javascript} to be the correct media type for JavaScript, but this 156 * may be necessary in certain situations for compatibility. 157 */ 158 public static final MediaType TEXT_JAVASCRIPT_UTF_8 = createConstantUtf8(TEXT_TYPE, "javascript"); 159 /** 160 * <a href="http://www.iana.org/assignments/media-types/text/tab-separated-values">Tab separated 161 * values</a>. 162 * 163 * @since 15.0 164 */ 165 public static final MediaType TSV_UTF_8 = createConstantUtf8(TEXT_TYPE, "tab-separated-values"); 166 167 public static final MediaType VCARD_UTF_8 = createConstantUtf8(TEXT_TYPE, "vcard"); 168 169 /** 170 * UTF-8 encoded <a href="https://en.wikipedia.org/wiki/Wireless_Markup_Language">Wireless Markup 171 * Language</a>. 172 * 173 * @since 13.0 174 */ 175 public static final MediaType WML_UTF_8 = createConstantUtf8(TEXT_TYPE, "vnd.wap.wml"); 176 177 /** 178 * As described in <a href="http://www.ietf.org/rfc/rfc3023.txt">RFC 3023</a>, this constant 179 * ({@code text/xml}) is used for XML documents that are "readable by casual users." {@link 180 * #APPLICATION_XML_UTF_8} is provided for documents that are intended for applications. 181 */ 182 public static final MediaType XML_UTF_8 = createConstantUtf8(TEXT_TYPE, "xml"); 183 184 /** 185 * As described in <a href="https://w3c.github.io/webvtt/#iana-text-vtt">the VTT spec</a>, this is 186 * used for Web Video Text Tracks (WebVTT) files, used with the HTML5 track element. 187 * 188 * @since 20.0 189 */ 190 public static final MediaType VTT_UTF_8 = createConstantUtf8(TEXT_TYPE, "vtt"); 191 192 /** 193 * <a href="https://en.wikipedia.org/wiki/BMP_file_format">Bitmap file format</a> ({@code bmp} 194 * files). 195 * 196 * @since 13.0 197 */ 198 public static final MediaType BMP = createConstant(IMAGE_TYPE, "bmp"); 199 200 /** 201 * The <a href="https://en.wikipedia.org/wiki/Camera_Image_File_Format">Canon Image File 202 * Format</a> ({@code crw} files), a widely-used "raw image" format for cameras. It is found in 203 * {@code /etc/mime.types}, e.g. in <a href= 204 * "http://anonscm.debian.org/gitweb/?p=collab-maint/mime-support.git;a=blob;f=mime.types;hb=HEAD" 205 * >Debian 3.48-1</a>. 206 * 207 * @since 15.0 208 */ 209 public static final MediaType CRW = createConstant(IMAGE_TYPE, "x-canon-crw"); 210 211 public static final MediaType GIF = createConstant(IMAGE_TYPE, "gif"); 212 public static final MediaType ICO = createConstant(IMAGE_TYPE, "vnd.microsoft.icon"); 213 public static final MediaType JPEG = createConstant(IMAGE_TYPE, "jpeg"); 214 public static final MediaType PNG = createConstant(IMAGE_TYPE, "png"); 215 216 /** 217 * The Photoshop File Format ({@code psd} files) as defined by <a 218 * href="http://www.iana.org/assignments/media-types/image/vnd.adobe.photoshop">IANA</a>, and 219 * found in {@code /etc/mime.types}, e.g. <a 220 * href="http://svn.apache.org/repos/asf/httpd/httpd/branches/1.3.x/conf/mime.types"></a> of the 221 * Apache <a href="http://httpd.apache.org/">HTTPD project</a>; for the specification, see <a 222 * href="http://www.adobe.com/devnet-apps/photoshop/fileformatashtml/PhotoshopFileFormats.htm"> 223 * Adobe Photoshop Document Format</a> and <a 224 * href="http://en.wikipedia.org/wiki/Adobe_Photoshop#File_format">Wikipedia</a>; this is the 225 * regular output/input of Photoshop (which can also export to various image formats; note that 226 * files with extension "PSB" are in a distinct but related format). 227 * 228 * <p>This is a more recent replacement for the older, experimental type {@code x-photoshop}: <a 229 * href="http://tools.ietf.org/html/rfc2046#section-6">RFC-2046.6</a>. 230 * 231 * @since 15.0 232 */ 233 public static final MediaType PSD = createConstant(IMAGE_TYPE, "vnd.adobe.photoshop"); 234 235 public static final MediaType SVG_UTF_8 = createConstantUtf8(IMAGE_TYPE, "svg+xml"); 236 public static final MediaType TIFF = createConstant(IMAGE_TYPE, "tiff"); 237 238 /** 239 * <a href="https://en.wikipedia.org/wiki/WebP">WebP image format</a>. 240 * 241 * @since 13.0 242 */ 243 public static final MediaType WEBP = createConstant(IMAGE_TYPE, "webp"); 244 245 /* audio types */ 246 public static final MediaType MP4_AUDIO = createConstant(AUDIO_TYPE, "mp4"); 247 public static final MediaType MPEG_AUDIO = createConstant(AUDIO_TYPE, "mpeg"); 248 public static final MediaType OGG_AUDIO = createConstant(AUDIO_TYPE, "ogg"); 249 public static final MediaType WEBM_AUDIO = createConstant(AUDIO_TYPE, "webm"); 250 251 /** 252 * L16 audio, as defined by <a href="https://tools.ietf.org/html/rfc2586">RFC 2586</a>. 253 * 254 * @since 24.1 255 */ 256 public static final MediaType L16_AUDIO = createConstant(AUDIO_TYPE, "l16"); 257 258 /** 259 * L24 audio, as defined by <a href="https://tools.ietf.org/html/rfc3190">RFC 3190</a>. 260 * 261 * @since 20.0 262 */ 263 public static final MediaType L24_AUDIO = createConstant(AUDIO_TYPE, "l24"); 264 265 /** 266 * Basic Audio, as defined by <a href="http://tools.ietf.org/html/rfc2046#section-4.3">RFC 267 * 2046</a>. 268 * 269 * @since 20.0 270 */ 271 public static final MediaType BASIC_AUDIO = createConstant(AUDIO_TYPE, "basic"); 272 273 /** 274 * Advanced Audio Coding. For more information, see <a 275 * href="https://en.wikipedia.org/wiki/Advanced_Audio_Coding">Advanced Audio Coding</a>. 276 * 277 * @since 20.0 278 */ 279 public static final MediaType AAC_AUDIO = createConstant(AUDIO_TYPE, "aac"); 280 281 /** 282 * Vorbis Audio, as defined by <a href="http://tools.ietf.org/html/rfc5215">RFC 5215</a>. 283 * 284 * @since 20.0 285 */ 286 public static final MediaType VORBIS_AUDIO = createConstant(AUDIO_TYPE, "vorbis"); 287 288 /** 289 * Windows Media Audio. For more information, see <a 290 * href="https://msdn.microsoft.com/en-us/library/windows/desktop/dd562994(v=vs.85).aspx">file 291 * name extensions for Windows Media metafiles</a>. 292 * 293 * @since 20.0 294 */ 295 public static final MediaType WMA_AUDIO = createConstant(AUDIO_TYPE, "x-ms-wma"); 296 297 /** 298 * Windows Media metafiles. For more information, see <a 299 * href="https://msdn.microsoft.com/en-us/library/windows/desktop/dd562994(v=vs.85).aspx">file 300 * name extensions for Windows Media metafiles</a>. 301 * 302 * @since 20.0 303 */ 304 public static final MediaType WAX_AUDIO = createConstant(AUDIO_TYPE, "x-ms-wax"); 305 306 /** 307 * Real Audio. For more information, see <a 308 * href="http://service.real.com/help/faq/rp8/configrp8win.html">this link</a>. 309 * 310 * @since 20.0 311 */ 312 public static final MediaType VND_REAL_AUDIO = createConstant(AUDIO_TYPE, "vnd.rn-realaudio"); 313 314 /** 315 * WAVE format, as defined by <a href="https://tools.ietf.org/html/rfc2361">RFC 2361</a>. 316 * 317 * @since 20.0 318 */ 319 public static final MediaType VND_WAVE_AUDIO = createConstant(AUDIO_TYPE, "vnd.wave"); 320 321 /* video types */ 322 public static final MediaType MP4_VIDEO = createConstant(VIDEO_TYPE, "mp4"); 323 public static final MediaType MPEG_VIDEO = createConstant(VIDEO_TYPE, "mpeg"); 324 public static final MediaType OGG_VIDEO = createConstant(VIDEO_TYPE, "ogg"); 325 public static final MediaType QUICKTIME = createConstant(VIDEO_TYPE, "quicktime"); 326 public static final MediaType WEBM_VIDEO = createConstant(VIDEO_TYPE, "webm"); 327 public static final MediaType WMV = createConstant(VIDEO_TYPE, "x-ms-wmv"); 328 329 /** 330 * Flash video. For more information, see <a href= 331 * "http://help.adobe.com/en_US/ActionScript/3.0_ProgrammingAS3/WS5b3ccc516d4fbf351e63e3d118a9b90204-7d48.html" 332 * >this link</a>. 333 * 334 * @since 20.0 335 */ 336 public static final MediaType FLV_VIDEO = createConstant(VIDEO_TYPE, "x-flv"); 337 338 /** 339 * The 3GP multimedia container format. For more information, see <a 340 * href="ftp://www.3gpp.org/tsg_sa/TSG_SA/TSGS_23/Docs/PDF/SP-040065.pdf#page=10">3GPP TS 341 * 26.244</a>. 342 * 343 * @since 20.0 344 */ 345 public static final MediaType THREE_GPP_VIDEO = createConstant(VIDEO_TYPE, "3gpp"); 346 347 /** 348 * The 3G2 multimedia container format. For more information, see <a 349 * href="http://www.3gpp2.org/Public_html/specs/C.S0050-B_v1.0_070521.pdf#page=16">3GPP2 350 * C.S0050-B</a>. 351 * 352 * @since 20.0 353 */ 354 public static final MediaType THREE_GPP2_VIDEO = createConstant(VIDEO_TYPE, "3gpp2"); 355 356 /* application types */ 357 /** 358 * As described in <a href="http://www.ietf.org/rfc/rfc3023.txt">RFC 3023</a>, this constant 359 * ({@code application/xml}) is used for XML documents that are "unreadable by casual users." 360 * {@link #XML_UTF_8} is provided for documents that may be read by users. 361 * 362 * @since 14.0 363 */ 364 public static final MediaType APPLICATION_XML_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "xml"); 365 366 public static final MediaType ATOM_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "atom+xml"); 367 public static final MediaType BZIP2 = createConstant(APPLICATION_TYPE, "x-bzip2"); 368 369 /** 370 * Files in the <a href="https://www.dartlang.org/articles/embedding-in-html/">dart</a> 371 * programming language. 372 * 373 * @since 19.0 374 */ 375 public static final MediaType DART_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "dart"); 376 377 /** 378 * <a href="https://goo.gl/2QoMvg">Apple Passbook</a>. 379 * 380 * @since 19.0 381 */ 382 public static final MediaType APPLE_PASSBOOK = 383 createConstant(APPLICATION_TYPE, "vnd.apple.pkpass"); 384 385 /** 386 * <a href="http://en.wikipedia.org/wiki/Embedded_OpenType">Embedded OpenType</a> fonts. This is 387 * <a href="http://www.iana.org/assignments/media-types/application/vnd.ms-fontobject">registered 388 * </a> with the IANA. 389 * 390 * @since 17.0 391 */ 392 public static final MediaType EOT = createConstant(APPLICATION_TYPE, "vnd.ms-fontobject"); 393 394 /** 395 * As described in the <a href="http://idpf.org/epub">International Digital Publishing Forum</a> 396 * EPUB is the distribution and interchange format standard for digital publications and 397 * documents. This media type is defined in the <a 398 * href="http://www.idpf.org/epub/30/spec/epub30-ocf.html">EPUB Open Container Format</a> 399 * specification. 400 * 401 * @since 15.0 402 */ 403 public static final MediaType EPUB = createConstant(APPLICATION_TYPE, "epub+zip"); 404 405 public static final MediaType FORM_DATA = 406 createConstant(APPLICATION_TYPE, "x-www-form-urlencoded"); 407 408 /** 409 * As described in <a href="https://www.rsa.com/rsalabs/node.asp?id=2138">PKCS #12: Personal 410 * Information Exchange Syntax Standard</a>, PKCS #12 defines an archive file format for storing 411 * many cryptography objects as a single file. 412 * 413 * @since 15.0 414 */ 415 public static final MediaType KEY_ARCHIVE = createConstant(APPLICATION_TYPE, "pkcs12"); 416 417 /** 418 * This is a non-standard media type, but is commonly used in serving hosted binary files as it is 419 * <a href="http://code.google.com/p/browsersec/wiki/Part2#Survey_of_content_sniffing_behaviors"> 420 * known not to trigger content sniffing in current browsers</a>. It <i>should not</i> be used in 421 * other situations as it is not specified by any RFC and does not appear in the <a 422 * href="http://www.iana.org/assignments/media-types">/IANA MIME Media Types</a> list. Consider 423 * {@link #OCTET_STREAM} for binary data that is not being served to a browser. 424 * 425 * @since 14.0 426 */ 427 public static final MediaType APPLICATION_BINARY = createConstant(APPLICATION_TYPE, "binary"); 428 429 /** 430 * Media type for the <a href="https://tools.ietf.org/html/rfc7946">GeoJSON Format</a>, a 431 * geospatial data interchange format based on JSON. 432 * 433 * @since 28.0 434 */ 435 public static final MediaType GEO_JSON = createConstant(APPLICATION_TYPE, "geo+json"); 436 437 public static final MediaType GZIP = createConstant(APPLICATION_TYPE, "x-gzip"); 438 439 /** 440 * <a href="https://tools.ietf.org/html/draft-kelly-json-hal-08#section-3">JSON Hypertext 441 * Application Language (HAL) documents</a>. 442 * 443 * @since 26.0 444 */ 445 public static final MediaType HAL_JSON = createConstant(APPLICATION_TYPE, "hal+json"); 446 447 /** 448 * <a href="http://www.rfc-editor.org/rfc/rfc4329.txt">RFC 4329</a> declares this to be the 449 * correct media type for JavaScript, but {@link #TEXT_JAVASCRIPT_UTF_8 text/javascript} may be 450 * necessary in certain situations for compatibility. 451 */ 452 public static final MediaType JAVASCRIPT_UTF_8 = 453 createConstantUtf8(APPLICATION_TYPE, "javascript"); 454 455 /** 456 * For <a href="https://tools.ietf.org/html/rfc7515">JWS or JWE objects using the Compact 457 * Serialization</a>. 458 * 459 * @since 27.1 460 */ 461 public static final MediaType JOSE = createConstant(APPLICATION_TYPE, "jose"); 462 463 /** 464 * For <a href="https://tools.ietf.org/html/rfc7515">JWS or JWE objects using the JSON 465 * Serialization</a>. 466 * 467 * @since 27.1 468 */ 469 public static final MediaType JOSE_JSON = createConstant(APPLICATION_TYPE, "jose+json"); 470 471 public static final MediaType JSON_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "json"); 472 473 /** 474 * The <a href="http://www.w3.org/TR/appmanifest/">Manifest for a web application</a>. 475 * 476 * @since 19.0 477 */ 478 public static final MediaType MANIFEST_JSON_UTF_8 = 479 createConstantUtf8(APPLICATION_TYPE, "manifest+json"); 480 481 /** 482 * <a href="http://www.opengeospatial.org/standards/kml/">OGC KML (Keyhole Markup Language)</a>. 483 */ 484 public static final MediaType KML = createConstant(APPLICATION_TYPE, "vnd.google-earth.kml+xml"); 485 486 /** 487 * <a href="http://www.opengeospatial.org/standards/kml/">OGC KML (Keyhole Markup Language)</a>, 488 * compressed using the ZIP format into KMZ archives. 489 */ 490 public static final MediaType KMZ = createConstant(APPLICATION_TYPE, "vnd.google-earth.kmz"); 491 492 /** 493 * The <a href="https://tools.ietf.org/html/rfc4155">mbox database format</a>. 494 * 495 * @since 13.0 496 */ 497 public static final MediaType MBOX = createConstant(APPLICATION_TYPE, "mbox"); 498 499 /** 500 * <a href="http://goo.gl/1pGBFm">Apple over-the-air mobile configuration profiles</a>. 501 * 502 * @since 18.0 503 */ 504 public static final MediaType APPLE_MOBILE_CONFIG = 505 createConstant(APPLICATION_TYPE, "x-apple-aspen-config"); 506 507 /** <a href="http://goo.gl/XDQ1h2">Microsoft Excel</a> spreadsheets. */ 508 public static final MediaType MICROSOFT_EXCEL = createConstant(APPLICATION_TYPE, "vnd.ms-excel"); 509 510 /** 511 * <a href="http://goo.gl/XrTEqG">Microsoft Outlook</a> items. 512 * 513 * @since 27.1 514 */ 515 public static final MediaType MICROSOFT_OUTLOOK = 516 createConstant(APPLICATION_TYPE, "vnd.ms-outlook"); 517 518 /** <a href="http://goo.gl/XDQ1h2">Microsoft Powerpoint</a> presentations. */ 519 public static final MediaType MICROSOFT_POWERPOINT = 520 createConstant(APPLICATION_TYPE, "vnd.ms-powerpoint"); 521 522 /** <a href="http://goo.gl/XDQ1h2">Microsoft Word</a> documents. */ 523 public static final MediaType MICROSOFT_WORD = createConstant(APPLICATION_TYPE, "msword"); 524 525 /** 526 * WASM applications. For more information see <a href="https://webassembly.org/">the Web Assembly 527 * overview</a>. 528 * 529 * @since 27.0 530 */ 531 public static final MediaType WASM_APPLICATION = createConstant(APPLICATION_TYPE, "wasm"); 532 533 /** 534 * NaCl applications. For more information see <a 535 * href="https://developer.chrome.com/native-client/devguide/coding/application-structure">the 536 * Developer Guide for Native Client Application Structure</a>. 537 * 538 * @since 20.0 539 */ 540 public static final MediaType NACL_APPLICATION = createConstant(APPLICATION_TYPE, "x-nacl"); 541 542 /** 543 * NaCl portable applications. For more information see <a 544 * href="https://developer.chrome.com/native-client/devguide/coding/application-structure">the 545 * Developer Guide for Native Client Application Structure</a>. 546 * 547 * @since 20.0 548 */ 549 public static final MediaType NACL_PORTABLE_APPLICATION = 550 createConstant(APPLICATION_TYPE, "x-pnacl"); 551 552 public static final MediaType OCTET_STREAM = createConstant(APPLICATION_TYPE, "octet-stream"); 553 554 public static final MediaType OGG_CONTAINER = createConstant(APPLICATION_TYPE, "ogg"); 555 public static final MediaType OOXML_DOCUMENT = 556 createConstant( 557 APPLICATION_TYPE, "vnd.openxmlformats-officedocument.wordprocessingml.document"); 558 public static final MediaType OOXML_PRESENTATION = 559 createConstant( 560 APPLICATION_TYPE, "vnd.openxmlformats-officedocument.presentationml.presentation"); 561 public static final MediaType OOXML_SHEET = 562 createConstant(APPLICATION_TYPE, "vnd.openxmlformats-officedocument.spreadsheetml.sheet"); 563 public static final MediaType OPENDOCUMENT_GRAPHICS = 564 createConstant(APPLICATION_TYPE, "vnd.oasis.opendocument.graphics"); 565 public static final MediaType OPENDOCUMENT_PRESENTATION = 566 createConstant(APPLICATION_TYPE, "vnd.oasis.opendocument.presentation"); 567 public static final MediaType OPENDOCUMENT_SPREADSHEET = 568 createConstant(APPLICATION_TYPE, "vnd.oasis.opendocument.spreadsheet"); 569 public static final MediaType OPENDOCUMENT_TEXT = 570 createConstant(APPLICATION_TYPE, "vnd.oasis.opendocument.text"); 571 public static final MediaType PDF = createConstant(APPLICATION_TYPE, "pdf"); 572 public static final MediaType POSTSCRIPT = createConstant(APPLICATION_TYPE, "postscript"); 573 574 /** 575 * <a href="http://tools.ietf.org/html/draft-rfernando-protocol-buffers-00">Protocol buffers</a> 576 * 577 * @since 15.0 578 */ 579 public static final MediaType PROTOBUF = createConstant(APPLICATION_TYPE, "protobuf"); 580 581 /** 582 * <a href="https://en.wikipedia.org/wiki/RDF/XML">RDF/XML</a> documents, which are XML 583 * serializations of <a 584 * href="https://en.wikipedia.org/wiki/Resource_Description_Framework">Resource Description 585 * Framework</a> graphs. 586 * 587 * @since 14.0 588 */ 589 public static final MediaType RDF_XML_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "rdf+xml"); 590 591 public static final MediaType RTF_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "rtf"); 592 593 /** 594 * SFNT fonts (which includes <a href="http://en.wikipedia.org/wiki/TrueType/">TrueType</a> and <a 595 * href="http://en.wikipedia.org/wiki/OpenType/">OpenType</a> fonts). This is <a 596 * href="http://www.iana.org/assignments/media-types/application/font-sfnt">registered</a> with 597 * the IANA. 598 * 599 * @since 17.0 600 */ 601 public static final MediaType SFNT = createConstant(APPLICATION_TYPE, "font-sfnt"); 602 603 public static final MediaType SHOCKWAVE_FLASH = 604 createConstant(APPLICATION_TYPE, "x-shockwave-flash"); 605 606 /** 607 * {@code skp} files produced by the 3D Modeling software <a 608 * href="https://www.sketchup.com/">SketchUp</a> 609 * 610 * @since 13.0 611 */ 612 public static final MediaType SKETCHUP = createConstant(APPLICATION_TYPE, "vnd.sketchup.skp"); 613 614 /** 615 * As described in <a href="http://www.ietf.org/rfc/rfc3902.txt">RFC 3902</a>, this constant 616 * ({@code application/soap+xml}) is used to identify SOAP 1.2 message envelopes that have been 617 * serialized with XML 1.0. 618 * 619 * <p>For SOAP 1.1 messages, see {@code XML_UTF_8} per <a 620 * href="http://www.w3.org/TR/2000/NOTE-SOAP-20000508/">W3C Note on Simple Object Access Protocol 621 * (SOAP) 1.1</a> 622 * 623 * @since 20.0 624 */ 625 public static final MediaType SOAP_XML_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "soap+xml"); 626 627 public static final MediaType TAR = createConstant(APPLICATION_TYPE, "x-tar"); 628 629 /** 630 * <a href="http://en.wikipedia.org/wiki/Web_Open_Font_Format">Web Open Font Format</a> (WOFF) <a 631 * href="http://www.w3.org/TR/WOFF/">defined</a> by the W3C. This is <a 632 * href="http://www.iana.org/assignments/media-types/application/font-woff">registered</a> with 633 * the IANA. 634 * 635 * @since 17.0 636 */ 637 public static final MediaType WOFF = createConstant(APPLICATION_TYPE, "font-woff"); 638 639 /** 640 * <a href="http://en.wikipedia.org/wiki/Web_Open_Font_Format">Web Open Font Format</a> (WOFF) 641 * version 2 <a href="https://www.w3.org/TR/WOFF2/">defined</a> by the W3C. 642 * 643 * @since 20.0 644 */ 645 public static final MediaType WOFF2 = createConstant(APPLICATION_TYPE, "font-woff2"); 646 647 public static final MediaType XHTML_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "xhtml+xml"); 648 649 /** 650 * Extensible Resource Descriptors. This is not yet registered with the IANA, but it is specified 651 * by OASIS in the <a href="http://docs.oasis-open.org/xri/xrd/v1.0/cd02/xrd-1.0-cd02.html">XRD 652 * definition</a> and implemented in projects such as <a 653 * href="http://code.google.com/p/webfinger/">WebFinger</a>. 654 * 655 * @since 14.0 656 */ 657 public static final MediaType XRD_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "xrd+xml"); 658 659 public static final MediaType ZIP = createConstant(APPLICATION_TYPE, "zip"); 660 661 private final String type; 662 private final String subtype; 663 private final ImmutableListMultimap<String, String> parameters; 664 665 @LazyInit private String toString; 666 667 @LazyInit private int hashCode; 668 669 @LazyInit private Optional<Charset> parsedCharset; 670 671 private MediaType(String type, String subtype, ImmutableListMultimap<String, String> parameters) { 672 this.type = type; 673 this.subtype = subtype; 674 this.parameters = parameters; 675 } 676 677 /** Returns the top-level media type. For example, {@code "text"} in {@code "text/plain"}. */ 678 public String type() { 679 return type; 680 } 681 682 /** Returns the media subtype. For example, {@code "plain"} in {@code "text/plain"}. */ 683 public String subtype() { 684 return subtype; 685 } 686 687 /** Returns a multimap containing the parameters of this media type. */ 688 public ImmutableListMultimap<String, String> parameters() { 689 return parameters; 690 } 691 692 private Map<String, ImmutableMultiset<String>> parametersAsMap() { 693 return Maps.transformValues( 694 parameters.asMap(), 695 new Function<Collection<String>, ImmutableMultiset<String>>() { 696 @Override 697 public ImmutableMultiset<String> apply(Collection<String> input) { 698 return ImmutableMultiset.copyOf(input); 699 } 700 }); 701 } 702 703 /** 704 * Returns an optional charset for the value of the charset parameter if it is specified. 705 * 706 * @throws IllegalStateException if multiple charset values have been set for this media type 707 * @throws IllegalCharsetNameException if a charset value is present, but illegal 708 * @throws UnsupportedCharsetException if a charset value is present, but no support is available 709 * in this instance of the Java virtual machine 710 */ 711 public Optional<Charset> charset() { 712 // racy single-check idiom, this is safe because Optional is immutable. 713 Optional<Charset> local = parsedCharset; 714 if (local == null) { 715 String value = null; 716 local = Optional.absent(); 717 for (String currentValue : parameters.get(CHARSET_ATTRIBUTE)) { 718 if (value == null) { 719 value = currentValue; 720 local = Optional.of(Charset.forName(value)); 721 } else if (!value.equals(currentValue)) { 722 throw new IllegalStateException( 723 "Multiple charset values defined: " + value + ", " + currentValue); 724 } 725 } 726 parsedCharset = local; 727 } 728 return local; 729 } 730 731 /** 732 * Returns a new instance with the same type and subtype as this instance, but without any 733 * parameters. 734 */ 735 public MediaType withoutParameters() { 736 return parameters.isEmpty() ? this : create(type, subtype); 737 } 738 739 /** 740 * <em>Replaces</em> all parameters with the given parameters. 741 * 742 * @throws IllegalArgumentException if any parameter or value is invalid 743 */ 744 public MediaType withParameters(Multimap<String, String> parameters) { 745 return create(type, subtype, parameters); 746 } 747 748 /** 749 * <em>Replaces</em> all parameters with the given attribute with parameters using the given 750 * values. If there are no values, any existing parameters with the given attribute are removed. 751 * 752 * @throws IllegalArgumentException if either {@code attribute} or {@code values} is invalid 753 * @since 24.0 754 */ 755 public MediaType withParameters(String attribute, Iterable<String> values) { 756 checkNotNull(attribute); 757 checkNotNull(values); 758 String normalizedAttribute = normalizeToken(attribute); 759 ImmutableListMultimap.Builder<String, String> builder = ImmutableListMultimap.builder(); 760 for (Entry<String, String> entry : parameters.entries()) { 761 String key = entry.getKey(); 762 if (!normalizedAttribute.equals(key)) { 763 builder.put(key, entry.getValue()); 764 } 765 } 766 for (String value : values) { 767 builder.put(normalizedAttribute, normalizeParameterValue(normalizedAttribute, value)); 768 } 769 MediaType mediaType = new MediaType(type, subtype, builder.build()); 770 // if the attribute isn't charset, we can just inherit the current parsedCharset 771 if (!normalizedAttribute.equals(CHARSET_ATTRIBUTE)) { 772 mediaType.parsedCharset = this.parsedCharset; 773 } 774 // Return one of the constants if the media type is a known type. 775 return MoreObjects.firstNonNull(KNOWN_TYPES.get(mediaType), mediaType); 776 } 777 778 /** 779 * <em>Replaces</em> all parameters with the given attribute with a single parameter with the 780 * given value. If multiple parameters with the same attributes are necessary use {@link 781 * #withParameters(String, Iterable)}. Prefer {@link #withCharset} for setting the {@code charset} 782 * parameter when using a {@link Charset} object. 783 * 784 * @throws IllegalArgumentException if either {@code attribute} or {@code value} is invalid 785 */ 786 public MediaType withParameter(String attribute, String value) { 787 return withParameters(attribute, ImmutableSet.of(value)); 788 } 789 790 /** 791 * Returns a new instance with the same type and subtype as this instance, with the {@code 792 * charset} parameter set to the {@link Charset#name name} of the given charset. Only one {@code 793 * charset} parameter will be present on the new instance regardless of the number set on this 794 * one. 795 * 796 * <p>If a charset must be specified that is not supported on this JVM (and thus is not 797 * representable as a {@link Charset} instance, use {@link #withParameter}. 798 */ 799 public MediaType withCharset(Charset charset) { 800 checkNotNull(charset); 801 MediaType withCharset = withParameter(CHARSET_ATTRIBUTE, charset.name()); 802 // precache the charset so we don't need to parse it 803 withCharset.parsedCharset = Optional.of(charset); 804 return withCharset; 805 } 806 807 /** Returns true if either the type or subtype is the wildcard. */ 808 public boolean hasWildcard() { 809 return WILDCARD.equals(type) || WILDCARD.equals(subtype); 810 } 811 812 /** 813 * Returns {@code true} if this instance falls within the range (as defined by <a 814 * href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">the HTTP Accept header</a>) given 815 * by the argument according to three criteria: 816 * 817 * <ol> 818 * <li>The type of the argument is the wildcard or equal to the type of this instance. 819 * <li>The subtype of the argument is the wildcard or equal to the subtype of this instance. 820 * <li>All of the parameters present in the argument are present in this instance. 821 * </ol> 822 * 823 * <p>For example: 824 * 825 * <pre>{@code 826 * PLAIN_TEXT_UTF_8.is(PLAIN_TEXT_UTF_8) // true 827 * PLAIN_TEXT_UTF_8.is(HTML_UTF_8) // false 828 * PLAIN_TEXT_UTF_8.is(ANY_TYPE) // true 829 * PLAIN_TEXT_UTF_8.is(ANY_TEXT_TYPE) // true 830 * PLAIN_TEXT_UTF_8.is(ANY_IMAGE_TYPE) // false 831 * PLAIN_TEXT_UTF_8.is(ANY_TEXT_TYPE.withCharset(UTF_8)) // true 832 * PLAIN_TEXT_UTF_8.withoutParameters().is(ANY_TEXT_TYPE.withCharset(UTF_8)) // false 833 * PLAIN_TEXT_UTF_8.is(ANY_TEXT_TYPE.withCharset(UTF_16)) // false 834 * }</pre> 835 * 836 * <p>Note that while it is possible to have the same parameter declared multiple times within a 837 * media type this method does not consider the number of occurrences of a parameter. For example, 838 * {@code "text/plain; charset=UTF-8"} satisfies {@code "text/plain; charset=UTF-8; 839 * charset=UTF-8"}. 840 */ 841 public boolean is(MediaType mediaTypeRange) { 842 return (mediaTypeRange.type.equals(WILDCARD) || mediaTypeRange.type.equals(this.type)) 843 && (mediaTypeRange.subtype.equals(WILDCARD) || mediaTypeRange.subtype.equals(this.subtype)) 844 && this.parameters.entries().containsAll(mediaTypeRange.parameters.entries()); 845 } 846 847 /** 848 * Creates a new media type with the given type and subtype. 849 * 850 * @throws IllegalArgumentException if type or subtype is invalid or if a wildcard is used for the 851 * type, but not the subtype. 852 */ 853 public static MediaType create(String type, String subtype) { 854 MediaType mediaType = create(type, subtype, ImmutableListMultimap.<String, String>of()); 855 mediaType.parsedCharset = Optional.absent(); 856 return mediaType; 857 } 858 859 private static MediaType create( 860 String type, String subtype, Multimap<String, String> parameters) { 861 checkNotNull(type); 862 checkNotNull(subtype); 863 checkNotNull(parameters); 864 String normalizedType = normalizeToken(type); 865 String normalizedSubtype = normalizeToken(subtype); 866 checkArgument( 867 !WILDCARD.equals(normalizedType) || WILDCARD.equals(normalizedSubtype), 868 "A wildcard type cannot be used with a non-wildcard subtype"); 869 ImmutableListMultimap.Builder<String, String> builder = ImmutableListMultimap.builder(); 870 for (Entry<String, String> entry : parameters.entries()) { 871 String attribute = normalizeToken(entry.getKey()); 872 builder.put(attribute, normalizeParameterValue(attribute, entry.getValue())); 873 } 874 MediaType mediaType = new MediaType(normalizedType, normalizedSubtype, builder.build()); 875 // Return one of the constants if the media type is a known type. 876 return MoreObjects.firstNonNull(KNOWN_TYPES.get(mediaType), mediaType); 877 } 878 879 /** 880 * Creates a media type with the "application" type and the given subtype. 881 * 882 * @throws IllegalArgumentException if subtype is invalid 883 */ 884 static MediaType createApplicationType(String subtype) { 885 return create(APPLICATION_TYPE, subtype); 886 } 887 888 /** 889 * Creates a media type with the "audio" type and the given subtype. 890 * 891 * @throws IllegalArgumentException if subtype is invalid 892 */ 893 static MediaType createAudioType(String subtype) { 894 return create(AUDIO_TYPE, subtype); 895 } 896 897 /** 898 * Creates a media type with the "image" type and the given subtype. 899 * 900 * @throws IllegalArgumentException if subtype is invalid 901 */ 902 static MediaType createImageType(String subtype) { 903 return create(IMAGE_TYPE, subtype); 904 } 905 906 /** 907 * Creates a media type with the "text" type and the given subtype. 908 * 909 * @throws IllegalArgumentException if subtype is invalid 910 */ 911 static MediaType createTextType(String subtype) { 912 return create(TEXT_TYPE, subtype); 913 } 914 915 /** 916 * Creates a media type with the "video" type and the given subtype. 917 * 918 * @throws IllegalArgumentException if subtype is invalid 919 */ 920 static MediaType createVideoType(String subtype) { 921 return create(VIDEO_TYPE, subtype); 922 } 923 924 private static String normalizeToken(String token) { 925 checkArgument(TOKEN_MATCHER.matchesAllOf(token)); 926 return Ascii.toLowerCase(token); 927 } 928 929 private static String normalizeParameterValue(String attribute, String value) { 930 return CHARSET_ATTRIBUTE.equals(attribute) ? Ascii.toLowerCase(value) : value; 931 } 932 933 /** 934 * Parses a media type from its string representation. 935 * 936 * @throws IllegalArgumentException if the input is not parsable 937 */ 938 public static MediaType parse(String input) { 939 checkNotNull(input); 940 Tokenizer tokenizer = new Tokenizer(input); 941 try { 942 String type = tokenizer.consumeToken(TOKEN_MATCHER); 943 tokenizer.consumeCharacter('/'); 944 String subtype = tokenizer.consumeToken(TOKEN_MATCHER); 945 ImmutableListMultimap.Builder<String, String> parameters = ImmutableListMultimap.builder(); 946 while (tokenizer.hasMore()) { 947 tokenizer.consumeTokenIfPresent(LINEAR_WHITE_SPACE); 948 tokenizer.consumeCharacter(';'); 949 tokenizer.consumeTokenIfPresent(LINEAR_WHITE_SPACE); 950 String attribute = tokenizer.consumeToken(TOKEN_MATCHER); 951 tokenizer.consumeCharacter('='); 952 final String value; 953 if ('"' == tokenizer.previewChar()) { 954 tokenizer.consumeCharacter('"'); 955 StringBuilder valueBuilder = new StringBuilder(); 956 while ('"' != tokenizer.previewChar()) { 957 if ('\\' == tokenizer.previewChar()) { 958 tokenizer.consumeCharacter('\\'); 959 valueBuilder.append(tokenizer.consumeCharacter(ascii())); 960 } else { 961 valueBuilder.append(tokenizer.consumeToken(QUOTED_TEXT_MATCHER)); 962 } 963 } 964 value = valueBuilder.toString(); 965 tokenizer.consumeCharacter('"'); 966 } else { 967 value = tokenizer.consumeToken(TOKEN_MATCHER); 968 } 969 parameters.put(attribute, value); 970 } 971 return create(type, subtype, parameters.build()); 972 } catch (IllegalStateException e) { 973 throw new IllegalArgumentException("Could not parse '" + input + "'", e); 974 } 975 } 976 977 private static final class Tokenizer { 978 final String input; 979 int position = 0; 980 981 Tokenizer(String input) { 982 this.input = input; 983 } 984 985 String consumeTokenIfPresent(CharMatcher matcher) { 986 checkState(hasMore()); 987 int startPosition = position; 988 position = matcher.negate().indexIn(input, startPosition); 989 return hasMore() ? input.substring(startPosition, position) : input.substring(startPosition); 990 } 991 992 String consumeToken(CharMatcher matcher) { 993 int startPosition = position; 994 String token = consumeTokenIfPresent(matcher); 995 checkState(position != startPosition); 996 return token; 997 } 998 999 char consumeCharacter(CharMatcher matcher) { 1000 checkState(hasMore()); 1001 char c = previewChar(); 1002 checkState(matcher.matches(c)); 1003 position++; 1004 return c; 1005 } 1006 1007 char consumeCharacter(char c) { 1008 checkState(hasMore()); 1009 checkState(previewChar() == c); 1010 position++; 1011 return c; 1012 } 1013 1014 char previewChar() { 1015 checkState(hasMore()); 1016 return input.charAt(position); 1017 } 1018 1019 boolean hasMore() { 1020 return (position >= 0) && (position < input.length()); 1021 } 1022 } 1023 1024 @Override 1025 public boolean equals(@Nullable Object obj) { 1026 if (obj == this) { 1027 return true; 1028 } else if (obj instanceof MediaType) { 1029 MediaType that = (MediaType) obj; 1030 return this.type.equals(that.type) 1031 && this.subtype.equals(that.subtype) 1032 // compare parameters regardless of order 1033 && this.parametersAsMap().equals(that.parametersAsMap()); 1034 } else { 1035 return false; 1036 } 1037 } 1038 1039 @Override 1040 public int hashCode() { 1041 // racy single-check idiom 1042 int h = hashCode; 1043 if (h == 0) { 1044 h = Objects.hashCode(type, subtype, parametersAsMap()); 1045 hashCode = h; 1046 } 1047 return h; 1048 } 1049 1050 private static final MapJoiner PARAMETER_JOINER = Joiner.on("; ").withKeyValueSeparator("="); 1051 1052 /** 1053 * Returns the string representation of this media type in the format described in <a 1054 * href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>. 1055 */ 1056 @Override 1057 public String toString() { 1058 // racy single-check idiom, safe because String is immutable 1059 String result = toString; 1060 if (result == null) { 1061 result = computeToString(); 1062 toString = result; 1063 } 1064 return result; 1065 } 1066 1067 private String computeToString() { 1068 StringBuilder builder = new StringBuilder().append(type).append('/').append(subtype); 1069 if (!parameters.isEmpty()) { 1070 builder.append("; "); 1071 Multimap<String, String> quotedParameters = 1072 Multimaps.transformValues( 1073 parameters, 1074 new Function<String, String>() { 1075 @Override 1076 public String apply(String value) { 1077 return TOKEN_MATCHER.matchesAllOf(value) ? value : escapeAndQuote(value); 1078 } 1079 }); 1080 PARAMETER_JOINER.appendTo(builder, quotedParameters.entries()); 1081 } 1082 return builder.toString(); 1083 } 1084 1085 private static String escapeAndQuote(String value) { 1086 StringBuilder escaped = new StringBuilder(value.length() + 16).append('"'); 1087 for (int i = 0; i < value.length(); i++) { 1088 char ch = value.charAt(i); 1089 if (ch == '\r' || ch == '\\' || ch == '"') { 1090 escaped.append('\\'); 1091 } 1092 escaped.append(ch); 1093 } 1094 return escaped.append('"').toString(); 1095 } 1096}