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