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.message;
021
022 import java.io.IOException;
023 import java.io.InputStream;
024
025 import org.apache.james.mime4j.dom.BinaryBody;
026 import org.apache.james.mime4j.dom.TextBody;
027
028 /**
029 * Factory for creating message bodies.
030 */
031 public interface BodyFactory {
032
033 /**
034 * Creates a {@link BinaryBody} that holds the content of the given input
035 * stream.
036 *
037 * @param is
038 * input stream to create a message body from.
039 * @return a binary body.
040 * @throws IOException
041 * if an I/O error occurs.
042 */
043 BinaryBody binaryBody(InputStream is) throws IOException;
044
045 /**
046 * Creates a {@link TextBody} that holds the content of the given input
047 * stream.
048 * <p>
049 * The charset corresponding to the given MIME charset name is used to
050 * decode the byte content of the input stream into a character stream when
051 * calling {@link TextBody#getReader() getReader()} on the returned object.
052 * If the MIME charset has no corresponding Java charset or the Java charset
053 * cannot be used for decoding then "us-ascii" is used instead.
054 *
055 * @param is
056 * input stream to create a message body from.
057 * @param mimeCharset
058 * name of a MIME charset.
059 * @return a text body.
060 * @throws IOException
061 * if an I/O error occurs.
062 */
063 TextBody textBody(InputStream is, String mimeCharset) throws IOException;
064
065 }