Skip navigation links

com.bea.wli.sb.sources
Class MimeSource

java.lang.Object
com.bea.wli.sb.sources.MimeSource

All Implemented Interfaces:

Source, java.io.Serializable

public class MimeSource

extends java.lang.Object

implements Source, java.io.Serializable

Source representing arbitrary content with headers. Essentially this is a Source that represents a MIME part. Headers must conform to RFC822 whereas the Source can be any type of source. <p/> The serialization format for this Source is a fully-compliant MIME package. This source is also cognizant of Content-Transfer-Encoding, and it will perform the proper encoding of the underlying content stream if the header is present. Note that this means that the Source provided to the constructor should be in raw form and should not be already encoded.

See Also:

Serialized Form

Field Summary

static java.lang.String

EXCLUDE_HEADERS transform option that tells the source not to include the MIME multipart headers when returning source content as a stream

Fields inherited from interface com.bea.wli.sb.sources.Source

DEFAULT_CHARACTER_SET_ENCODING

Constructor Summary

MimeSource(Headers headers, Source content)

Method Summary

void	addRef()
void	dispose()
Source	getContent()
Headers	getHeaders()
java.io.InputStream	getInputStream(TransformOptions options) Returns streaming byte-baseed representation of the Source's content.
void	makeConcurrent()
void	writeTo(java.io.OutputStream out, TransformOptions options) Serializes the Source's content to a byte-based stream.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXCLUDE_HEADERS

public static final java.lang.String EXCLUDE_HEADERS

transform option that tells the source not to include the MIME multipart headers when returning source content as a stream

See Also:

Constant Field Values

Constructor Detail

MimeSource

public MimeSource(Headers headers,
                  Source content)

Method Detail

getHeaders

public Headers getHeaders()

getContent

public Source getContent()

getInputStream

public java.io.InputStream getInputStream(TransformOptions options)
                                   throws java.io.IOException,
                                          TransformException

Description copied from interface: Source

Returns streaming byte-baseed representation of the Source's content. The representation of that serialization is entirely up to the Source. Note that this method may involve an internal transformation, although it should not in any way change the underlying content.

Specified by:

getInputStream in interface Source

Parameters:

options - Options used to affect the serialization

Returns:

an InputStream for retrieving the serialized content

Throws:

java.io.IOException

TransformException

writeTo

public void writeTo(java.io.OutputStream out,
                    TransformOptions options)
             throws java.io.IOException,
                    TransformException

Description copied from interface: Source

Serializes the Source's content to a byte-based stream. The representation of that serialization is entirely up to the Source. The Source is forbidden from closing the provided OutputStream, although it is allowed to flush it. However, flushing the stream should be left to the caller, if possible. <p/> Note that this method may involve an internal transformation, although it should not in any way change the underlying content.

Specified by:

writeTo in interface Source

Parameters:

out - the OutputStream to which serialized content will be written

options - TransformOptions used to affect the serialization

Throws:

java.io.IOException

TransformException

addRef

public void addRef()

dispose

public void dispose()
             throws java.io.IOException

Throws:

java.io.IOException

makeConcurrent

public void makeConcurrent()
                    throws java.io.IOException

Throws:

java.io.IOException

Skip navigation links