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    
020    package org.apache.james.mime4j.storage;
021    
022    import java.io.IOException;
023    import java.io.InputStream;
024    
025    import org.apache.james.mime4j.codec.CodecUtil;
026    
027    /**
028     * Abstract implementation of {@link StorageProvider} that implements
029     * {@link StorageProvider#store(InputStream) store(InputStream)} by copying the
030     * input stream to a {@link StorageOutputStream} obtained from
031     * {@link StorageProvider#createStorageOutputStream() createStorageOutputStream()}.
032     */
033    public abstract class AbstractStorageProvider implements StorageProvider {
034    
035        /**
036         * Sole constructor.
037         */
038        protected AbstractStorageProvider() {
039        }
040    
041        /**
042         * This implementation creates a {@link StorageOutputStream} by calling
043         * {@link StorageProvider#createStorageOutputStream() createStorageOutputStream()}
044         * and copies the content of the given input stream to that output stream.
045         * It then calls {@link StorageOutputStream#toStorage()} on the output
046         * stream and returns this object.
047         *
048         * @param in
049         *            stream containing the data to store.
050         * @return a {@link Storage} instance that can be used to retrieve the
051         *         stored content.
052         * @throws IOException
053         *             if an I/O error occurs.
054         */
055        public final Storage store(InputStream in) throws IOException {
056            StorageOutputStream out = createStorageOutputStream();
057            CodecUtil.copy(in, out);
058            return out.toStorage();
059        }
060    
061    }