MimeTypeUtils (Okta Commons :: HTTP

java.lang.Object
- com.okta.commons.http.MimeTypeUtils

```
public final class MimeTypeUtils
extends java.lang.Object
```
Miscellaneous MimeType utility methods.

Since:

4.0

Author:

Arjen Poutsma, Rossen Stoyanchev

Field Summary

Fields
Modifier and Type	Field and Description
`static MimeType`	`ALL` Public constant mime type that includes all media ranges (i.e.
`static java.lang.String`	`ALL_VALUE` A String equivalent of `ALL`.
`static MimeType`	`APPLICATION_JSON` Public constant mime type for `application/json`.
`static java.lang.String`	`APPLICATION_JSON_VALUE` A String equivalent of `APPLICATION_JSON`.
`static MimeType`	`APPLICATION_OCTET_STREAM` Public constant mime type for `application/octet-stream`.
`static java.lang.String`	`APPLICATION_OCTET_STREAM_VALUE` A String equivalent of `APPLICATION_OCTET_STREAM`.
`static MimeType`	`APPLICATION_XML` Public constant mime type for `application/xml`.
`static java.lang.String`	`APPLICATION_XML_VALUE` A String equivalent of `APPLICATION_XML`.
`static MimeType`	`IMAGE_GIF` Public constant mime type for `image/gif`.
`static java.lang.String`	`IMAGE_GIF_VALUE` A String equivalent of `IMAGE_GIF`.
`static MimeType`	`IMAGE_JPEG` Public constant mime type for `image/jpeg`.
`static java.lang.String`	`IMAGE_JPEG_VALUE` A String equivalent of `IMAGE_JPEG`.
`static MimeType`	`IMAGE_PNG` Public constant mime type for `image/png`.
`static java.lang.String`	`IMAGE_PNG_VALUE` A String equivalent of `IMAGE_PNG`.
`static java.util.Comparator<MimeType>`	`SPECIFICITY_COMPARATOR` Comparator used by `sortBySpecificity(List)`.
`static MimeType`	`TEXT_HTML` Public constant mime type for `text/html`.
`static java.lang.String`	`TEXT_HTML_VALUE` A String equivalent of `TEXT_HTML`.
`static MimeType`	`TEXT_PLAIN` Public constant mime type for `text/plain`.
`static java.lang.String`	`TEXT_PLAIN_VALUE` A String equivalent of `TEXT_PLAIN`.
`static MimeType`	`TEXT_XML` Public constant mime type for `text/xml`.
`static java.lang.String`	`TEXT_XML_VALUE` A String equivalent of `TEXT_XML`.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static byte[]`	`generateMultipartBoundary()` Generate a random MIME boundary as bytes, often used in multipart mime types.
`static java.lang.String`	`generateMultipartBoundaryString()` Generate a random MIME boundary as String, often used in multipart mime types.
`static MimeType`	`parseMimeType(java.lang.String mimeType)` Parse the given String into a single `MimeType`.
`static java.util.List<MimeType>`	`parseMimeTypes(java.lang.String mimeTypes)` Parse the given, comma-separated string into a list of `MimeType` objects.
`static void`	`sortBySpecificity(java.util.List<MimeType> mimeTypes)` Sorts the given list of `MimeType` objects by specificity.
`static java.lang.String`	`toString(java.util.Collection<? extends MimeType> mimeTypes)` Return a string representation of the given list of `MimeType` objects.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SPECIFICITY_COMPARATOR
```
public static final java.util.Comparator<MimeType> SPECIFICITY_COMPARATOR
```
    Comparator used by sortBySpecificity(List).
  - ALL
```
public static final MimeType ALL
```
    Public constant mime type that includes all media ranges (i.e. "*/*").
  - ALL_VALUE
```
public static final java.lang.String ALL_VALUE
```
    A String equivalent of ALL.
    
    See Also:
    
    Constant Field Values
  - APPLICATION_JSON
```
public static final MimeType APPLICATION_JSON
```
    Public constant mime type for application/json.
  - APPLICATION_JSON_VALUE
```
public static final java.lang.String APPLICATION_JSON_VALUE
```
    A String equivalent of APPLICATION_JSON.
    
    See Also:
    
    Constant Field Values
  - APPLICATION_OCTET_STREAM
```
public static final MimeType APPLICATION_OCTET_STREAM
```
    Public constant mime type for application/octet-stream.
  - APPLICATION_OCTET_STREAM_VALUE
```
public static final java.lang.String APPLICATION_OCTET_STREAM_VALUE
```
    A String equivalent of APPLICATION_OCTET_STREAM.
    
    See Also:
    
    Constant Field Values
  - APPLICATION_XML
```
public static final MimeType APPLICATION_XML
```
    Public constant mime type for application/xml.
  - APPLICATION_XML_VALUE
```
public static final java.lang.String APPLICATION_XML_VALUE
```
    A String equivalent of APPLICATION_XML.
    
    See Also:
    
    Constant Field Values
  - IMAGE_GIF
```
public static final MimeType IMAGE_GIF
```
    Public constant mime type for image/gif.
  - IMAGE_GIF_VALUE
```
public static final java.lang.String IMAGE_GIF_VALUE
```
    A String equivalent of IMAGE_GIF.
    
    See Also:
    
    Constant Field Values
  - IMAGE_JPEG
```
public static final MimeType IMAGE_JPEG
```
    Public constant mime type for image/jpeg.
  - IMAGE_JPEG_VALUE
```
public static final java.lang.String IMAGE_JPEG_VALUE
```
    A String equivalent of IMAGE_JPEG.
    
    See Also:
    
    Constant Field Values
  - IMAGE_PNG
```
public static final MimeType IMAGE_PNG
```
    Public constant mime type for image/png.
  - IMAGE_PNG_VALUE
```
public static final java.lang.String IMAGE_PNG_VALUE
```
    A String equivalent of IMAGE_PNG.
    
    See Also:
    
    Constant Field Values
  - TEXT_HTML
```
public static final MimeType TEXT_HTML
```
    Public constant mime type for text/html.
  - TEXT_HTML_VALUE
```
public static final java.lang.String TEXT_HTML_VALUE
```
    A String equivalent of TEXT_HTML.
    
    See Also:
    
    Constant Field Values
  - TEXT_PLAIN
```
public static final MimeType TEXT_PLAIN
```
    Public constant mime type for text/plain.
  - TEXT_PLAIN_VALUE
```
public static final java.lang.String TEXT_PLAIN_VALUE
```
    A String equivalent of TEXT_PLAIN.
    
    See Also:
    
    Constant Field Values
  - TEXT_XML
```
public static final MimeType TEXT_XML
```
    Public constant mime type for text/xml.
  - TEXT_XML_VALUE
```
public static final java.lang.String TEXT_XML_VALUE
```
    A String equivalent of TEXT_XML.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - parseMimeType
```
public static MimeType parseMimeType(java.lang.String mimeType)
```
    Parse the given String into a single MimeType.
    
    Parameters:
    
    mimeType - the string to parse
    
    Returns:
    
    the mime type
    
    Throws:
    
    InvalidMimeTypeException - if the string cannot be parsed
  - parseMimeTypes
```
public static java.util.List<MimeType> parseMimeTypes(java.lang.String mimeTypes)
```
    Parse the given, comma-separated string into a list of MimeType objects.
    
    Parameters:
    
    mimeTypes - the string to parse
    
    Returns:
    
    the list of mime types
    
    Throws:
    
    java.lang.IllegalArgumentException - if the string cannot be parsed
  - toString
```
public static java.lang.String toString(java.util.Collection<? extends MimeType> mimeTypes)
```
    Return a string representation of the given list of MimeType objects.
    
    Parameters:
    
    mimeTypes - the string to parse
    
    Returns:
    
    the list of mime types
    
    Throws:
    
    java.lang.IllegalArgumentException - if the String cannot be parsed
  - sortBySpecificity
```
public static void sortBySpecificity(java.util.List<MimeType> mimeTypes)
```
    Sorts the given list of MimeType objects by specificity.
    Given two mime types:
    1. if either mime type has a wildcard type, then the mime type without the wildcard is ordered before the other.
    2. if the two mime types have different types, then they are considered equal and remain their current order.
    3. if either mime type has a wildcard subtype , then the mime type without the wildcard is sorted before the other.
    4. if the two mime types have different subtypes, then they are considered equal and remain their current order.
    5. if the two mime types have a different amount of parameters, then the mime type with the most parameters is ordered before the other.
    For example:
    audio/basic < audio/* < */*
    
    audio/basic;level=1 < audio/basic
    
    audio/basic == text/html
    
    audio/basic == audio/wave
    Parameters:
    
    mimeTypes - the list of mime types to be sorted
    
    See Also:
    
    HTTP 1.1: Semantics and Content, section 5.3.2
  - generateMultipartBoundary
```
public static byte[] generateMultipartBoundary()
```
    Generate a random MIME boundary as bytes, often used in multipart mime types.
    
    Returns:
    
    a multipart boundary byte array
  - generateMultipartBoundaryString
```
public static java.lang.String generateMultipartBoundaryString()
```
    Generate a random MIME boundary as String, often used in multipart mime types.
    
    Returns:
    
    a multipart boundary string

Class MimeTypeUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SPECIFICITY_COMPARATOR

ALL

ALL_VALUE

APPLICATION_JSON

APPLICATION_JSON_VALUE

APPLICATION_OCTET_STREAM

APPLICATION_OCTET_STREAM_VALUE

APPLICATION_XML

APPLICATION_XML_VALUE

IMAGE_GIF

IMAGE_GIF_VALUE

IMAGE_JPEG

IMAGE_JPEG_VALUE

IMAGE_PNG

IMAGE_PNG_VALUE

TEXT_HTML

TEXT_HTML_VALUE

TEXT_PLAIN

TEXT_PLAIN_VALUE

TEXT_XML

TEXT_XML_VALUE

Method Detail

parseMimeType

parseMimeTypes

toString

sortBySpecificity

generateMultipartBoundary

generateMultipartBoundaryString