com.helger.as2servlet

Class AS2ReceiveXServletHandlerFileBasedConfig

java.lang.Object

com.helger.as2servlet.AbstractAS2ReceiveXServletHandler

com.helger.as2servlet.AS2ReceiveXServletHandlerFileBasedConfig

All Implemented Interfaces:

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

public class AS2ReceiveXServletHandlerFileBasedConfig
extends AbstractAS2ReceiveXServletHandler

A special AbstractAS2ReceiveXServletHandler with a file based configuration.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields inherited from class com.helger.as2servlet.AbstractAS2ReceiveXServletHandler

SERVLET_INIT_PARAM_AS2_SERVLET_CONFIG_FILENAME

Constructor Summary

Constructors

Constructor and Description
AS2ReceiveXServletHandlerFileBasedConfig()

Method Summary

Modifier and Type	Method and Description
protected AS2ServletSession	createAS2Session(com.helger.commons.collection.impl.ICommonsMap<String,String> aInitParams) Create the AS2 session to be used based on the provided configuration file.
protected File	getConfigurationFile(com.helger.commons.collection.impl.ICommonsMap<String,String> aInitParams) Get the AS2 configuration file to be used.

Methods inherited from class com.helger.as2servlet.AbstractAS2ReceiveXServletHandler

getReceiverModule, getSession, handeIncomingMessage, onRequest, onServletInit

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

Constructor Detail

AS2ReceiveXServletHandlerFileBasedConfig

public AS2ReceiveXServletHandlerFileBasedConfig()

Method Detail

getConfigurationFile

@OverrideOnDemand
 @Nonnull
protected File getConfigurationFile(@Nonnull
                                                                  com.helger.commons.collection.impl.ICommonsMap<String,String> aInitParams)
                                                           throws javax.servlet.ServletException

Get the AS2 configuration file to be used. By default this method reads it from the Servlet init-param called AbstractAS2ReceiveXServletHandler.SERVLET_INIT_PARAM_AS2_SERVLET_CONFIG_FILENAME. You may override this method to use another way of retrieving the configuration file.
Note: it must be a File because the configuration file allows for "%home%" parameter substitution which uses the directory of the configuration file as the base directory.

Parameters:

aInitParams - Servlet init parameters

Returns:

The configuration file to be used. MUST not be null.

Throws:

javax.servlet.ServletException - If no or an invalid configuration file was provided.

createAS2Session

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

Description copied from class: AbstractAS2ReceiveXServletHandler

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

Specified by:

createAS2Session in class AbstractAS2ReceiveXServletHandler

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