aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2005, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package javax.activation;
aoqi@0: 
aoqi@0: import java.io.InputStream;
aoqi@0: import java.io.OutputStream;
aoqi@0: import java.io.IOException;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * The DataSource interface provides the JavaBeans Activation Framework
aoqi@0:  * with an abstraction of an arbitrary collection of data.  It
aoqi@0:  * provides a type for that data as well as access
aoqi@0:  * to it in the form of <code>InputStreams</code> and
aoqi@0:  * <code>OutputStreams</code> where appropriate.
aoqi@0:  *
aoqi@0:  * @since 1.6
aoqi@0:  */
aoqi@0: 
aoqi@0: public interface DataSource {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * This method returns an <code>InputStream</code> representing
aoqi@0:      * the data and throws the appropriate exception if it can
aoqi@0:      * not do so.  Note that a new <code>InputStream</code> object must be
aoqi@0:      * returned each time this method is called, and the stream must be
aoqi@0:      * positioned at the beginning of the data.
aoqi@0:      *
aoqi@0:      * @return an InputStream
aoqi@0:      */
aoqi@0:     public InputStream getInputStream() throws IOException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * This method returns an <code>OutputStream</code> where the
aoqi@0:      * data can be written and throws the appropriate exception if it can
aoqi@0:      * not do so.  Note that a new <code>OutputStream</code> object must
aoqi@0:      * be returned each time this method is called, and the stream must
aoqi@0:      * be positioned at the location the data is to be written.
aoqi@0:      *
aoqi@0:      * @return an OutputStream
aoqi@0:      */
aoqi@0:     public OutputStream getOutputStream() throws IOException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * This method returns the MIME type of the data in the form of a
aoqi@0:      * string. It should always return a valid type. It is suggested
aoqi@0:      * that getContentType return "application/octet-stream" if the
aoqi@0:      * DataSource implementation can not determine the data type.
aoqi@0:      *
aoqi@0:      * @return the MIME Type
aoqi@0:      */
aoqi@0:     public String getContentType();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return the <i>name</i> of this object where the name of the object
aoqi@0:      * is dependant on the nature of the underlying objects. DataSources
aoqi@0:      * encapsulating files may choose to return the filename of the object.
aoqi@0:      * (Typically this would be the last component of the filename, not an
aoqi@0:      * entire pathname.)
aoqi@0:      *
aoqi@0:      * @return the name of the object.
aoqi@0:      */
aoqi@0:     public String getName();
aoqi@0: }