eu.toop.connector.api.as4.IMessageExchangeSPI Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of toop-connector-api Show documentation
Contains the TOOP Connector shared API
There is a newer version: 0.10.8
/**
 * Copyright (C) 2018-2019 toop.eu
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package eu.toop.connector.api.as4;

import java.io.Serializable;

import javax.annotation.Nonnull;
import javax.servlet.ServletContext;

import com.helger.commons.annotation.IsSPIInterface;
import com.helger.commons.annotation.Nonempty;

import eu.toop.commons.exchange.ToopRequestWithAttachments140;
import eu.toop.commons.exchange.ToopResponseWithAttachments140;

/**
 * Abstract API to be implemented for sending and receiving messages.
 *
 * @author Philip Helger
 */
@IsSPIInterface
public interface IMessageExchangeSPI
{
  public interface IIncomingHandler extends Serializable
  {
    /**
     * Handle an incoming request for step 2/4.
     *
     * @param aRequest
     *        The request to handle. Never null.
     * @throws MEException
     *         In case of error.
     */
    void handleIncomingRequest (@Nonnull ToopRequestWithAttachments140 aRequest) throws MEException;

    /**
     * Handle an incoming response for step 4/4.
     *
     * @param aResponse
     *        The response to handle. Never null.
     * @throws MEException
     *         In case of error.
     */
    void handleIncomingResponse (@Nonnull ToopResponseWithAttachments140 aResponse) throws MEException;
  }

  /**
   * @return 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.
   */
  @Nonnull
  @Nonempty
  String getID ();

  /**
   * 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 {@link #sendDCOutgoing(IMERoutingInformation, MEMessage)}
   * and {@link #sendDPOutgoing(IMERoutingInformation, MEMessage)} of this
   * implementation are also never called.
   *
   * @param aServletContext
   *        The servlet context in which the handler should be registered. Never
   *        null.
   * @param aIncomingHandler
   *        The handler to use. May not be null.
   * @throws MEException
   *         In case of error.
   */
  void registerIncomingHandler (@Nonnull ServletContext aServletContext,
                                @Nonnull IIncomingHandler aIncomingHandler) throws MEException;

  /**
   * Trigger the message transmission in step 1/4. This method acts synchronous.
   *
   * @param aRoutingInfo
   *        Routing information. May not be null.
   * @param aMessage
   *        The message to be exchanged. May not be null.
   * @throws MEException
   *         In case of error.
   */
  void sendDCOutgoing (@Nonnull IMERoutingInformation aRoutingInfo, @Nonnull MEMessage aMessage) throws MEException;

  /**
   * Trigger the message transmission in step 3/4.
   *
   * @param aRoutingInfo
   *        Routing information. May not be null.
   * @param aMessage
   *        The message to be exchanged. May not be null.
   * @throws MEException
   *         In case of error.
   */
  void sendDPOutgoing (@Nonnull IMERoutingInformation aRoutingInfo, @Nonnull MEMessage aMessage) throws MEException;

  /**
   * Shutdown the Message Exchange.
   *
   * @param aServletContext
   *        The servlet context in which the handler should be registered. Never
   *        null.
   */
  void shutdown (@Nonnull ServletContext aServletContext);
}