Top Description Inners Fields Constructors Methods
org.eclipse.jetty.http

public Class MimeTypes

extends Object
Class Inheritance
Known Direct Subclasses
org.eclipse.jetty.http.MimeTypes.Mutable
Imports
java.io.IOException, .InputStream, .InputStreamReader, .UnsupportedEncodingException, java.nio.charset.Charset, .IllegalCharsetNameException, .StandardCharsets, .UnsupportedCharsetException, java.util.Arrays, .Collections, .HashMap, .Locale, .Map, .Objects, .Properties, .Set, java.util.stream.Collectors, org.eclipse.jetty.util.FileID, .Index, .StringUtil, org.slf4j.Logger, .LoggerFactory

MIME Type enum and utilities

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
public static enum
MimeTypes.Type

Enumeration of predefined MimeTypes.

public static class

Field Summary

Modifier and TypeField and Description
protected final Map<String, Charset>
protected final Map<String, Charset>
protected final Map<String, String>
public static final Index<MimeTypes.Type>
private static final Index<String>
public static final MimeTypes
public static final String
private static final Set<Locale>
pack-priv static final Logger
public static final String
public static final String

Constructor Summary

AccessConstructor and Description
public
public
MimeTypes(MimeTypes defaults)

Method Summary

Modifier and TypeMethod and Description
public Charset
public Map<String, String>
public static MimeTypes.Type
getBaseType(String contentType)

public Charset

Returns:

A Charset or null;
getCharset
(String
String form or a mimeType
mimeType
)

Get the explicit, assumed, or inferred Charset for a mime type

public String
public static String
public String
public static String
public Charset
public Map<String, String>
public static Charset
getKnownCharset(String
The name of the charset
charsetName
)

Returns: The Charset for the normalized name

public String

Returns:

MIME type matching the last dot extension of the file name, or matching "*" if none found.
getMimeByExtension
(String
A file name
filename
)

Get the MIME type by filename extension.

public String
public Map<String, String>
public static boolean
private static String
nameOf(Charset charset)

public static String

Returns:

the normalized charset (or null if normalized version not found)
normalizeCharset
(String
the charset to normalize
charsetName
)

Convert alternate charset names (eg utf8) to normalized name (eg UTF-8).

public static String

Returns:

the normalized charset (or null if not found)
normalizeCharset
(String
the charset to normalize
charsetName
,
int
the offset in the charset
offset
,
int
the length of the charset in the input param
length
)

Convert alternate charset names (eg utf8) to normalized name (eg UTF-8).

private static String
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_assumedEncodingsback to summary
protected final Map<String, Charset> _assumedEncodings
_inferredEncodingsback to summary
protected final Map<String, Charset> _inferredEncodings
_mimeMapback to summary
protected final Map<String, String> _mimeMap
CACHEback to summary
public static final Index<MimeTypes.Type> CACHE
CHARSETSback to summary
private static final Index<String> CHARSETS
DEFAULTSback to summary
public static final MimeTypes DEFAULTS
ISO_8859_1back to summary
public static final String ISO_8859_1
KNOWN_LOCALESback to summary
private static final Set<Locale> KNOWN_LOCALES
LOGback to summary
pack-priv static final Logger LOG
UTF16back to summary
public static final String UTF16
UTF8back to summary
public static final String UTF8

Constructor Detail

MimeTypesback to summary
public MimeTypes()
MimeTypesback to summary
public MimeTypes(MimeTypes defaults)

Method Detail

getAssumedCharsetback to summary
public Charset getAssumedCharset(String contentType)
getAssumedMapback to summary
public Map<String, String> getAssumedMap()
getBaseTypeback to summary
public static MimeTypes.Type getBaseType(String contentType)
getCharsetback to summary
public Charset getCharset(String mimeType) throws IllegalCharsetNameException, UnsupportedCharsetException

Get the explicit, assumed, or inferred Charset for a mime type

Parameters
mimeType:String

String form or a mimeType

Returns:Charset

A Charset or null;

Exceptions
IllegalCharsetNameException:
If the given charset name is illegal
UnsupportedCharsetException:
If no support for the named charset is available in this instance of the Java virtual machine
getCharsetAssumedFromContentTypeback to summary
public String getCharsetAssumedFromContentType(String contentType)
getCharsetFromContentTypeback to summary
public static String getCharsetFromContentType(String value)
getCharsetInferredFromContentTypeback to summary
public String getCharsetInferredFromContentType(String contentType)
getContentTypeWithoutCharsetback to summary
public static String getContentTypeWithoutCharset(String value)
getInferredCharsetback to summary
public Charset getInferredCharset(String contentType)
getInferredMapback to summary
public Map<String, String> getInferredMap()
getKnownCharsetback to summary
public static Charset getKnownCharset(String charsetName) throws UnsupportedEncodingException
Parameters
charsetName:String

