se.swedenconnect.signservice.engine.SignServiceEngine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of signservice-core Show documentation
SignService Core Library
There is a newer version: 1.1.3
/*
 * 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.engine;

import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;
import jakarta.annotation.PostConstruct;
import se.swedenconnect.signservice.application.SignServiceEngineManager;
import se.swedenconnect.signservice.application.SignServiceProcessingResult;
import se.swedenconnect.signservice.context.SignServiceContext;
import se.swedenconnect.signservice.core.http.HttpUserRequest;

/**
 * Interface for a SignService engine that is processing of signature requests.
 * 
 * A SignService engine is an instance serving one SignService client.
 * 
 */
public interface SignServiceEngine {

  /**
   * The main entry point for a SignService Engine. The {@link SignServiceEngineManager} accepts HTTP user requests
   * passed from the application/frontend, and after deciding which engine instance that can serve this request invokes
   * this method to process the request. The engine will find out the type of message and process it accordingly.
   * 
   * Apart from processing requests, the engine may also serve resources. Examples of such resources are status pages
   * and authentication provider metadata.
   * 
   *
   * @param httpRequest the HTTP user request received by the SignService frontend/application
   * @param signServiceContext the SignService context (may be null if this is the first request in an signature
   *          operation)
   * @return a SignServiceProcessingResult
   * @throws UnrecoverableSignServiceException if a HTTP message can not be sent as a result of the processing. This can
   *           occur in cases when the engine can not successfully produce a response message to send
   */
  @Nonnull
  SignServiceProcessingResult processRequest(
      @Nonnull final HttpUserRequest httpRequest, @Nullable final SignServiceContext signServiceContext)
      throws UnrecoverableSignServiceException;

  /**
   * A predicate that given a request tells whether this engine instance can process the request.
   *
   * @param request the HTTP user request received by the SignService frontend/application
   * @return true if the engine can process the request and false otherwise
   */
  boolean canProcess(@Nonnull final HttpUserRequest request);

  /**
   * Gets the name of the engine.
   *
   * @return the name
   */
  @Nonnull
  String getName();

  /**
   * Initializes the engine bean.
   *
   * @throws Exception for init errors
   */
  @PostConstruct
  void init() throws Exception;

}