001 /* 002 * JBoss DNA (http://www.jboss.org/dna) 003 * See the COPYRIGHT.txt file distributed with this work for information 004 * regarding copyright ownership. Some portions may be licensed 005 * to Red Hat, Inc. under one or more contributor license agreements. 006 * See the AUTHORS.txt file in the distribution for a full listing of 007 * individual contributors. 008 * 009 * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA 010 * is licensed to you under the terms of the GNU Lesser General Public License as 011 * published by the Free Software Foundation; either version 2.1 of 012 * the License, or (at your option) any later version. 013 * 014 * JBoss DNA is distributed in the hope that it will be useful, 015 * but WITHOUT ANY WARRANTY; without even the implied warranty of 016 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 017 * Lesser General Public License for more details. 018 * 019 * You should have received a copy of the GNU Lesser General Public 020 * License along with this software; if not, write to the Free 021 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 022 * 02110-1301 USA, or see the FSF site: http://www.fsf.org. 023 */ 024 package org.jboss.dna.graph.mimetype; 025 026 import java.io.IOException; 027 import java.io.InputStream; 028 import net.jcip.annotations.ThreadSafe; 029 030 /** 031 * MIME-type detection libraries must provide thread-safe implementations of this interface to enable DNA to use the libraries to 032 * return MIME-types for data sources. 033 * 034 * @author jverhaeg 035 */ 036 @ThreadSafe 037 public interface MimeTypeDetector { 038 039 /** 040 * Returns the MIME-type of a data source, using its supplied content and/or its supplied name, depending upon the 041 * implementation. If the MIME-type cannot be determined, either a "default" MIME-type or <code>null</code> may be returned, 042 * where the former will prevent earlier registered MIME-type detectors from being consulted. 043 * <p> 044 * Note that detector implementations should <i>not</i> {@link InputStream#close() close} the supplied input stream. 045 * </p> 046 * 047 * @param name The name of the data source; may be <code>null</code>. 048 * @param content The content of the data source; may be <code>null</code>. 049 * @return The MIME-type of the data source, or optionally <code>null</code> if the MIME-type could not be determined. 050 * @throws IOException If an error occurs reading the supplied content. 051 */ 052 String mimeTypeOf( String name, 053 InputStream content ) throws IOException; 054 }