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

public class AS2SenderModule
extends AbstractHttpSenderModule

AS2 sender module to send AS2 messages out.

Author:

Philip Helger

Field Summary

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

ATTR_CONNECT_TIMEOUT, ATTR_QUOTE_HEADER_VALUES, ATTR_RESPONSE_TIMEOUT, DEFAULT_CONNECT_TIMEOUT, DEFAULT_QUOTE_HEADER_VALUES, DEFAULT_RESPONSE_TIMEOUT

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 MIC	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)
boolean	equals(Object o)
IAS2IncomingMDNCallback	getIncomingMDNCallback()
IMICMatchingHandler	getMICMatchingHandler()
Consumer<? super X509Certificate>	getVerificationCertificateConsumer()
void	handle(String sAction, IMessage aBaseMsg, Map<String,Object> aOptions)
int	hashCode()
protected void	onReceivedMDNError(AS2Message aMsg, AS2Exception ex) Handler for errors in MDN processing.
protected OutputStream	openPendingInfoStreamForWriting(AS2Message aMsg, String sMsgFilename) Override this method to store pending MDN messages somewhere else than on disc.
protected void	receiveSyncMDN(AS2Message aMsg, AS2HttpClient aHttpClient, MIC aOriginalMIC, IHTTPIncomingDumper aIncomingDumper, AS2ResourceHelper aResHelper)
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, boolean bRemoveCmsAlgorithmProtect, ECryptoAlgorithmCrypt eCryptAlgorithm, X509Certificate aReceiverCert, String sLoggingText)
void	setIncomingMDNCallback(IAS2IncomingMDNCallback aIMC) Set the incoming MDN callback that is invoked for each received MDN.
AS2SenderModule	setMICMatchingHandler(IMICMatchingHandler aMICMatchingHandler) Set the MIC matching handler to used.
AS2SenderModule	setVerificationCertificateConsumer(Consumer<? super X509Certificate> aVerificationCertificateConsumer) Set the consumer for the effective certificate upon signature verification.
protected void	storePendingInfo(AS2Message aMsg, MIC aMIC) For storing original MIC and outgoing file into pending information file.
protected void	updateHttpHeaders(AS2HttpHeaderSetter aHeaderSetter, 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, getConnectTimeout, getEffectiveHttpIncomingDumper, getHttpClient, getHttpIncomingDumper, getHttpOutgoingDumper, getHttpOutgoingDumperFactory, getOutgoingHttpCallback, getResponseTimeout, isQuoteHeaderValues, isUseSSL, setConnectTimeoutMilliseconds, setHttpIncomingDumper, setHttpOutgoingDumperFactory, setOutgoingHttpCallback, setQuoteHeaderValues, setResponseTimeoutMilliseconds

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

doResend, getRetryCount

Methods inherited from class com.helger.as2lib.AbstractDynamicComponent

attrs, getAttributeAsIntRequired, getAttributeAsStringRequired, getName, getSession, 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

getMICMatchingHandler

@Nonnull
public final IMICMatchingHandler getMICMatchingHandler()

Returns:

The current MIC matching handler. Never null.

Since:

4.4.0

setMICMatchingHandler

@Nonnull
public final AS2SenderModule setMICMatchingHandler(@Nonnull
                                                             IMICMatchingHandler aMICMatchingHandler)

Set the MIC matching handler to used.

Parameters:

aMICMatchingHandler - The new handler. May not be null.

Returns:

this for chaining

Since:

4.4.0

getIncomingMDNCallback

@Nullable
public final IAS2IncomingMDNCallback getIncomingMDNCallback()

Returns:

The incoming MDN callback. May be null.

Since:

v4.7.1

setIncomingMDNCallback

public final void setIncomingMDNCallback(@Nullable
                                         IAS2IncomingMDNCallback aIMC)

Set the incoming MDN callback that is invoked for each received MDN.

Parameters:

aIMC - The callback to be invoked. May be null.

Since:

v4.7.1

getVerificationCertificateConsumer

@Nullable
public final Consumer<? super X509Certificate> getVerificationCertificateConsumer()

Returns:

The consumer for the effective certificate upon signature verification. May be null. The default is null.

Since:

4.4.1

setVerificationCertificateConsumer

@Nonnull
public final AS2SenderModule setVerificationCertificateConsumer(@Nullable
                                                                          Consumer<? super X509Certificate> aVerificationCertificateConsumer)

Set the consumer for the effective certificate upon signature verification.

Parameters:

aVerificationCertificateConsumer - The consumer to be used. May be null.

Returns:

this for chaining

Since:

4.4.1

canHandle

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

checkRequired

protected void checkRequired(@Nonnull
                             AS2Message aMsg)
                      throws AS2InvalidParameterException

Throws:

AS2InvalidParameterException

openPendingInfoStreamForWriting

@Nullable
 @OverrideOnDemand
protected OutputStream openPendingInfoStreamForWriting(@Nonnull
                                                                                      AS2Message aMsg,
                                                                                      @Nonnull @Nonempty
                                                                                      String sMsgFilename)
                                                                               throws AS2Exception

Override this method to store pending MDN messages somewhere else than on disc.

Parameters:

aMsg - The message for which an async MDN is requested. Never null.

sMsgFilename - The filename (without the path), derived from the Message ID, in which the data should be stored.

Returns:

null if the configuration is not correct.

Throws:

AS2Exception - In case of an error

Since:

4.10.2

storePendingInfo

protected void storePendingInfo(@Nonnull
                                AS2Message aMsg,
                                @Nonnull
                                MIC aMIC)
                         throws AS2Exception

For storing original MIC and outgoing file into pending information file. Override this method if you want to store the pending MDN information in a separate data storage like a DB etc.

Parameters:

aMsg - AS2Message. May not be null.

aMIC - MIC value. May not be null.

Throws:

AS2Exception - In case of an error

calculateAndStoreMIC

@Nonnull
protected MIC 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,
                                                                            boolean bRemoveCmsAlgorithmProtect,
                                                                            @Nullable
                                                                            ECryptoAlgorithmCrypt eCryptAlgorithm,
                                                                            @Nullable
                                                                            X509Certificate aReceiverCert,
                                                                            @Nonnull
                                                                            String sLoggingText)
                                                                     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
                                 AS2HttpHeaderSetter aHeaderSetter,
                                 @Nonnull
                                 IMessage aMsg)

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

Parameters:

aHeaderSetter - The connection abstraction. Never null.

aMsg - The message to be send. Never null.

receiveSyncMDN

protected void receiveSyncMDN(@Nonnull
                              AS2Message aMsg,
                              @Nonnull
                              AS2HttpClient aHttpClient,
                              @Nonnull
                              MIC aOriginalMIC,
                              @Nullable
                              IHTTPIncomingDumper aIncomingDumper,
                              @Nonnull
                              AS2ResourceHelper aResHelper)
                       throws AS2Exception,
                              IOException

Parameters:

aMsg - AS2Message

aHttpClient - URLConnection

aOriginalMIC - mic value from original msg

aIncomingDumper - Incoming dumper. May be null.

aResHelper - Resource helper

Throws:

AS2Exception - in case of an error

IOException - in case of an IO error

onReceivedMDNError

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

Handler for errors in MDN processing.

Parameters:

aMsg - The source message that was send

ex - The exception that was caught

Throws:

AS2Exception - 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 AS2Exception

Throws:

AS2Exception

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractDynamicComponent

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDynamicComponent