com.helger.phase4.attachment

Class WSS4JAttachment

java.lang.Object

org.apache.wss4j.common.ext.Attachment

com.helger.phase4.attachment.WSS4JAttachment

All Implemented Interfaces:

IAS4Attachment

@NotThreadSafe
public class WSS4JAttachment
extends org.apache.wss4j.common.ext.Attachment
implements IAS4Attachment

Special WSS4J attachment with an InputStream provider instead of a fixed InputStream
Note: cannot be serializable because base class is not serializable and because we're dealing with InputStreams.

Author:

bayerlma, Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_DESCRIPTION_ATTACHMENT
static String	CONTENT_ID_PREFIX
static String	CONTENT_ID_SUFFIX

Constructor Summary

Constructors

Constructor and Description
WSS4JAttachment(AS4ResourceHelper aResHelper, String sMimeType)

Method Summary

Modifier and Type	Method and Description
void	addHeader(String sName, String sValue)
void	addToMimeMultipart(javax.mail.internet.MimeMultipart aMimeMultipart)
static boolean	canBeKeptInMemory(long nBytes) Check if an incoming attachment can be kept in memory, or if a temporary file is needed.
static WSS4JAttachment	createIncomingFileAttachment(javax.mail.internet.MimeBodyPart aBodyPart, AS4ResourceHelper aResHelper)
static WSS4JAttachment	createOutgoingFileAttachment(byte[] aSrcData, String sContentID, String sFilename, com.helger.commons.mime.IMimeType aMimeType, EAS4CompressionMode eCompressionMode, AS4ResourceHelper aResHelper) Quasi constructor.
static WSS4JAttachment	createOutgoingFileAttachment(File aSrcFile, com.helger.commons.mime.IMimeType aMimeType, EAS4CompressionMode eCompressionMode, AS4ResourceHelper aResHelper)
static WSS4JAttachment	createOutgoingFileAttachment(File aSrcFile, String sContentID, com.helger.commons.mime.IMimeType aMimeType, EAS4CompressionMode eCompressionMode, AS4ResourceHelper aResHelper)
static WSS4JAttachment	createOutgoingFileAttachment(File aSrcFile, String sContentID, String sFilename, com.helger.commons.mime.IMimeType aMimeType, EAS4CompressionMode eCompressionMode, AS4ResourceHelper aResHelper) Quasi constructor.
Charset	getCharsetOrDefault(Charset aDefault)
EAS4CompressionMode	getCompressionMode()
com.helger.mail.cte.EContentTransferEncoding	getContentTransferEncoding()
com.helger.commons.io.IHasInputStream	getInputStreamProvider()
AS4ResourceHelper	getResHelper()
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()
void	overwriteMimeType(String sMimeType)
WSS4JAttachment	setCharset(Charset aCharset)
WSS4JAttachment	setCompressionMode(EAS4CompressionMode eCompressionMode)
WSS4JAttachment	setContentTransferEncoding(com.helger.mail.cte.EContentTransferEncoding eCTE)
void	setMimeType(String sMimeType) Deprecated.
void	setSourceStream(InputStream sourceStream) Deprecated. Do not use this, because it can be opened only once. Use setSourceStreamProvider(IHasInputStream) instead.
void	setSourceStreamProvider(com.helger.commons.io.IHasInputStream aISP)
void	setUniqueID() Create a random UUID based ID and call Attachment.setId(String)
String	toString()

Methods inherited from class org.apache.wss4j.common.ext.Attachment

addHeaders, getHeaders, getId, getMimeType, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.phase4.attachment.IAS4Attachment

getCharset, getId, getMimeType, hasCompressionMode, isRepeatable

Field Detail

CONTENT_DESCRIPTION_ATTACHMENT

public static final String CONTENT_DESCRIPTION_ATTACHMENT

See Also:

Constant Field Values

CONTENT_ID_PREFIX

public static final String CONTENT_ID_PREFIX

See Also:

Constant Field Values

CONTENT_ID_SUFFIX

public static final String CONTENT_ID_SUFFIX

See Also:

Constant Field Values

Constructor Detail

WSS4JAttachment

public WSS4JAttachment(@Nonnull @WillNotClose
                       AS4ResourceHelper aResHelper,
                       @Nullable
                       String sMimeType)

Method Detail

getResHelper

@Nonnull
public final AS4ResourceHelper getResHelper()

Returns:

The resource helper provided in the constructor. Never null.

setUniqueID

public void setUniqueID()

Create a random UUID based ID and call Attachment.setId(String)

setMimeType

@Deprecated
 @UnsupportedOperation
public final void setMimeType(@Nullable
                                                                   String sMimeType)

Deprecated.

Overrides:

setMimeType in class org.apache.wss4j.common.ext.Attachment

overwriteMimeType

public final void overwriteMimeType(@Nullable
                                    String sMimeType)

addHeader

public final void addHeader(String sName,
                            String sValue)

Overrides:

addHeader in class org.apache.wss4j.common.ext.Attachment

getUncompressedMimeType

@Nullable
public String getUncompressedMimeType()

Specified by:

getUncompressedMimeType in interface IAS4Attachment

Returns:

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

getSourceStream

@Nonnull
public InputStream getSourceStream()

Description copied from interface: IAS4Attachment

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

Specified by:

getSourceStream in interface IAS4Attachment

Overrides:

getSourceStream in class org.apache.wss4j.common.ext.Attachment

Returns:

A non-null InputStream on the source.

getSourceStream

@Nonnull
public InputStream getSourceStream(@Nonnull
                                             AS4ResourceHelper aResourceHelper)

Description copied from interface: IAS4Attachment

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.

Specified by:

getSourceStream in interface IAS4Attachment

Parameters:

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

Returns:

A non-null InputStream on the source.

