se.swedenconnect.signservice.signature.RequestedSignatureTask 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.signature;

import java.io.Serializable;

/**
 * Representation of a "request signature task". It represents the data to-be-signed.
 */
public interface RequestedSignatureTask extends Serializable {

  /**
   * Gets the unique "sign task ID".
   *
   * @return the identifier for the task
   */
  String getTaskId();

  /**
   * Gets the type of signature.
   *
   * @return the signature type
   */
  SignatureType getSignatureType();

  /**
   * Gets the AdES type requested/produced.
   *
   * @return the AdES type, or null if none is requested/produced
   */
  AdESType getAdESType();

  /**
   * Gets the AdES object requested/produced.
   *
   * @return the AdES object, or null if no AdES object is requested/produced
   */
  AdESObject getAdESObject();

  /**
   * Gets the URI identifying one or more processing rules that the Signing Service MUST apply when processing and using
   * the provided signed information octets.
   *
   * @return processing rules URI or null
   */
  String getProcessingRulesUri();

  /**
   * Gets the raw "to-be-signed" data.
   *
   * @return to-be-signed data
   */
  byte[] getTbsData();

}