The name of the charset

Returns:Charset

The Charset for the normalized name

Exceptions
UnsupportedEncodingException:
Thrown if the charset is not known to the JVM.
getMimeByExtensionback to summary
public String getMimeByExtension(String filename)

Get the MIME type by filename extension.

Parameters
filename:String

A file name

Returns:String

MIME type matching the last dot extension of the file name, or matching "*" if none found.

getMimeForExtensionback to summary
public String getMimeForExtension(String extension)
getMimeMapback to summary
public Map<String, String> getMimeMap()
isKnownLocaleback to summary
public static boolean isKnownLocale(Locale locale)
nameOfback to summary
private static String nameOf(Charset charset)
normalizeCharsetback to summary
public static String normalizeCharset(String charsetName)

Convert alternate charset names (eg utf8) to normalized name (eg UTF-8).

Parameters
charsetName:String

the charset to normalize

Returns:String

the normalized charset (or null if normalized version not found)

normalizeCharsetback to summary
public static String normalizeCharset(String charsetName, int offset, int length)

Convert alternate charset names (eg utf8) to normalized name (eg UTF-8).

Parameters
charsetName:String

the charset to normalize

offset:int

the offset in the charset

length:int

the length of the charset in the input param

Returns:String

the normalized charset (or null if not found)

normalizeMimeTypeback to summary
private static String normalizeMimeType(String type)
org.eclipse.jetty.http back to summary

public Class MimeTypes.Mutable

extends MimeTypes
Class Inheritance
Known Direct Subclasses
org.eclipse.jetty.http.MimeTypes.Wrapper

Field Summary

Inherited from org.eclipse.jetty.http.MimeTypes:
_assumedEncodings_inferredEncodings_mimeMapCACHEDEFAULTSISO_8859_1LOGUTF16UTF8

Constructor Summary

AccessConstructor and Description
public
public
Mutable(MimeTypes defaults)

Method Summary

Modifier and TypeMethod and Description
public String
addAssumed(String contentType, String encoding)

public String
addInferred(String contentType, String encoding)

public String

Returns:

previous value
addMimeMapping
(String
the extension
extension
,
String
the mime type
type
)

Set a mime mapping

Inherited from org.eclipse.jetty.http.MimeTypes:
getAssumedCharsetgetAssumedMapgetBaseTypegetCharsetgetCharsetAssumedFromContentTypegetCharsetFromContentTypegetCharsetInferredFromContentTypegetContentTypeWithoutCharsetgetInferredCharsetgetInferredMapgetKnownCharsetgetMimeByExtensiongetMimeForExtensiongetMimeMapisKnownLocalenormalizeCharsetnormalizeCharset

Constructor Detail

Mutableback to summary
public Mutable()
Mutableback to summary
public Mutable(MimeTypes defaults)

Method Detail

addAssumedback to summary
public String addAssumed(String contentType, String encoding)
addInferredback to summary
public String addInferred(String contentType, String encoding)
addMimeMappingback to summary
public String addMimeMapping(String extension, String type)

Set a mime mapping

Parameters
extension:String

the extension

type:String

the mime type

Returns:String

previous value

org.eclipse.jetty.http back to summary

public sealed Enum MimeTypes.Type

extends Enum<MimeTypes.Type>
Class Inheritance

Enumeration of predefined MimeTypes. This is not exhaustive

Field Summary

Modifier and TypeField and Description
private final boolean
private final MimeTypes.Type
private final Charset
private final String
private final HttpField
private final String
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type
public static final MimeTypes.Type

Constructor Summary

AccessConstructor and Description
private
Type(String name)

private
Type(String name, MimeTypes.Type base)

private
Type(String name, Charset cs)

Method Summary

Modifier and TypeMethod and Description
public String
public MimeTypes.Type
public Charset
public String
public HttpField
public HttpField
public boolean
is(String type)

public boolean
public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.

