Package com.helger.phase4.servlet

Class AS4XServletHandler

java.lang.Object

com.helger.phase4.servlet.AS4XServletHandler

All Implemented Interfaces:

com.helger.xservlet.handler.IXServletBasicHandler, com.helger.xservlet.handler.simple.IXServletSimpleHandler

public class AS4XServletHandler
extends Object
implements com.helger.xservlet.handler.simple.IXServletSimpleHandler

Main handler for the AS4Servlet

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AS4XServletHandler.IHandlerCustomizer

Constructor Summary

Constructors

Constructor	Description
AS4XServletHandler()	Default constructor.
AS4XServletHandler(Supplier<? extends IAS4CryptoFactory> aCryptoFactorySupplier, IPModeResolver aPModeResolver, IAS4IncomingAttachmentFactory aIAF)	Deprecated, for removal: This API element is subject to removal in a future version. Please use the default constructors and setters

Method Summary

Modifier and Type	Method	Description
protected AS4IncomingMessageMetadata	createIncomingMessageMetadata(com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope)	Create the incoming message metadata based on the provided request.
AS4UnifiedResponse	createUnifiedResponse(com.helger.http.EHttpVersion eHTTPVersion, com.helger.commons.http.EHttpMethod eHTTPMethod, jakarta.servlet.http.HttpServletRequest aHttpRequest, com.helger.web.scope.IRequestWebScope aRequestScope)
final Supplier<? extends IAS4CryptoFactory>	getCryptoFactoryCryptSupplier()
final Supplier<? extends IAS4CryptoFactory>	getCryptoFactorySignSupplier()
final Supplier<? extends IAS4CryptoFactory>	getCryptoFactorySupplier()	Deprecated, for removal: This API element is subject to removal in a future version.
final AS4XServletHandler.IHandlerCustomizer	getHandlerCustomizer()
final IAS4IncomingAttachmentFactory	getIncomingAttachmentFactory()
final IAS4IncomingSecurityConfiguration	getIncomingSecurityConfiguration()
final IPModeResolver	getPModeResolver()
protected void	handleRequest(com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope, AS4UnifiedResponse aHttpResponse, IAS4CryptoFactory aCryptoFactorySign, IAS4CryptoFactory aCryptoFactoryCrypt, IPModeResolver aPModeResolver, IAS4IncomingAttachmentFactory aIAF, IAS4IncomingSecurityConfiguration aISC, AS4XServletHandler.IHandlerCustomizer aHandlerCustomizer)	Handle an incoming request.
void	handleRequest(com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope, com.helger.servlet.response.UnifiedResponse aUnifiedResponse)
final AS4XServletHandler	setCryptoFactoryCryptSupplier(Supplier<? extends IAS4CryptoFactory> aCryptoFactoryCryptSupplier)
final AS4XServletHandler	setCryptoFactorySignSupplier(Supplier<? extends IAS4CryptoFactory> aCryptoFactorySignSupplier)
final AS4XServletHandler	setCryptoFactorySupplier(Supplier<? extends IAS4CryptoFactory> aCryptoFactorySupplier)	Set the same crypto factory supplier for signing and crypting.
final AS4XServletHandler	setHandlerCustomizer(AS4XServletHandler.IHandlerCustomizer aHandlerCustomizer)	The customizer to be used.
final AS4XServletHandler	setIncomingAttachmentFactory(IAS4IncomingAttachmentFactory aIAF)
final AS4XServletHandler	setIncomingSecurityConfiguration(IAS4IncomingSecurityConfiguration aICS)
final AS4XServletHandler	setPModeResolver(IPModeResolver aPModeResolver)

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, onServletInit

Methods inherited from interface com.helger.xservlet.handler.simple.IXServletSimpleHandler

getLastModificationDateTime, getSupportedETag, initRequestState, onException, onRequestBegin, onRequestEnd

Constructor Details

AS4XServletHandler

public AS4XServletHandler()

Default constructor.

Since:

0.9.7

AS4XServletHandler

@Deprecated(forRemoval=true,
            since="2.1.3")
