se.idsec.signservice.integration.SignRequestData Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019-2024 IDsec Solutions AB
 *
 * 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.idsec.signservice.integration;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import lombok.Builder;
import lombok.ToString;
import se.idsec.signservice.integration.core.Extensible;
import se.idsec.signservice.integration.core.Extension;
import se.idsec.signservice.integration.core.ObjectBuilder;
import se.idsec.signservice.integration.core.SignatureState;

import java.io.Serial;

/**
 * Domain class representing the result of a {@link SignServiceIntegrationService#createSignRequest(SignRequestInput)}
 * call. This class holds the information needed to send a {@code dss:SignRequest} to a signature service.
 *
 * 
 * Chapter 3 of Implementation
 * Profile for using OASIS DSS in Central Signing Services describes how a sign request is transfered to the
 * signature service. Below is an example of an XHTML form:
 * 
 *
 *  * {@code
 * 
 * 
 * 
 * 
 *   
 *   
 *     
 *     
 *     
 *     
 *   
 * }
 * 
 *
 * @author Martin Lindström ([email protected])
 * @author Stefan Santesson ([email protected])
 */
@ToString
@Builder
@JsonInclude(Include.NON_NULL)
public class SignRequestData implements Extensible {

  @Serial
  private static final long serialVersionUID = 4357498242718442582L;

  /** The default binding. */
  public static final String DEFAULT_BINDING = "POST/XML/1.0";

  /** State for a signature operation. */
  private SignatureState state;

  /** The Base64-encoded SignRequest message that is to be posted to the signature service. */
  private String signRequest;

  /** The relay state. */
  private String relayState;

  /** The identifier for the binding of the message that is to be sent. */
  @Builder.Default
  private String binding = DEFAULT_BINDING;

  /** The signature service URL to which the SignRequest should be posted. */
  private String destinationUrl;

  /** Extensions for the object. */
  private Extension extension;

  /**
   * Default constructor.
   */
  public SignRequestData() {
  }

  /**
   * Constructor.
   *
   * @param state state for a signature operation
   * @param signRequest the Base64-encoded SignRequest message that is to be posted to the signature service
   * @param relayState the relay state
   * @param binding the identifier for the binding of the message that is to be sent
   * @param destinationUrl the signature service URL to which the SignRequest should be posted
   * @param extension extensions for the object
   */
  public SignRequestData(final SignatureState state, final String signRequest, final String relayState,
      final String binding, final String destinationUrl, final Extension extension) {
    this.state = state;
    this.signRequest = signRequest;
    this.relayState = relayState;
    this.binding = binding;
    this.destinationUrl = destinationUrl;
    this.extension = extension;
  }

  /**
   * Gets the state for a signature operation.
   *
   * 
   * This state must be maintained by the signature requester and when a sign response has been received from the
   * signature service be supplied in the
   * {@link SignServiceIntegrationService#processSignResponse(String, String, SignatureState,
   * SignResponseProcessingParameters)} call.
   * 
   *
   * @return the signature state for this operation
   */
  public SignatureState getState() {
    return this.state;
  }

  /**
   * Assigns the state for a signature operation.
   *
   * 
   * This state must be maintained by the signature requester and when a sign response has been received from the
   * signature service be supplied in the
   * {@link SignServiceIntegrationService#processSignResponse(String, String, SignatureState,
   * SignResponseProcessingParameters)} call.
   * 
   *
   * @param state the signature state
   */
  public void setState(final SignatureState state) {
    this.state = state;
  }

  /**
   * Gets the Base64-encoded SignRequest message that is to be posted to the signature service.
   *
   * 
   * This value should be posted to the signature service in a form where the parameter has the name
   * {@code EidSignRequest}. See example above.
   * 
   *
   * @return the encoded SignRequest message
   */
  public String getSignRequest() {
    return this.signRequest;
  }

  /**
   * Assigns the Base64-encoded SignRequest message that is to be posted to the signature service.
   *
   * 
   * This value should be posted to the signature service in a form where the parameter has the name
   * {@code EidSignRequest}. See example above.
   * 
   *
   * @param signRequest the sign request (in Base64-encoding)
   */
  public void setSignRequest(final String signRequest) {
    this.signRequest = signRequest;
  }

  /**
   * Gets the relay state. This is the same value as the {@code RequestID} attribute of the SignRequest and
   * {@link SignatureState#getId()}.
   *
   * 
   * This value should be posted to the signature service in a form where the parameter has the name {@code RelayState}.
   * See example above.
   * 
   * 
   * Note: The RelayState used in communication with the signature service has the same name as the parameter
   * used in SAML authentication requests, but in SAML the value is opaque and does not bind to any value in the
   * request as is the case for signature service communication. An unlucky re-use of the term RelayState.
   * 
   *
   * @return the relay state value
   */
  public String getRelayState() {
    return this.relayState;
  }

  /**
   * Assigns the relay state.
   *
   * 
   * See {@link #getRelayState()} for clarifications about the relay state.
   * 
   *
   * @param relayState the relay state variable
   */
  public void setRelayState(final String relayState) {
    this.relayState = relayState;
  }

  /**
   * Gets the identifier for the binding of the message that is to be sent.
   *
   * 
   * This value should be posted to the signature service in a form where the parameter has the name {@code Binding}.
   * See example above.
   * 
   * 
   * Currently, the only supported value is "POST/XML/1.0".
   * 
   *
   * @return the binding identifier
   */
  public String getBinding() {
    return this.binding;
  }

  /**
   * Assigns the identifier for the binding of the message that is to be sent.
   * 
   * The default value is "POST/XML/1.0".
   * 
   *
   * @param binding the binding identifier
   */
  public void setBinding(final String binding) {
    this.binding = binding;
  }

  /**
   * Gets the signature service URL to which the SignRequest should be posted.
   *
   * @return signature service destination URL
   */
  public String getDestinationUrl() {
    return this.destinationUrl;
  }

  /**
   * Assigns the signature service URL to which the SignRequest should be posted.
   *
   * @param destinationUrl the signature service URL to which the SignRequest should be posted
   */
  public void setDestinationUrl(final String destinationUrl) {
    this.destinationUrl = destinationUrl;
  }

  /** {@inheritDoc} */
  @Override
  public Extension getExtension() {
    return this.extension;
  }

  /** {@inheritDoc} */
  @Override
  public void setExtension(final Extension extension) {
    this.extension = extension;
  }

  /**
   * Builder for {@code SignRequestData} objects.
   */
  public static class SignRequestDataBuilder implements ObjectBuilder {
    @SuppressWarnings("unused")
    private final String binding = SignRequestData.DEFAULT_BINDING;

    // Lombok generates the code ...
  }

}