com.helger.as2servlet

Class AbstractAS2ReceiveXServletHandler

java.lang.Object

com.helger.as2servlet.AbstractAS2ReceiveXServletHandler

All Implemented Interfaces:

com.helger.xservlet.handler.IXServletBasicHandler, com.helger.xservlet.handler.IXServletHandler, Serializable

Direct Known Subclasses:

AS2ReceiveXServletHandlerFileBasedConfig

public abstract class AbstractAS2ReceiveXServletHandler
extends Object
implements com.helger.xservlet.handler.IXServletHandler

This is the main XServlet handler that takes AS2 messages and processes them. This class contains a lot of methods that may be overridden. So simply subclass this class and create your own Servlet as in AS2ReceiveServlet.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVLET_INIT_PARAM_AS2_SERVLET_CONFIG_FILENAME The name of the Servlet's init-parameter from which the absolute path to the configuration file is read.

Constructor Summary

Constructors

Constructor and Description
AbstractAS2ReceiveXServletHandler()

Method Summary

Modifier and Type	Method and Description
protected abstract com.helger.as2lib.session.AS2Session	createAS2Session(com.helger.commons.collection.impl.ICommonsMap<String,String> aInitParams) Create the AS2 session to be used based on the provided configuration file.
protected com.helger.as2lib.processor.receiver.AS2ReceiverModule	getReceiverModule()
protected com.helger.as2lib.session.AS2Session	getSession()
protected void	handeIncomingMessage(javax.servlet.http.HttpServletRequest aHttpRequest, javax.servlet.http.HttpServletResponse aHttpResponse, com.helger.web.scope.IRequestWebScope aRequestScope, byte[] aMsgData, com.helger.as2lib.message.AS2Message aMsg, AS2OutputStreamCreatorHttpServletResponse aResponseHandler) Main handling method
void	onRequest(javax.servlet.http.HttpServletRequest aHttpRequest, javax.servlet.http.HttpServletResponse aHttpResponse, com.helger.http.EHttpVersion eHttpVersion, com.helger.commons.http.EHttpMethod eHttpMethod, com.helger.web.scope.IRequestWebScope aRequestScope)
void	onServletInit(com.helger.commons.collection.impl.ICommonsMap<String,String> aInitParams)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.xservlet.handler.IXServletBasicHandler

onServletDestroy

Field Detail

SERVLET_INIT_PARAM_AS2_SERVLET_CONFIG_FILENAME

public static final String SERVLET_INIT_PARAM_AS2_SERVLET_CONFIG_FILENAME

The name of the Servlet's init-parameter from which the absolute path to the configuration file is read.

See Also:

Constant Field Values

Constructor Detail

AbstractAS2ReceiveXServletHandler

public AbstractAS2ReceiveXServletHandler()

Method Detail

createAS2Session

@Nonnull
 @OverrideOnDemand
protected abstract com.helger.as2lib.session.AS2Session createAS2Session(@Nonnull
                                                                                                       com.helger.commons.collection.impl.ICommonsMap<String,String> aInitParams)
                                                                                                throws com.helger.as2lib.exception.OpenAS2Exception,
                                                                                                       javax.servlet.ServletException

Create the AS2 session to be used based on the provided configuration file.

Parameters:

aInitParams -

Returns:

The created session. May not be null.

Throws:

com.helger.as2lib.exception.OpenAS2Exception - In case something goes wrong when initializing the session

javax.servlet.ServletException - In case an overriding methods wants to throw a different exception

onServletInit

public void onServletInit(@Nonnull
                          com.helger.commons.collection.impl.ICommonsMap<String,String> aInitParams)
                   throws javax.servlet.ServletException

Specified by:

onServletInit in interface com.helger.xservlet.handler.IXServletBasicHandler

Throws:

javax.servlet.ServletException

getSession

@Nonnull
protected com.helger.as2lib.session.AS2Session getSession()

Returns:

The AS2 session that was created in initialization. Never null.

Throws:

IllegalStateException - In case initialization failed

getReceiverModule

@Nonnull
protected com.helger.as2lib.processor.receiver.AS2ReceiverModule getReceiverModule()

Returns:

The AS2 receiver module that was created in initialization. Never null.

Throws:

IllegalStateException - In case initialization failed

handeIncomingMessage

@OverrideOnDemand
 @OverridingMethodsMustInvokeSuper
protected void handeIncomingMessage(@Nonnull
                                                                                           javax.servlet.http.HttpServletRequest aHttpRequest,
                                                                                           @Nonnull
                                                                                           javax.servlet.http.HttpServletResponse aHttpResponse,
                                                                                           @Nonnull
                                                                                           com.helger.web.scope.IRequestWebScope aRequestScope,
                                                                                           @Nonnull
                                                                                           byte[] aMsgData,
                                                                                           @Nonnull
                                                                                           com.helger.as2lib.message.AS2Message aMsg,
                                                                                           @Nonnull
                                                                                           AS2OutputStreamCreatorHttpServletResponse aResponseHandler)
                                                                                    throws javax.servlet.ServletException

Main handling method

Parameters:

aHttpRequest - HTTP request

aHttpResponse - HTTP response

aRequestScope - Current request scope

aMsgData - Message content

aMsg - AS2 message object

aResponseHandler - The response handler for sending back the MDN

Throws:

javax.servlet.ServletException - In case of an error

onRequest

public final void onRequest(@Nonnull
                            javax.servlet.http.HttpServletRequest aHttpRequest,
                            @Nonnull
                            javax.servlet.http.HttpServletResponse aHttpResponse,
                            @Nonnull
                            com.helger.http.EHttpVersion eHttpVersion,
                            @Nonnull
                            com.helger.commons.http.EHttpMethod eHttpMethod,
                            @Nonnull
                            com.helger.web.scope.IRequestWebScope aRequestScope)
                     throws javax.servlet.ServletException,
                            IOException

Specified by:

onRequest in interface com.helger.xservlet.handler.IXServletHandler

Throws:

javax.servlet.ServletException

IOException