public AS4XServletHandler(@Nonnull
 Supplier<? extends IAS4CryptoFactory> aCryptoFactorySupplier,
 @Nonnull
 IPModeResolver aPModeResolver,
 @Nonnull
 IAS4IncomingAttachmentFactory aIAF)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use the default constructors and setters

Constructor

Parameters:

aCryptoFactorySupplier - Crypto factory supplier. May not be null.

aPModeResolver - PMode resolved to be used. May not be null.

aIAF - The attachment factory for incoming attachments. May not be null.

Since:

v0.9.8

Method Details

getCryptoFactorySupplier

@Nonnull
@Deprecated(forRemoval=true,
            since="2.2.0")
public final Supplier<? extends IAS4CryptoFactory> getCryptoFactorySupplier()

Deprecated, for removal: This API element is subject to removal in a future version.

As the crypto factories for sign and crypt may be different, this general purpose API may not be used anymore. Use getCryptoFactorySignSupplier() or getCryptoFactoryCryptSupplier() instead.

Returns:

The supplier for the IAS4CryptoFactory. May not be null.

Since:

0.9.15

getCryptoFactorySignSupplier

@Nonnull
public final Supplier<? extends IAS4CryptoFactory> getCryptoFactorySignSupplier()

Returns:

The supplier for the IAS4CryptoFactory for signing. May not be null.

Since:

2.2.0

See Also:

• getCryptoFactoryCryptSupplier()

getCryptoFactoryCryptSupplier

@Nonnull
public final Supplier<? extends IAS4CryptoFactory> getCryptoFactoryCryptSupplier()

Returns:

The supplier for the IAS4CryptoFactory for crypting. May not be null.

Since:

2.2.0

See Also:

• getCryptoFactorySignSupplier()

setCryptoFactorySupplier

@Nonnull
public final AS4XServletHandler setCryptoFactorySupplier(@Nonnull
 Supplier<? extends IAS4CryptoFactory> aCryptoFactorySupplier)

Set the same crypto factory supplier for signing and crypting.

Parameters:

aCryptoFactorySupplier - Crypto factory supplier. May not be null.

Returns:

this for chaining

Since:

0.9.15

See Also:

• setCryptoFactorySignSupplier(Supplier)
• setCryptoFactoryCryptSupplier(Supplier)

setCryptoFactorySignSupplier

@Nonnull
public final AS4XServletHandler setCryptoFactorySignSupplier(@Nonnull
 Supplier<? extends IAS4CryptoFactory> aCryptoFactorySignSupplier)

Parameters:

aCryptoFactorySignSupplier - Crypto factory supplier for signing. May not be null.

Returns:

this for chaining

Since:

2.2.0

See Also:

• setCryptoFactoryCryptSupplier(Supplier)

setCryptoFactoryCryptSupplier

@Nonnull
public final AS4XServletHandler setCryptoFactoryCryptSupplier(@Nonnull
 Supplier<? extends IAS4CryptoFactory> aCryptoFactoryCryptSupplier)

Parameters:

aCryptoFactoryCryptSupplier - Crypto factory supplier for signing. May not be null.

Returns:

this for chaining

Since:

2.2.0

See Also:

• setCryptoFactorySignSupplier(Supplier)

getPModeResolver

@Nonnull
public final IPModeResolver getPModeResolver()

Returns:

The IPModeResolver to be used. Never null.

Since:

0.9.15

setPModeResolver

@Nonnull
public final AS4XServletHandler setPModeResolver(@Nonnull
 IPModeResolver aPModeResolver)

Parameters:

aPModeResolver - PMode resolved to be used. May not be null.

Returns:

this for chaining

Since:

0.9.15

getIncomingAttachmentFactory

@Nonnull
public final IAS4IncomingAttachmentFactory getIncomingAttachmentFactory()

Returns:

The IAS4IncomingAttachmentFactory to be used. Never null.

Since:

0.9.15

setIncomingAttachmentFactory

@Nonnull
public final AS4XServletHandler setIncomingAttachmentFactory(@Nonnull
 IAS4IncomingAttachmentFactory aIAF)

Parameters:

aIAF - The attachment factory for incoming attachments. May not be null.

Returns:

this for chaining

Since:

0.9.15

