com.helger.phase4.peppol.servlet.IPhase4PeppolIncomingSBDHandlerSPI Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phase4-peppol-servlet Show documentation
Peppol AS4 servlet for incoming transmissions
There is a newer version: 3.0.0
Show newest version
/*
 * Copyright (C) 2015-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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 com.helger.phase4.peppol.servlet;

import javax.annotation.Nonnull;

import org.unece.cefact.namespaces.sbdh.StandardBusinessDocument;

import com.helger.commons.annotation.IsSPIInterface;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.commons.http.HttpHeaderMap;
import com.helger.peppol.sbdh.PeppolSBDHData;
import com.helger.phase4.ebms3header.Ebms3Error;
import com.helger.phase4.ebms3header.Ebms3UserMessage;
import com.helger.phase4.messaging.IAS4IncomingMessageMetadata;
import com.helger.phase4.servlet.IAS4MessageState;
import com.helger.phase4.v3.ChangeV3;

/**
 * This is the interface that must be implemented to handle incoming SBD
 * documents.
 *
 * @author Philip Helger
 */
@IsSPIInterface
public interface IPhase4PeppolIncomingSBDHandlerSPI
{
  /**
   * Handle the provided incoming StandardBusinessDocument
   *
   * @param aMessageMetadata
   *        Message metadata. Includes data when and from whom it was received.
   *        Never null. Since v0.9.8.
   * @param aHeaders
   *        The (HTTP) headers of the incoming request. Never null.
   * @param aUserMessage
   *        The received EBMS user message. Never null. Since
   *        v0.9.8.
   * @param aSBDBytes
   *        The raw SBD bytes. These are the bytes as received via AS4, just
   *        decrypted and decompressed. Never null.
   * @param aSBD
   *        The incoming parsed Standard Business Document as JAXB data model.
   *        This is the pre-parsed SBD bytes. Use
   *        {@link com.helger.sbdh.SBDMarshaller} to serialize the document.
   *        Never null
   * @param aPeppolSBD
   *        The pre-parsed Peppol Standard Business Document. Never
   *        null. Since v0.9.8.
   * @param aState
   *        The message state. Can e.g. be used to retrieve information about
   *        the certificate found in the message. Never null. Since
   *        v0.9.8
   * @param aProcessingErrorMessages
   *        List for error messages that occur during processing. Never
   *        null. Since v2.6.0.
   * @throws Phase4PeppolClientException
   *         if this specific exception is thrown, it translates into a
   *         synchronous AS4 error message.
   * @throws Exception
   *         In case it cannot be processed. If
   *         {@link #exceptionTranslatesToAS4Error()} returns true
   *         each Exception is converted into a synchronous AS4 error message.
   */
  void handleIncomingSBD (@Nonnull IAS4IncomingMessageMetadata aMessageMetadata,
                          @Nonnull HttpHeaderMap aHeaders,
                          @Nonnull Ebms3UserMessage aUserMessage,
                          @Nonnull byte [] aSBDBytes,
                          @Nonnull StandardBusinessDocument aSBD,
                          @Nonnull PeppolSBDHData aPeppolSBD,
                          @Nonnull IAS4MessageState aState,
                          @Nonnull ICommonsList  aProcessingErrorMessages) throws Exception;

  /**
   * Define if an exception from
   * {@link #handleIncomingSBD(IAS4IncomingMessageMetadata, HttpHeaderMap, Ebms3UserMessage, byte[], StandardBusinessDocument, PeppolSBDHData, IAS4MessageState, ICommonsList)}
   * results in a negative AS4 response or not. By default it is not.
   *
   * @return true to convert an Exception into an AS4 Error,
   *         false if the Exception should simply be logged and
   *         than processing should continue.
   * @since 0.12.2
   */
  @ChangeV3 ("Remove Exception handling and force usage of aProcessingErrorMessages")
  default boolean exceptionTranslatesToAS4Error ()
  {
    return false;
  }
}