io.muserver.handlers

Class ResourceType

java.lang.Object

io.muserver.handlers.ResourceType

public class ResourceType
extends Object

Used by the ResourceHandler to specify a mapping between file name extensions and mime types, and whether they should be gzipped or not.

A number of common mappings are provided by default. To specify your custom settings, use ResourceHandlerBuilder.withExtensionToResourceType(Map)

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceType	APPLICATION_EPUB_ZIP
static ResourceType	APPLICATION_GZIP
static ResourceType	APPLICATION_JAVA_ARCHIVE
static ResourceType	APPLICATION_JAVASCRIPT
static ResourceType	APPLICATION_JSON
static ResourceType	APPLICATION_MSWORD
static ResourceType	APPLICATION_OCTET_STREAM
static ResourceType	APPLICATION_OGG
static ResourceType	APPLICATION_PDF
static ResourceType	APPLICATION_RTF
static ResourceType	APPLICATION_TYPESCRIPT
static ResourceType	APPLICATION_VND_AMAZON_EBOOK
static ResourceType	APPLICATION_VND_APPLE_INSTALLER_XML
static ResourceType	APPLICATION_VND_MOZILLA_XUL_XML
static ResourceType	APPLICATION_VND_MS_EXCEL
static ResourceType	APPLICATION_VND_MS_FONTOBJECT
static ResourceType	APPLICATION_VND_MS_POWERPOINT
static ResourceType	APPLICATION_VND_OASIS_OPENDOCUMENT_PRESENTATION
static ResourceType	APPLICATION_VND_OASIS_OPENDOCUMENT_SPREADSHEET
static ResourceType	APPLICATION_VND_OASIS_OPENDOCUMENT_TEXT
static ResourceType	APPLICATION_VND_VISIO
static ResourceType	APPLICATION_X_7Z_COMPRESSED
static ResourceType	APPLICATION_X_ABIWORD
static ResourceType	APPLICATION_X_BZIP
static ResourceType	APPLICATION_X_BZIP2
static ResourceType	APPLICATION_X_CSH
static ResourceType	APPLICATION_X_RAR_COMPRESSED
static ResourceType	APPLICATION_X_SH
static ResourceType	APPLICATION_X_SHOCKWAVE_FLASH
static ResourceType	APPLICATION_X_TAR
static ResourceType	APPLICATION_XHTML_XML
static ResourceType	APPLICATION_XML
static ResourceType	APPLICATION_ZIP
static ResourceType	AUDIO_AAC
static ResourceType	AUDIO_MIDI
static ResourceType	AUDIO_OGG
static ResourceType	AUDIO_WEBM
static ResourceType	AUDIO_X_WAV
static ResourceType	DEFAULT
static Map<String,ResourceType>	DEFAULT_EXTENSION_MAPPINGS
List<String>	extensions
static ResourceType	FONT_OTF
static ResourceType	FONT_TTF
static ResourceType	FONT_WOFF
static ResourceType	FONT_WOFF2
boolean	gzip
Headers	headers
static ResourceType	IMAGE_GIF
static ResourceType	IMAGE_JPEG
static ResourceType	IMAGE_PNG
static ResourceType	IMAGE_SVG_XML
static ResourceType	IMAGE_TIFF
static ResourceType	IMAGE_WEBP
static ResourceType	IMAGE_X_ICON
CharSequence	mimeType
static ResourceType	TEXT_CALENDAR
static ResourceType	TEXT_CSS
static ResourceType	TEXT_CSV
static ResourceType	TEXT_HTML
static ResourceType	TEXT_JAVASCRIPT Deprecated. use APPLICATION_JAVASCRIPT instead
static ResourceType	TEXT_MARKDOWN
static ResourceType	TEXT_PLAIN
static ResourceType	VIDEO_3GPP
static ResourceType	VIDEO_3GPP2
static ResourceType	VIDEO_MPEG
static ResourceType	VIDEO_OGG
static ResourceType	VIDEO_WEBM
static ResourceType	VIDEO_X_MATROSKA
static ResourceType	VIDEO_X_MSVIDEO
static ResourceType	WEB_APP_MANIFEST