getIncomingSecurityConfiguration

@Nonnull
public final IAS4IncomingSecurityConfiguration getIncomingSecurityConfiguration()

Returns:

The IAS4IncomingSecurityConfiguration to be used. Never null.

Since:

2.1.3

setIncomingSecurityConfiguration

@Nonnull
public final AS4XServletHandler setIncomingSecurityConfiguration(@Nonnull
 IAS4IncomingSecurityConfiguration aICS)

Parameters:

aICS - The incoming security configuration. May not be null.

Returns:

this for chaining

Since:

2.1.3

getHandlerCustomizer

@Nullable
public final AS4XServletHandler.IHandlerCustomizer getHandlerCustomizer()

Returns:

The additional customizer. May be null.

setHandlerCustomizer

@Nonnull
public final AS4XServletHandler setHandlerCustomizer(@Nullable
 AS4XServletHandler.IHandlerCustomizer aHandlerCustomizer)

The customizer to be used.

Parameters:

aHandlerCustomizer - The new customizer. May be null.

Returns:

this for chaining

createUnifiedResponse

@Nonnull
public AS4UnifiedResponse createUnifiedResponse(@Nonnull
 com.helger.http.EHttpVersion eHTTPVersion,
 @Nonnull
 com.helger.commons.http.EHttpMethod eHTTPMethod,
 @Nonnull
 jakarta.servlet.http.HttpServletRequest aHttpRequest,
 @Nonnull
 com.helger.web.scope.IRequestWebScope aRequestScope)

Specified by:

createUnifiedResponse in interface com.helger.xservlet.handler.simple.IXServletSimpleHandler

createIncomingMessageMetadata

@Nonnull
@OverrideOnDemand
protected AS4IncomingMessageMetadata createIncomingMessageMetadata(@Nonnull
 com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope)

Create the incoming message metadata based on the provided request. This method may be overridden by sub-classes to customize the header generation e.g. when sitting behind a proxy or the like.

Parameters:

aRequestScope - The request scope to use.

Returns:

New AS4IncomingMessageMetadata and never null.

Since:

0.12.0

handleRequest

protected void handleRequest(@Nonnull
 com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope,
 @Nonnull
 AS4UnifiedResponse aHttpResponse,
 @Nonnull
 IAS4CryptoFactory aCryptoFactorySign,
 @Nonnull
 IAS4CryptoFactory aCryptoFactoryCrypt,
 @Nonnull
 IPModeResolver aPModeResolver,
 @Nonnull
 IAS4IncomingAttachmentFactory aIAF,
 @Nonnull
 IAS4IncomingSecurityConfiguration aISC,
 @Nullable
 AS4XServletHandler.IHandlerCustomizer aHandlerCustomizer)
                      throws Exception

Handle an incoming request. Compared to handleRequest(IRequestWebScopeWithoutResponse, UnifiedResponse) all the member variables are resolved into parameters to make overriding simpler and also avoid the risk of race conditions on members that use the Supplier pattern.

Parameters:

aRequestScope - The request scope. May not be null.

aHttpResponse - The HTTP response to be filled. May not be null.

aCryptoFactorySign - The AS4 crypto factory to be used for signing. May not be null. Defaults to getCryptoFactorySupplier().get()

aCryptoFactoryCrypt - The AS4 crypto factory to be used for crypting. May not be null. Defaults to getCryptoFactorySupplier().get()

aPModeResolver - The PMode resolver to be used. May not be null. Defaults to getPModeResolver().

aIAF - The factory to parse incoming attachments. May not be null. Defaults to getIncomingAttachmentFactory().

aISC - The security configuration to use for incoming data. May not be null. Since v2.1.3.

aHandlerCustomizer - An optional callback that can be used to modify the internal AS4RequestHandler before and after processing. May be null.

Throws:

Exception - In case of a processing error

Since:

1.3.1

handleRequest

public void handleRequest(@Nonnull
 com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope,
 @Nonnull
 com.helger.servlet.response.UnifiedResponse aUnifiedResponse)
                   throws Exception

Specified by:

handleRequest in interface com.helger.xservlet.handler.simple.IXServletSimpleHandler

Throws:

Exception