com.helger.as2lib.processor.receiver.net

Class AS2ReceiverHandler

java.lang.Object

com.helger.as2lib.processor.receiver.net.AbstractReceiverHandler

com.helger.as2lib.processor.receiver.net.AS2ReceiverHandler

All Implemented Interfaces:

INetModuleHandler

public class AS2ReceiverHandler
extends AbstractReceiverHandler

The main handler for receiving AS2 messages.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_SEND_EXCEPTION_STACKTRACE_IN_MDN
static boolean	DEFAULT_SEND_EXCEPTIONS_IN_MDN

Constructor Summary

Constructors

Constructor and Description
AS2ReceiverHandler(AS2ReceiverModule aModule)

Method Summary

Modifier and Type	Method and Description
protected AS2Message	createMessage(Socket aSocket) Create a new message and record the source ip and port
protected void	decompress(IMessage aMsg)
protected void	decrypt(IMessage aMsg, AS2ResourceHelper aResHelper)
protected AS2ReceiverModule	getReceiverModule()
void	handle(AbstractActiveNetModule aOwner, Socket aSocket)
void	handleIncomingMessage(String sClientInfo, DataSource aMsgData, AS2Message aMsg, IAS2HttpResponseHandler aResponseHandler) This method can be used to handle an incoming HTTP message AFTER the headers where extracted.
boolean	isSendExceptionsInMDN()
boolean	isSendExceptionStackTraceInMDN() This method is only evaluated, if isSendExceptionsInMDN() returns true.
protected void	sendMDN(String sClientInfo, IAS2HttpResponseHandler aResponseHandler, AS2Message aMsg, DispositionType aDisposition, String sText, com.helger.commons.state.ESuccess eSuccess)
AS2ReceiverHandler	setSendExceptionsInMDN(boolean bSendExceptionsInMDN)
AS2ReceiverHandler	setSendExceptionStackTraceInMDN(boolean bSendExceptionStackTraceInMDN) This setting is only evaluated, if isSendExceptionsInMDN() returns true.
protected void	verify(IMessage aMsg, AS2ResourceHelper aResHelper)

Methods inherited from class com.helger.as2lib.processor.receiver.net.AbstractReceiverHandler

getClientInfo, getEffectiveHttpIncomingDumper, getHttpIncomingDumper, getVerificationCertificateConsumer, setHttpIncomingDumper, setVerificationCertificateConsumer

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SEND_EXCEPTIONS_IN_MDN

public static final boolean DEFAULT_SEND_EXCEPTIONS_IN_MDN

See Also:

Constant Field Values

DEFAULT_SEND_EXCEPTION_STACKTRACE_IN_MDN

public static final boolean DEFAULT_SEND_EXCEPTION_STACKTRACE_IN_MDN

See Also:

Constant Field Values

Constructor Detail

AS2ReceiverHandler

public AS2ReceiverHandler(@Nonnull
                          AS2ReceiverModule aModule)

Parameters:

aModule - The receiver module to be used. May not be null. Required for the session and the error handling.

Method Detail

getReceiverModule

@Nonnull
protected final AS2ReceiverModule getReceiverModule()

Returns:

The receiver module provided in the constructor. Never null.

isSendExceptionsInMDN

public final boolean isSendExceptionsInMDN()

Returns:

true if exceptions should be send in the MDN, false if not. Default is DEFAULT_SEND_EXCEPTIONS_IN_MDN

Since:

4.4.2

setSendExceptionsInMDN

@Nonnull
public final AS2ReceiverHandler setSendExceptionsInMDN(boolean bSendExceptionsInMDN)

Parameters:

bSendExceptionsInMDN - true to send back exception in the MDN, false if not.

Returns:

this for chaining

Since:

4.4.2

isSendExceptionStackTraceInMDN

public final boolean isSendExceptionStackTraceInMDN()

This method is only evaluated, if isSendExceptionsInMDN() returns true.

Returns:

true if exception stack traces should be send in the MDN, false if not. Default is DEFAULT_SEND_EXCEPTION_STACKTRACE_IN_MDN.

Since:

4.4.6

setSendExceptionStackTraceInMDN

@Nonnull
public final AS2ReceiverHandler setSendExceptionStackTraceInMDN(boolean bSendExceptionStackTraceInMDN)

This setting is only evaluated, if isSendExceptionsInMDN() returns true.

Parameters:

bSendExceptionStackTraceInMDN - true to send back exception stack traces in the MDN, false if not.

Returns:

this for chaining

Since:

4.4.6

createMessage

@Nonnull
protected AS2Message createMessage(@Nonnull
                                             Socket aSocket)

Create a new message and record the source ip and port

Parameters:

aSocket - The socket through which the message will be read.

Returns:

The AS2Message to use and never null.

decrypt

protected void decrypt(@Nonnull
                       IMessage aMsg,
                       @Nonnull
                       AS2ResourceHelper aResHelper)
                throws AS2Exception

Throws:

AS2Exception

verify

protected void verify(@Nonnull
                      IMessage aMsg,
                      @Nonnull
                      AS2ResourceHelper aResHelper)
               throws AS2Exception

Throws:

AS2Exception

decompress

protected void decompress(@Nonnull
                          IMessage aMsg)
                   throws AS2DispositionException

Throws:

AS2DispositionException

sendMDN

protected void sendMDN(@Nonnull
                       String sClientInfo,
                       @Nonnull
                       IAS2HttpResponseHandler aResponseHandler,
                       @Nonnull
                       AS2Message aMsg,
                       @Nonnull
                       DispositionType aDisposition,
                       @Nonnull
                       String sText,
                       @Nonnull
                       com.helger.commons.state.ESuccess eSuccess)

handleIncomingMessage

public void handleIncomingMessage(@Nonnull
                                  String sClientInfo,
                                  @Nonnull
                                  DataSource aMsgData,
                                  @Nonnull
                                  AS2Message aMsg,
                                  @Nonnull
                                  IAS2HttpResponseHandler aResponseHandler)

This method can be used to handle an incoming HTTP message AFTER the headers where extracted.

Parameters:

sClientInfo - Client connection info

aMsgData - The message body

aMsg - The AS2 message that will be filled by this method

aResponseHandler - The response handler which handles HTTP error messages as well as synchronous MDN.

handle

public void handle(@Nonnull
                   AbstractActiveNetModule aOwner,
                   @Nonnull
                   Socket aSocket)