Constructor Summary

Constructors

Constructor and Description
ResourceType(CharSequence mimeType, Headers headers, boolean gzip, List<String> extensions)

Method Summary

Modifier and Type	Method and Description
static HashMap<String,ResourceType>	getDefaultMapping() Can be used as a base to customise mime types via ResourceHandlerBuilder.withExtensionToResourceType(Map)
static List<ResourceType>	getResourceTypes()
static Set<String>	gzippableMimeTypes(List<ResourceType> resourceTypes)
static Headers	noCache()
static Headers	shortCache()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_EXTENSION_MAPPINGS

public static final Map<String,ResourceType> DEFAULT_EXTENSION_MAPPINGS

mimeType

public final CharSequence mimeType

headers

public final Headers headers

extensions

public final List<String> extensions

gzip

public final boolean gzip

DEFAULT

public static final ResourceType DEFAULT

AUDIO_AAC

public static final ResourceType AUDIO_AAC

APPLICATION_X_ABIWORD

public static final ResourceType APPLICATION_X_ABIWORD

VIDEO_X_MSVIDEO

public static final ResourceType VIDEO_X_MSVIDEO

APPLICATION_VND_AMAZON_EBOOK

public static final ResourceType APPLICATION_VND_AMAZON_EBOOK

APPLICATION_OCTET_STREAM

public static final ResourceType APPLICATION_OCTET_STREAM

APPLICATION_X_BZIP

public static final ResourceType APPLICATION_X_BZIP

APPLICATION_X_BZIP2

public static final ResourceType APPLICATION_X_BZIP2

APPLICATION_X_CSH

public static final ResourceType APPLICATION_X_CSH

TEXT_CSS

public static final ResourceType TEXT_CSS

TEXT_PLAIN

public static final ResourceType TEXT_PLAIN

TEXT_MARKDOWN

public static final ResourceType TEXT_MARKDOWN

TEXT_CSV

public static final ResourceType TEXT_CSV

APPLICATION_MSWORD

public static final ResourceType APPLICATION_MSWORD

APPLICATION_VND_MS_FONTOBJECT

public static final ResourceType APPLICATION_VND_MS_FONTOBJECT

APPLICATION_EPUB_ZIP

public static final ResourceType APPLICATION_EPUB_ZIP

APPLICATION_GZIP

public static final ResourceType APPLICATION_GZIP

IMAGE_GIF

public static final ResourceType IMAGE_GIF

TEXT_HTML

public static final ResourceType TEXT_HTML

IMAGE_X_ICON

public static final ResourceType IMAGE_X_ICON

TEXT_CALENDAR

public static final ResourceType TEXT_CALENDAR

APPLICATION_JAVA_ARCHIVE

public static final ResourceType APPLICATION_JAVA_ARCHIVE

IMAGE_JPEG

public static final ResourceType IMAGE_JPEG

TEXT_JAVASCRIPT

@Deprecated
public static final ResourceType TEXT_JAVASCRIPT

Deprecated. use APPLICATION_JAVASCRIPT instead

APPLICATION_JAVASCRIPT

public static final ResourceType APPLICATION_JAVASCRIPT

APPLICATION_JSON

public static final ResourceType APPLICATION_JSON

WEB_APP_MANIFEST

public static final ResourceType WEB_APP_MANIFEST

AUDIO_MIDI

public static final ResourceType AUDIO_MIDI

VIDEO_MPEG

public static final ResourceType VIDEO_MPEG

APPLICATION_VND_APPLE_INSTALLER_XML

public static final ResourceType APPLICATION_VND_APPLE_INSTALLER_XML

APPLICATION_VND_OASIS_OPENDOCUMENT_PRESENTATION

public static final ResourceType APPLICATION_VND_OASIS_OPENDOCUMENT_PRESENTATION

APPLICATION_VND_OASIS_OPENDOCUMENT_SPREADSHEET

