| org.apache.turbine.services.TurbineBaseService org.apache.turbine.services.mimetype.TurbineMimeTypeService
TurbineMimeTypeService | public class TurbineMimeTypeService extends TurbineBaseService implements MimeTypeService(Code) | | The MimeType Service maintains mappings between MIME types and
the corresponding file name extensions, and between locales and
character encodings.
The MIME type mappings can be defined in MIME type files
located in user's home directory, Java home directory or
the current class jar. The default mapping file is defined
with the mime.type.file property. In addition, the service maintains
a set of most common mappings.
The charset mappings can be defined in property files
located in user's home directory, Java home directory or
the current class jar. The default mapping file is defined
with the charset.file property. In addition, the service maintains
a set of most common mappings.
author: Ilkka Priha version: $Id: TurbineMimeTypeService.java 534527 2007-05-02 16:10:59Z tv $ |
Method Summary | |
public String | getCharSet(Locale locale) Gets the charset for a locale. | public String | getCharSet(Locale locale, String variant) Gets the charset for a locale with a variant. | public String | getCharSet(String key) Gets the charset for a specified key.
Parameters: key - the key for the charset. | public String | getCharSet(String key, String def) Gets the charset for a specified key.
Parameters: key - the key for the charset. Parameters: def - the default charset if none is found. | public String | getContentType(File file) Gets the MIME content type for a file as a string.
Parameters: file - the file. | public String | getContentType(String name) Gets the MIME content type for a named file as a string.
Parameters: name - the name of the file. | public String | getContentType(String ext, String def) Gets the MIME content type for a file name extension as a string.
Parameters: ext - the file name extension. Parameters: def - the default type if none is found. | public String | getDefaultExtension(String type) Gets the default file name extension for a MIME type.
Note that the mappers are called in the reverse order.
Parameters: type - the MIME type as a string. | public String | getDefaultExtension(MimeType mime) Gets the default file name extension for a MIME type.
Note that the mappers are called in the reverse order.
Parameters: mime - the MIME type. | public MimeType | getMimeContentType(File file) Gets the MIME content type for a file.
Parameters: file - the file. | public MimeType | getMimeContentType(String name) Gets the MIME content type for a named file.
Parameters: name - the name of the file. | public MimeType | getMimeContentType(String ext, String def) Gets the MIME content type for a file name extension.
Parameters: ext - the file name extension. Parameters: def - the default type if none is found. | public void | init() Initializes the service. | public void | setCharSet(String key, String charset) Sets a locale-charset mapping. | public void | setContentType(String spec) Sets a MIME content type mapping to extensions to the map. |
CHARSETS | final public static String CHARSETS(Code) | | The charset file property.
|
MIME_TYPES | final public static String MIME_TYPES(Code) | | The MIME type file property.
|
TurbineMimeTypeService | public TurbineMimeTypeService()(Code) | | Constructs a new service.
|
getCharSet | public String getCharSet(Locale locale)(Code) | | Gets the charset for a locale. First a locale specific charset
is searched for, then a country specific one and lastly a language
specific one. If none is found, the default charset is returned.
Parameters: locale - the locale. the charset. |
getCharSet | public String getCharSet(Locale locale, String variant)(Code) | | Gets the charset for a locale with a variant. The search
is performed in the following order:
"lang"_"country"_"variant"="charset",
_"counry"_"variant"="charset",
"lang"__"variant"="charset",
__"variant"="charset",
"lang"_"country"="charset",
_"country"="charset",
"lang"="charset".
If nothing of the above is found, the default charset is returned.
Parameters: locale - the locale. Parameters: variant - a variant field. the charset. |
getCharSet | public String getCharSet(String key)(Code) | | Gets the charset for a specified key.
Parameters: key - the key for the charset. the found charset or the default one. |
getCharSet | public String getCharSet(String key, String def)(Code) | | Gets the charset for a specified key.
Parameters: key - the key for the charset. Parameters: def - the default charset if none is found. the found charset or the given default. |
getContentType | public String getContentType(File file)(Code) | | Gets the MIME content type for a file as a string.
Parameters: file - the file. the MIME type string. |
getContentType | public String getContentType(String name)(Code) | | Gets the MIME content type for a named file as a string.
Parameters: name - the name of the file. the MIME type string. |
getContentType | public String getContentType(String ext, String def)(Code) | | Gets the MIME content type for a file name extension as a string.
Parameters: ext - the file name extension. Parameters: def - the default type if none is found. the MIME type string. |
getDefaultExtension | public String getDefaultExtension(String type)(Code) | | Gets the default file name extension for a MIME type.
Note that the mappers are called in the reverse order.
Parameters: type - the MIME type as a string. the file name extension or null. |
getDefaultExtension | public String getDefaultExtension(MimeType mime)(Code) | | Gets the default file name extension for a MIME type.
Note that the mappers are called in the reverse order.
Parameters: mime - the MIME type. the file name extension or null. |
getMimeContentType | public MimeType getMimeContentType(File file)(Code) | | Gets the MIME content type for a file.
Parameters: file - the file. the MIME type. |
getMimeContentType | public MimeType getMimeContentType(String name)(Code) | | Gets the MIME content type for a named file.
Parameters: name - the name of the file. the MIME type. |
getMimeContentType | public MimeType getMimeContentType(String ext, String def)(Code) | | Gets the MIME content type for a file name extension.
Parameters: ext - the file name extension. Parameters: def - the default type if none is found. the MIME type. |
setCharSet | public void setCharSet(String key, String charset)(Code) | | Sets a locale-charset mapping.
Parameters: key - the key for the charset. Parameters: charset - the corresponding charset. |
setContentType | public void setContentType(String spec)(Code) | | Sets a MIME content type mapping to extensions to the map.
The extension is specified by a MIME type name followed
by a list of file name extensions separated by a whitespace.
Parameters: spec - a MIME type extension specification to add. |
|
|