001/****************************************************************
002 * Licensed to the Apache Software Foundation (ASF) under one   *
003 * or more contributor license agreements.  See the NOTICE file *
004 * distributed with this work for additional information        *
005 * regarding copyright ownership.  The ASF licenses this file   *
006 * to you under the Apache License, Version 2.0 (the            *
007 * "License"); you may not use this file except in compliance   *
008 * with the License.  You may obtain a copy of the License at   *
009 *                                                              *
010 *   http://www.apache.org/licenses/LICENSE-2.0                 *
011 *                                                              *
012 * Unless required by applicable law or agreed to in writing,   *
013 * software distributed under the License is distributed on an  *
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
015 * KIND, either express or implied.  See the License for the    *
016 * specific language governing permissions and limitations      *
017 * under the License.                                           *
018 ****************************************************************/
019
020package org.apache.james.mime4j.storage;
021
022import java.io.IOException;
023import java.io.InputStream;
024
025/**
026 * Provides a strategy for storing the contents of an <code>InputStream</code>
027 * or retrieving the content written to an <code>OutputStream</code>.
028 */
029public interface StorageProvider {
030    /**
031     * Stores the contents of the given <code>InputStream</code>.
032     *
033     * @param in stream containing the data to store.
034     * @return a {@link Storage} instance that can be used to retrieve the
035     *         stored content.
036     * @throws IOException if an I/O error occurs.
037     */
038    Storage store(InputStream in) throws IOException;
039
040    /**
041     * Creates a {@link StorageOutputStream} where data to be stored can be
042     * written to. Subsequently the user can call
043     * {@link StorageOutputStream#toStorage() toStorage()} on that object to get
044     * a {@link Storage} instance that holds the data that has been written.
045     *
046     * @return a {@link StorageOutputStream} where data can be written to.
047     * @throws IOException
048     *             if an I/O error occurs.
049     */
050    StorageOutputStream createStorageOutputStream() throws IOException;
051}