public static final ResourceType APPLICATION_VND_OASIS_OPENDOCUMENT_SPREADSHEET

APPLICATION_VND_OASIS_OPENDOCUMENT_TEXT

public static final ResourceType APPLICATION_VND_OASIS_OPENDOCUMENT_TEXT

AUDIO_OGG

public static final ResourceType AUDIO_OGG

VIDEO_X_MATROSKA

public static final ResourceType VIDEO_X_MATROSKA

VIDEO_OGG

public static final ResourceType VIDEO_OGG

APPLICATION_OGG

public static final ResourceType APPLICATION_OGG

FONT_OTF

public static final ResourceType FONT_OTF

IMAGE_PNG

public static final ResourceType IMAGE_PNG

APPLICATION_PDF

public static final ResourceType APPLICATION_PDF

APPLICATION_VND_MS_POWERPOINT

public static final ResourceType APPLICATION_VND_MS_POWERPOINT

APPLICATION_X_RAR_COMPRESSED

public static final ResourceType APPLICATION_X_RAR_COMPRESSED

APPLICATION_RTF

public static final ResourceType APPLICATION_RTF

APPLICATION_X_SH

public static final ResourceType APPLICATION_X_SH

IMAGE_SVG_XML

public static final ResourceType IMAGE_SVG_XML

APPLICATION_X_SHOCKWAVE_FLASH

public static final ResourceType APPLICATION_X_SHOCKWAVE_FLASH

APPLICATION_X_TAR

public static final ResourceType APPLICATION_X_TAR

IMAGE_TIFF

public static final ResourceType IMAGE_TIFF

APPLICATION_TYPESCRIPT

public static final ResourceType APPLICATION_TYPESCRIPT

FONT_TTF

public static final ResourceType FONT_TTF

APPLICATION_VND_VISIO

public static final ResourceType APPLICATION_VND_VISIO

AUDIO_X_WAV

public static final ResourceType AUDIO_X_WAV

AUDIO_WEBM

public static final ResourceType AUDIO_WEBM

VIDEO_WEBM

public static final ResourceType VIDEO_WEBM

IMAGE_WEBP

public static final ResourceType IMAGE_WEBP

FONT_WOFF

public static final ResourceType FONT_WOFF

FONT_WOFF2

public static final ResourceType FONT_WOFF2

APPLICATION_XHTML_XML

public static final ResourceType APPLICATION_XHTML_XML

APPLICATION_VND_MS_EXCEL

public static final ResourceType APPLICATION_VND_MS_EXCEL

APPLICATION_XML

public static final ResourceType APPLICATION_XML

APPLICATION_VND_MOZILLA_XUL_XML

public static final ResourceType APPLICATION_VND_MOZILLA_XUL_XML

APPLICATION_ZIP

public static final ResourceType APPLICATION_ZIP

VIDEO_3GPP

public static final ResourceType VIDEO_3GPP

VIDEO_3GPP2

public static final ResourceType VIDEO_3GPP2

APPLICATION_X_7Z_COMPRESSED

public static final ResourceType APPLICATION_X_7Z_COMPRESSED

Constructor Detail

ResourceType

public ResourceType(CharSequence mimeType,
                    Headers headers,
                    boolean gzip,
                    List<String> extensions)

Method Detail

shortCache

public static Headers shortCache()

Returns:

Creates and returns a Headers object with a single cache-control header set for 5 minutes.

noCache

public static Headers noCache()

Returns:

Creates and returns a Headers object with a single cache-control header set with no-cache.

getDefaultMapping

public static HashMap<String,ResourceType> getDefaultMapping()

Can be used as a base to customise mime types via ResourceHandlerBuilder.withExtensionToResourceType(Map)

Returns:

Returns the built-in mapping of file extension to resource type that can be added to in order to customise resource types.

gzippableMimeTypes

public static Set<String> gzippableMimeTypes(List<ResourceType> resourceTypes)

getResourceTypes

public static List<ResourceType> getResourceTypes()

toString

public String toString()

Overrides:

toString in class Object