com.helger.phase4.attachment

Interface IAS4Attachment

All Known Implementing Classes:

WSS4JAttachment

public interface IAS4Attachment

Read-only interface for an attachment.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default Charset	getCharset()
Charset	getCharsetOrDefault(Charset aDefault)
EAS4CompressionMode	getCompressionMode()
com.helger.mail.cte.EContentTransferEncoding	getContentTransferEncoding()
String	getId()
com.helger.commons.io.IHasInputStream	getInputStreamProvider()
String	getMimeType()
InputStream	getSourceStream() Get the source stream of the attachment using the default resource helper.
InputStream	getSourceStream(AS4ResourceHelper aResourceHelper) Get the source stream of the attachment using the provided resource helper.
String	getUncompressedMimeType()
boolean	hasCharset()
default boolean	hasCompressionMode()
default boolean	isRepeatable()

Method Detail

getId

String getId()

getMimeType

String getMimeType()

getUncompressedMimeType

@Nullable
String getUncompressedMimeType()

Returns:

The MIME type of the uncompressed attachment. May be null.

getSourceStream

@Nonnull
InputStream getSourceStream()

Get the source stream of the attachment using the default resource helper.

Returns:

A non-null InputStream on the source.

getSourceStream

@Nonnull
InputStream getSourceStream(@Nonnull
                                      AS4ResourceHelper aResourceHelper)

Get the source stream of the attachment using the provided resource helper. This can be helpful, if the source helper is already out of scope.

Parameters:

aResourceHelper - The resource helper to use. May not be null.

Returns:

A non-null InputStream on the source.

getInputStreamProvider

@Nullable
com.helger.commons.io.IHasInputStream getInputStreamProvider()

isRepeatable

default boolean isRepeatable()

getContentTransferEncoding

@Nonnull
com.helger.mail.cte.EContentTransferEncoding getContentTransferEncoding()

Returns:

The content transfer encoding to be used. Required for MIME multipart handling only. May not be null.

getCompressionMode

@Nullable
EAS4CompressionMode getCompressionMode()

Returns:

The compression mode to use or null if the attachment is not compressed.

hasCompressionMode

default boolean hasCompressionMode()

getCharset

@Nonnull
default Charset getCharset()

getCharsetOrDefault

@Nullable
Charset getCharsetOrDefault(@Nullable
                                       Charset aDefault)

hasCharset

boolean hasCharset()