| package org.apache.turbine.services.mimetype; |
| |
| /* ==================================================================== |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2001-2003 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Apache" and "Apache Software Foundation" and |
| * "Apache Turbine" must not be used to endorse or promote products |
| * derived from this software without prior written permission. For |
| * written permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * "Apache Turbine", nor may "Apache" appear in their name, without |
| * prior written permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| import java.io.File; |
| import java.util.Locale; |
| |
| import org.apache.turbine.services.Service; |
| import org.apache.turbine.services.mimetype.util.MimeType; |
| |
| /** |
| * The MimeType Service maintains mappings between MIME types and |
| * the corresponding file name extensions, and between locales and |
| * character encodings. The mappings are typically defined in |
| * properties or files located in user's home directory, Java home |
| * directory or the current class jar depending on the implementation. |
| * |
| * @deprecated Use the Fulcrum Mimetype component instead. |
| * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a> |
| * @version $Id$ |
| */ |
| public interface MimeTypeService extends Service |
| { |
| /** |
| * The name of the service. |
| */ |
| String SERVICE_NAME = "MimeTypeService"; |
| |
| /** |
| * 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. |
| * |
| * @param spec a MIME type extension specification to add. |
| */ |
| void setContentType(String spec); |
| |
| /** |
| * Gets the MIME content type for a file as a string. |
| * |
| * @param file the file. |
| * @return the MIME type string. |
| */ |
| String getContentType(File file); |
| |
| /** |
| * Gets the MIME content type for a named file as a string. |
| * |
| * @param name the name of the file. |
| * @return the MIME type string. |
| */ |
| String getContentType(String name); |
| |
| /** |
| * Gets the MIME content type for a file name extension as a string. |
| * |
| * @param ext the file name extension. |
| * @param def the default type if none is found. |
| * @return the MIME type string. |
| */ |
| String getContentType(String ext, |
| String def); |
| |
| /** |
| * Gets the MIME content type for a file. |
| * |
| * @param file the file. |
| * @return the MIME type. |
| */ |
| MimeType getMimeContentType(File file); |
| |
| /** |
| * Gets the MIME content type for a named file. |
| * |
| * @param name the name of the file. |
| * @return the MIME type. |
| */ |
| MimeType getMimeContentType(String name); |
| |
| /** |
| * Gets the MIME content type for a file name extension. |
| * |
| * @param ext the file name extension. |
| * @param def the default type if none is found. |
| * @return the MIME type. |
| */ |
| MimeType getMimeContentType(String ext, |
| String def); |
| |
| /** |
| * Gets the default file name extension for a MIME type. |
| * Note that the mappers are called in the reverse order. |
| * |
| * @param type the MIME type as a string. |
| * @return the file name extension or null. |
| */ |
| String getDefaultExtension(String type); |
| |
| /** |
| * Gets the default file name extension for a MIME type. |
| * Note that the mappers are called in the reverse order. |
| * |
| * @param mime the MIME type. |
| * @return the file name extension or null. |
| */ |
| String getDefaultExtension(MimeType mime); |
| |
| /** |
| * Sets a locale-charset mapping. |
| * |
| * @param key the key for the charset. |
| * @param charset the corresponding charset. |
| */ |
| void setCharSet(String key, |
| String charset); |
| |
| /** |
| * 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. |
| * |
| * @param locale the locale. |
| * @return the charset. |
| */ |
| String getCharSet(Locale locale); |
| |
| /** |
| * 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. |
| * |
| * @param locale the locale. |
| * @param variant a variant field. |
| * @return the charset. |
| */ |
| String getCharSet(Locale locale, |
| String variant); |
| |
| /** |
| * Gets the charset for a specified key. |
| * |
| * @param key the key for the charset. |
| * @return the found charset or the default one. |
| */ |
| String getCharSet(String key); |
| |
| /** |
| * Gets the charset for a specified key. |
| * |
| * @param key the key for the charset. |
| * @param def the default charset if none is found. |
| * @return the found charset or the given default. |
| */ |
| String getCharSet(String key, |
| String def); |
| } |