com.helger.as2lib.processor.sender

Class AS2SenderModule

java.lang.Object

com.helger.as2lib.AbstractDynamicComponent

com.helger.as2lib.processor.module.AbstractProcessorModule

com.helger.as2lib.processor.sender.AbstractSenderModule

com.helger.as2lib.processor.sender.AbstractHttpSenderModule

com.helger.as2lib.processor.sender.AS2SenderModule

All Implemented Interfaces:

IDynamicComponent, IProcessorModule, IProcessorSenderModule, Serializable

public class AS2SenderModule
extends AbstractHttpSenderModule

AS2 sender module to send AS2 messages out.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields inherited from class com.helger.as2lib.processor.sender.AbstractHttpSenderModule

ATTR_CONNECT_TIMEOUT, ATTR_READ_TIMEOUT, DEFAULT_CONNECT_TIMEOUT_MS, DEFAULT_READ_TIMEOUT_MS

Fields inherited from class com.helger.as2lib.AbstractDynamicComponent

m_aRWLock

Fields inherited from interface com.helger.as2lib.processor.sender.IProcessorSenderModule

DO_SEND, DO_SEND_ASYNC_MDN

Constructor Summary

Constructors

Constructor and Description
AS2SenderModule()

Method Summary

Modifier and Type	Method and Description
protected String	calculateAndStoreMIC(AS2Message aMsg) From RFC 4130 section 7.3.1: For any signed messages, the MIC to be returned is calculated on the RFC1767/RFC3023 MIME header and content.
boolean	canHandle(String sAction, IMessage aMsg, Map<String,Object> aOptions)
protected void	checkRequired(AS2Message aMsg)
static javax.mail.internet.MimeBodyPart	compressMimeBodyPart(javax.mail.internet.MimeBodyPart aData, ECompressionType eCompressionType, com.helger.mail.cte.EContentTransferEncoding eCTE)
void	handle(String sAction, IMessage aBaseMsg, Map<String,Object> aOptions)
protected void	onReceivedMDNError(AS2Message aMsg, OpenAS2Exception ex) Handler for errors in MDN processing.
protected void	receiveSyncMDN(AS2Message aMsg, IAS2HttpConnection aConn, String sOriginalMIC)
protected javax.mail.internet.MimeBodyPart	secure(IMessage aMsg, com.helger.mail.cte.EContentTransferEncoding eCTE)
static javax.mail.internet.MimeBodyPart	secureMimeBodyPart(javax.mail.internet.MimeBodyPart aSrcPart, com.helger.mail.cte.EContentTransferEncoding eCTE, ECompressionType eCompressionType, boolean bCompressBeforeSign, Consumer<javax.mail.internet.MimeBodyPart> aCompressBeforeSignCallback, ECryptoAlgorithmSign eSignAlgorithm, X509Certificate aSenderCert, PrivateKey aSenderKey, boolean bIncludeCertificateInSignedContent, boolean bUseRFC3851MICAlg, ECryptoAlgorithmCrypt eCryptAlgorithm, X509Certificate aReceiverCert)
protected void	storePendingInfo(AS2Message aMsg, String sMIC) for storing original mic and outgoing file into pending information file
protected void	updateHttpHeaders(IAS2HttpHeaderWrapper aConn, IMessage aMsg) Update the HTTP headers based on the provided message, before sending takes place.

Methods inherited from class com.helger.as2lib.processor.sender.AbstractHttpSenderModule

createHostnameVerifier, createSSLContext, getHttpClient, getHttpURLConnection

Methods inherited from class com.helger.as2lib.processor.sender.AbstractSenderModule

doResend, getRetryCount

Methods inherited from class com.helger.as2lib.AbstractDynamicComponent

attrs, equals, getAttributeAsIntRequired, getAttributeAsStringRequired, getName, getSession, hashCode, initDynamicComponent, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.as2lib.IDynamicComponent

attrs, getName, getSession, initDynamicComponent

Constructor Detail

AS2SenderModule

public AS2SenderModule()

Method Detail

canHandle

public boolean canHandle(@Nonnull
                         String sAction,
                         @Nonnull
                         IMessage aMsg,
                         @Nullable
                         Map<String,Object> aOptions)

checkRequired

protected void checkRequired(@Nonnull
                             AS2Message aMsg)
                      throws InvalidParameterException

Throws:

InvalidParameterException

storePendingInfo

protected void storePendingInfo(@Nonnull
                                AS2Message aMsg,
                                @Nonnull
                                String sMIC)
                         throws OpenAS2Exception

for storing original mic and outgoing file into pending information file

Parameters:

aMsg - AS2Message

sMIC - MIC value

Throws:

OpenAS2Exception - In case of an error

calculateAndStoreMIC

@Nonnull
 @Nonempty
protected String calculateAndStoreMIC(@Nonnull
                                                            AS2Message aMsg)
                                                     throws Exception

From RFC 4130 section 7.3.1:

• For any signed messages, the MIC to be returned is calculated on the RFC1767/RFC3023 MIME header and content. Canonicalization on the MIME headers MUST be performed before the MIC is calculated, since the sender requesting the signed receipt was also REQUIRED to canonicalize.
• For encrypted, unsigned messages, the MIC to be returned is calculated on the decrypted RFC 1767/RFC3023 MIME header and content. The content after decryption MUST be canonicalized before the MIC is calculated.
• For unsigned, unencrypted messages, the MIC MUST be calculated over the message contents without the MIME or any other RFC 2822 headers, since these are sometimes altered or reordered by Mail Transport Agents (MTAs).

So headers must be included if signing or crypting is enabled.

From RFC 5402 section 4.1:

• MIC Calculation for Signed Message: For any signed message, the MIC to be returned is calculated over the same data that was signed in the original message as per [AS1]. The signed content will be a MIME bodypart that contains either compressed or uncompressed data.
• MIC Calculation for Encrypted, Unsigned Message: For encrypted, unsigned messages, the MIC to be returned is calculated over the uncompressed data content including all MIME header fields and any applied Content-Transfer-Encoding.
• MIC Calculation for Unencrypted, Unsigned Message: For unsigned, unencrypted messages, the MIC is calculated over the uncompressed data content including all MIME header fields and any applied Content-Transfer-Encoding

So headers must always be included if compression is enabled.

Parameters:

aMsg - Source message

Returns:

MIC value. Neither null nor empty.

Throws:

Exception - On security or AS2 issues

compressMimeBodyPart

@Nonnull
public static javax.mail.internet.MimeBodyPart compressMimeBodyPart(@Nonnull
                                                                              javax.mail.internet.MimeBodyPart aData,
                                                                              @Nonnull
                                                                              ECompressionType eCompressionType,
                                                                              @Nonnull
                                                                              com.helger.mail.cte.EContentTransferEncoding eCTE)
                                                                       throws org.bouncycastle.mail.smime.SMIMEException

Throws:

org.bouncycastle.mail.smime.SMIMEException

secureMimeBodyPart

@Nonnull
public static javax.mail.internet.MimeBodyPart secureMimeBodyPart(@Nonnull
                                                                            javax.mail.internet.MimeBodyPart aSrcPart,
                                                                            @Nonnull
                                                                            com.helger.mail.cte.EContentTransferEncoding eCTE,
                                                                            @Nullable
                                                                            ECompressionType eCompressionType,
                                                                            boolean bCompressBeforeSign,
                                                                            @Nullable
                                                                            Consumer<javax.mail.internet.MimeBodyPart> aCompressBeforeSignCallback,
                                                                            @Nullable
                                                                            ECryptoAlgorithmSign eSignAlgorithm,
                                                                            @Nullable
                                                                            X509Certificate aSenderCert,
                                                                            @Nullable
                                                                            PrivateKey aSenderKey,
                                                                            boolean bIncludeCertificateInSignedContent,
                                                                            boolean bUseRFC3851MICAlg,
                                                                            @Nullable
                                                                            ECryptoAlgorithmCrypt eCryptAlgorithm,
                                                                            @Nullable
                                                                            X509Certificate aReceiverCert)
                                                                     throws Exception

Throws:

Exception

secure

@Nonnull
protected javax.mail.internet.MimeBodyPart secure(@Nonnull
                                                            IMessage aMsg,
                                                            @Nonnull
                                                            com.helger.mail.cte.EContentTransferEncoding eCTE)
                                                     throws Exception

Throws:

Exception

updateHttpHeaders

protected void updateHttpHeaders(@Nonnull
                                 IAS2HttpHeaderWrapper aConn,
                                 @Nonnull
                                 IMessage aMsg)

Update the HTTP headers based on the provided message, before sending takes place.

Parameters:

aConn - The connection abstraction. Never null.

aMsg - The message to be send. Never null.

receiveSyncMDN

protected void receiveSyncMDN(@Nonnull
                              AS2Message aMsg,
                              @Nonnull
                              IAS2HttpConnection aConn,
                              @Nonnull
                              String sOriginalMIC)
                       throws OpenAS2Exception,
                              IOException

Parameters:

aMsg - AS2Message

aConn - URLConnection

sOriginalMIC - mic value from original msg

Throws:

OpenAS2Exception - in case of an error

IOException - in case of an IO error

onReceivedMDNError

@OverrideOnDemand
protected void onReceivedMDNError(@Nonnull
                                                     AS2Message aMsg,
                                                     @Nonnull
                                                     OpenAS2Exception ex)
                                              throws OpenAS2Exception

Handler for errors in MDN processing.

Parameters:

aMsg - The source message that was send

ex - The exception that was caught

Throws:

OpenAS2Exception - In case an overload wants to throw the exception

handle

public void handle(@Nonnull
                   String sAction,
                   @Nonnull
                   IMessage aBaseMsg,
                   @Nullable
                   Map<String,Object> aOptions)
            throws OpenAS2Exception

Throws:

OpenAS2Exception