se.swedenconnect.signservice.application.SignServiceEngineManager Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2022-2024 Sweden Connect
 *
 * 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 se.swedenconnect.signservice.application;

import java.util.List;

import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;
import se.swedenconnect.signservice.audit.AuditLogger;
import se.swedenconnect.signservice.context.SignServiceContext;
import se.swedenconnect.signservice.core.http.HttpUserRequest;
import se.swedenconnect.signservice.engine.SignServiceEngine;
import se.swedenconnect.signservice.engine.UnrecoverableErrorCodes;
import se.swedenconnect.signservice.engine.UnrecoverableSignServiceException;

/**
 * The SignService engine manager is responsible of routing every call to a matching engine and is seen as the main
 * SignService application bean.
 */
public interface SignServiceEngineManager {

  /**
   * Each HTTP message that is received by the SignService application on a given path is supplied to the
   * {@code processRequest} method.
   * 
   * Based on which URL the request was received a {@link SignServiceEngine} is selected, and its
   * {@link SignServiceEngine#processRequest(HttpUserRequest, SignServiceContext)} method is called. If no matching
   * engine is found, an {@link UnrecoverableSignServiceException} exception with the code
   * {@link UnrecoverableErrorCodes#NOT_FOUND} will be thrown.
   * 
   *
   * @param request the HTTP request received from the user's browser
   * @param signServiceContext the SignService context (may be null if this is the first request in an signature
   *          operation)
   * @return a SignServiceProcessingResult
   * @throws UnrecoverableSignServiceException for non-recoverable errors (should be displayed in an error view)
   */
  @Nonnull
  SignServiceProcessingResult processRequest(
      @Nonnull final HttpUserRequest request, @Nullable final SignServiceContext signServiceContext)
      throws UnrecoverableSignServiceException;

  /**
   * Gets a list of the SignService engines that this manager is configured to use.
   *
   * @return a list of engine instances
   */
  @Nonnull
  List getEngines();

  /**
   * Gets the system audit logger that this manager uses.
   *
   * @return the system audit logger
   */
  @Nonnull
  AuditLogger getSystemAuditLogger();

}