public static MimeTypes.Type
public static MimeTypes.Type[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

_assumedCharsetback to summary
private final boolean _assumedCharset
_baseback to summary
private final MimeTypes.Type _base
_charsetback to summary
private final Charset _charset
_charsetStringback to summary
private final String _charsetString
_fieldback to summary
private final HttpField _field
_stringback to summary
private final String _string
APPLICATION_JSONback to summary
public static final MimeTypes.Type APPLICATION_JSON
APPLICATION_JSON_8859_1back to summary
public static final MimeTypes.Type APPLICATION_JSON_8859_1
APPLICATION_JSON_UTF_8back to summary
public static final MimeTypes.Type APPLICATION_JSON_UTF_8
FORM_ENCODEDback to summary
public static final MimeTypes.Type FORM_ENCODED
MESSAGE_HTTPback to summary
public static final MimeTypes.Type MESSAGE_HTTP
MULTIPART_BYTERANGESback to summary
public static final MimeTypes.Type MULTIPART_BYTERANGES
MULTIPART_FORM_DATAback to summary
public static final MimeTypes.Type MULTIPART_FORM_DATA
TEXT_HTMLback to summary
public static final MimeTypes.Type TEXT_HTML
TEXT_HTML_8859_1back to summary
public static final MimeTypes.Type TEXT_HTML_8859_1
TEXT_HTML_UTF_8back to summary
public static final MimeTypes.Type TEXT_HTML_UTF_8
TEXT_JSONback to summary
public static final MimeTypes.Type TEXT_JSON
TEXT_JSON_8859_1back to summary
public static final MimeTypes.Type TEXT_JSON_8859_1
TEXT_JSON_UTF_8back to summary
public static final MimeTypes.Type TEXT_JSON_UTF_8
TEXT_PLAINback to summary
public static final MimeTypes.Type TEXT_PLAIN
TEXT_PLAIN_8859_1back to summary
public static final MimeTypes.Type TEXT_PLAIN_8859_1
TEXT_PLAIN_UTF_8back to summary
public static final MimeTypes.Type TEXT_PLAIN_UTF_8
TEXT_XMLback to summary
public static final MimeTypes.Type TEXT_XML
TEXT_XML_8859_1back to summary
public static final MimeTypes.Type TEXT_XML_8859_1
TEXT_XML_UTF_8back to summary
public static final MimeTypes.Type TEXT_XML_UTF_8

Constructor Detail

Typeback to summary
private Type(String name)
Typeback to summary
private Type(String name, MimeTypes.Type base)
Typeback to summary
private Type(String name, Charset cs)

Method Detail

asStringback to summary
public String asString()
getBaseTypeback to summary
public MimeTypes.Type getBaseType()
getCharsetback to summary
public Charset getCharset()
getCharsetStringback to summary
public String getCharsetString()
getContentTypeFieldback to summary
public HttpField getContentTypeField()
getContentTypeFieldback to summary
public HttpField getContentTypeField(Charset charset)
isback to summary
public boolean is(String type)
isCharsetAssumedback to summary
public boolean isCharsetAssumed()
toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations
@Override
valueOfback to summary
public static MimeTypes.Type valueOf(String name)
valuesback to summary
public static MimeTypes.Type[] values()
org.eclipse.jetty.http back to summary

public Class MimeTypes.Wrapper

extends Mutable
Class Inheritance

Field Summary

Modifier and TypeField and Description
private MimeTypes

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Map<String, String>
public String
public String
public Map<String, String>
public String
public Map<String, String>
public MimeTypes
public void
Inherited from org.eclipse.jetty.http.MimeTypes.Mutable:
addAssumedaddInferredaddMimeMapping

Field Detail

_wrappedback to summary
private MimeTypes _wrapped

Constructor Detail

Wrapperback to summary
public Wrapper()

Method Detail

getAssumedMapback to summary
public Map<String, String> getAssumedMap()

Overrides org.eclipse.jetty.http.MimeTypes.getAssumedMap.

Annotations
@Override
getCharsetAssumedFromContentTypeback to summary
public String getCharsetAssumedFromContentType(String contentType)

Overrides org.eclipse.jetty.http.MimeTypes.getCharsetAssumedFromContentType.

Annotations
@Override
getCharsetInferredFromContentTypeback to summary
public String getCharsetInferredFromContentType(String contentType)

Overrides org.eclipse.jetty.http.MimeTypes.getCharsetInferredFromContentType.

Annotations
@Override
getInferredMapback to summary
public Map<String, String> getInferredMap()

Overrides org.eclipse.jetty.http.MimeTypes.getInferredMap.

Annotations
@Override
getMimeForExtensionback to summary
public String getMimeForExtension(String extension)

Overrides org.eclipse.jetty.http.MimeTypes.getMimeForExtension.

Annotations
@Override
getMimeMapback to summary
public Map<String, String> getMimeMap()

Overrides org.eclipse.jetty.http.MimeTypes.getMimeMap.

Annotations
@Override
getWrappedback to summary
public MimeTypes getWrapped()
setWrappedback to summary
public void setWrapped(MimeTypes wrapped)