org.rapidcontext.core.web

Class Mime

java.lang.Object

org.rapidcontext.core.web.Mime

public class Mime
extends java.lang.Object

A MIME type helper class.

Version:

1.0

Author:

Per Cederberg

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	BIN The MIME types commonly used for binary files and data.
static javax.servlet.ServletContext	context The helper servlet context.
static java.lang.String[]	CSS The MIME types commonly used for CSS files.
static java.lang.String[]	GIF The MIME types commonly used for GIF images.
static java.lang.String[]	HTML The MIME types commonly used for HTML files.
static java.lang.String[]	ICO The MIME types commonly used for ICO images.
static java.lang.String[]	JPEG The MIME types commonly used for JPEG images.
static java.lang.String[]	JS The MIME types commonly used for JavaScript files.
static java.lang.String[]	JSON The MIME types commonly used for JSON files and data.
static java.lang.String[]	PNG The MIME types commonly used for PNG images.
static java.lang.String[]	SVG The MIME types commonly used for SVG images.
static java.lang.String[]	TEXT The MIME types commonly used for text files.
static java.lang.String[]	XML The MIME types commonly used for XML files.

Constructor Summary

Constructors

Constructor and Description
Mime()

Method Summary

Modifier and Type	Method and Description
static boolean	isInputMatch(Request request, java.lang.String[] mimes) Checks if the request input matches one of the specified MIME types.
static boolean	isMatch(java.lang.String contentType, java.lang.String[] mimes) Checks if a specified content type matches one of the specified MIME types.
static boolean	isOutputMatch(Request request, java.lang.String[] mimes) Checks if the accepted request output matches one of the specified MIME types.
static java.lang.String	type(java.io.File file) Attempts to guess the MIME type for a file, based on the file name (extension).
static java.lang.String	type(java.lang.String fileName) Attempts to guess the MIME type for a file name (extension).

Methods inherited from class java.lang.Object

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

Field Detail

TEXT

public static final java.lang.String[] TEXT

The MIME types commonly used for text files.

HTML

public static final java.lang.String[] HTML

The MIME types commonly used for HTML files.

CSS

public static final java.lang.String[] CSS

The MIME types commonly used for CSS files.

JS

public static final java.lang.String[] JS

The MIME types commonly used for JavaScript files.

JSON

public static final java.lang.String[] JSON

The MIME types commonly used for JSON files and data.

XML

public static final java.lang.String[] XML

The MIME types commonly used for XML files.

GIF

public static final java.lang.String[] GIF

The MIME types commonly used for GIF images.

JPEG

public static final java.lang.String[] JPEG

The MIME types commonly used for JPEG images.

PNG

public static final java.lang.String[] PNG

The MIME types commonly used for PNG images.

SVG

public static final java.lang.String[] SVG

The MIME types commonly used for SVG images.

ICO

public static final java.lang.String[] ICO

The MIME types commonly used for ICO images.

BIN

public static final java.lang.String[] BIN

The MIME types commonly used for binary files and data.

context

public static javax.servlet.ServletContext context

The helper servlet context. This can be set by the application to access the servlet container MIME type configuration.

Constructor Detail

Mime

public Mime()

Method Detail

type

public static java.lang.String type(java.io.File file)

Attempts to guess the MIME type for a file, based on the file name (extension). This method will always return a valid MIME type, defaulting to the binary MIME type if unknown.

Parameters:

file - the file to check

Returns:

the file MIME type, or a binary MIME type if unknown

type

public static java.lang.String type(java.lang.String fileName)

Attempts to guess the MIME type for a file name (extension). This method will always return a valid MIME type, defaulting to the binary MIME type if unknown.

Parameters:

fileName - the file name to check

Returns:

the file MIME type, or a binary MIME type if unknown

isMatch

public static boolean isMatch(java.lang.String contentType,
                              java.lang.String[] mimes)

Checks if a specified content type matches one of the specified MIME types. Note that this method checks for any match, without regard for any embedded quality or encoding value.

Parameters:

contentType - the content type to analyze

mimes - the MIME types to check for

Returns:

true if one of the MIME types is accepted, or false otherwise

isInputMatch

public static boolean isInputMatch(Request request,
                                   java.lang.String[] mimes)

Checks if the request input matches one of the specified MIME types. The input MIME type is read from the 'Content-Type' HTTP header, not from the data stream itself.

Parameters:

request - the request to analyze

mimes - the MIME types to check for

Returns:

true if one of the MIME types match, or false otherwise

isOutputMatch

public static boolean isOutputMatch(Request request,
                                    java.lang.String[] mimes)

Checks if the accepted request output matches one of the specified MIME types. The accepted output MIME type is read from the 'Accept' HTTP header. Note that this method accept matches without regard for quality values in the header.

Parameters:

request - the request to analyze

mimes - the MIME types to check for

Returns:

true if one of the MIME types is accepted, or false otherwise