eu.toop.connector.api.me

Interface IMessageExchangeSPI

@IsSPIInterface
public interface IMessageExchangeSPI

Abstract API to be implemented for sending and receiving AS4 messages. This interface is used to differentiate the different AS4 implementations and integrations like Holodeck and phase4. It requires the usage of Java SPI technology for registration.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
String	getID()
void	registerIncomingHandler(javax.servlet.ServletContext aServletContext, IMEIncomingHandler aIncomingHandler) Register an incoming handler that takes the request/response to handle.
void	sendOutgoing(IMERoutingInformation aRoutingInfo, MEMessage aMessage) Trigger the message transmission in step 1/4 and 3/4.
void	shutdown(javax.servlet.ServletContext aServletContext) Shutdown the Message Exchange.

Method Detail

getID

@Nonnull
 @Nonempty
String getID()

Returns:

The unique ID of the SPI implementation, so that it can be referenced from a configuration file. The implementer must ensure the uniqueness of the ID.

registerIncomingHandler

void registerIncomingHandler(@Nonnull
                             javax.servlet.ServletContext aServletContext,
                             @Nonnull
                             IMEIncomingHandler aIncomingHandler)

Register an incoming handler that takes the request/response to handle. The differentiation between step 2/4 and 4/4 must be inside of the SPI implementation. This method is only called once for the chosen implementation, so the implementation can act as an "init" method and perform further implementation activities. If this method is not called, it is ensured that sendOutgoing(IMERoutingInformation, MEMessage) of this implementation are also never called.

Parameters:

aServletContext - The servlet context in which the handler should be registered. Never null.

aIncomingHandler - The handler to use. May not be null.

sendOutgoing

void sendOutgoing(@Nonnull
                  IMERoutingInformation aRoutingInfo,
                  @Nonnull
                  MEMessage aMessage)
           throws MEOutgoingException

Trigger the message transmission in step 1/4 and 3/4.

Parameters:

aRoutingInfo - Routing information. May not be null.

aMessage - The message to be exchanged. May not be null.

Throws:

MEOutgoingException - In case of error.

shutdown

void shutdown(@Nonnull
              javax.servlet.ServletContext aServletContext)

Shutdown the Message Exchange.

Parameters:

aServletContext - The servlet context in which the handler should be registered. Never null.