setSourceStream

@Deprecated
 @UnsupportedOperation
public void setSourceStream(InputStream sourceStream)

Deprecated. Do not use this, because it can be opened only once. Use setSourceStreamProvider(IHasInputStream) instead.

Overrides:

setSourceStream in class org.apache.wss4j.common.ext.Attachment

getInputStreamProvider

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

Specified by:

getInputStreamProvider in interface IAS4Attachment

setSourceStreamProvider

public void setSourceStreamProvider(@Nonnull
                                    com.helger.commons.io.IHasInputStream aISP)

getContentTransferEncoding

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

Specified by:

getContentTransferEncoding in interface IAS4Attachment

Returns:

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

setContentTransferEncoding

@Nonnull
public final WSS4JAttachment setContentTransferEncoding(@Nonnull
                                                                  com.helger.mail.cte.EContentTransferEncoding eCTE)

getCompressionMode

@Nullable
public final EAS4CompressionMode getCompressionMode()

Specified by:

getCompressionMode in interface IAS4Attachment

Returns:

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

setCompressionMode

@Nonnull
public final WSS4JAttachment setCompressionMode(@Nonnull
                                                          EAS4CompressionMode eCompressionMode)

getCharsetOrDefault

@Nullable
public final Charset getCharsetOrDefault(@Nullable
                                                    Charset aDefault)

Specified by:

getCharsetOrDefault in interface IAS4Attachment

hasCharset

public final boolean hasCharset()

Specified by:

hasCharset in interface IAS4Attachment

setCharset

@Nonnull
public final WSS4JAttachment setCharset(@Nullable
                                                  Charset aCharset)

addToMimeMultipart

public void addToMimeMultipart(@Nonnull
                               javax.mail.internet.MimeMultipart aMimeMultipart)
                        throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

toString

public String toString()

Overrides:

toString in class Object

createOutgoingFileAttachment

@Nonnull
public static WSS4JAttachment createOutgoingFileAttachment(@Nonnull
                                                                     File aSrcFile,
                                                                     @Nonnull
                                                                     com.helger.commons.mime.IMimeType aMimeType,
                                                                     @Nullable
                                                                     EAS4CompressionMode eCompressionMode,
                                                                     @Nonnull
                                                                     AS4ResourceHelper aResHelper)
                                                              throws IOException

Throws:

IOException

createOutgoingFileAttachment

@Nonnull
public static WSS4JAttachment createOutgoingFileAttachment(@Nonnull
                                                                     File aSrcFile,
                                                                     @Nullable
                                                                     String sContentID,
                                                                     @Nonnull
                                                                     com.helger.commons.mime.IMimeType aMimeType,
                                                                     @Nullable
                                                                     EAS4CompressionMode eCompressionMode,
                                                                     @Nonnull @WillNotClose
                                                                     AS4ResourceHelper aResHelper)
                                                              throws IOException

Throws:

IOException

createOutgoingFileAttachment

@Nonnull
public static WSS4JAttachment createOutgoingFileAttachment(@Nonnull
                                                                     File aSrcFile,
                                                                     @Nullable
                                                                     String sContentID,
                                                                     @Nullable
                                                                     String sFilename,
                                                                     @Nonnull
                                                                     com.helger.commons.mime.IMimeType aMimeType,
                                                                     @Nullable
                                                                     EAS4CompressionMode eCompressionMode,
                                                                     @Nonnull @WillNotClose
                                                                     AS4ResourceHelper aResHelper)
                                                              throws IOException

Quasi constructor. Performs compression internally if necessary.

Parameters:

aSrcFile - Source, uncompressed, unencrypted file.

sContentID - Content-ID of the attachment. If null a random ID is created.

sFilename - Filename of the attachment. May be null in which case no `Content-Disposition` header is created.

aMimeType - Original mime type of the file.

eCompressionMode - Optional compression mode to use. May be null.

aResHelper - The resource manager to use. May not be null.

Returns:

The newly created attachment instance. Never null.

Throws:

IOException - In case something goes wrong during compression

createOutgoingFileAttachment

@Nonnull
public static WSS4JAttachment createOutgoingFileAttachment(@Nonnull
                                                                     byte[] aSrcData,
                                                                     @Nullable
                                                                     String sContentID,
                                                                     @Nullable
                                                                     String sFilename,
                                                                     @Nonnull
                                                                     com.helger.commons.mime.IMimeType aMimeType,
                                                                     @Nullable
                                                                     EAS4CompressionMode eCompressionMode,
                                                                     @Nonnull
                                                                     AS4ResourceHelper aResHelper)
                                                              throws IOException

Quasi constructor. Performs compression internally.

Parameters:

aSrcData - Source in-memory data, uncompressed, unencrypted.

sContentID - Optional content ID or null to create a random one. Filename of the attachment. May be null in which case no `Content-Disposition` header is created.

aMimeType - Original mime type of the file. May not be null.

eCompressionMode - Optional compression mode to use. May be null.

aResHelper - The resource manager to use. May not be null.

Returns:

The newly created attachment instance. Never null.

Throws:

IOException - In case something goes wrong during compression

canBeKeptInMemory

public static boolean canBeKeptInMemory(long nBytes)

Check if an incoming attachment can be kept in memory, or if a temporary file is needed.

Parameters:

nBytes - File size.

Returns:

true if the size is ≤ than 64 Kilobytes

createIncomingFileAttachment

@Nonnull
public static WSS4JAttachment createIncomingFileAttachment(@Nonnull
                                                                     javax.mail.internet.MimeBodyPart aBodyPart,
                                                                     @Nonnull
                                                                     AS4ResourceHelper aResHelper)
                                                              throws javax.mail.MessagingException,
                                                                     IOException

Throws:

javax.mail.MessagingException

IOException