se.litsec.swedisheid.opensaml.saml2.signservice.sap.SADRequest Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016-2018 Litsec 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.litsec.swedisheid.opensaml.saml2.signservice.sap;

import javax.xml.namespace.QName;

import org.opensaml.saml.common.SAMLObject;

/**
 * Definitions of the SADRequest type:
 * 
 * 
 * The SAD Request is provided in a {@code } element. The element has the following elements and
 * attributes:
 * 
 * 
 * {@code RequesterID} [Required]
 * Specifies the SAML entityID of the requesting entity. The value for this element should be the same identifier as
 * given in the {@code } element of the {@code } that encapsulates the {@code 
 * } extension.
 * {@code SignRequestID} [Required]
 * Specifies the value of the RequestID attribute of the associated SignRequest.
 * {@code DocCount} [Required]
 * The number of requested signatures in the associated sign request.
 * {@code RequestedVersion} [Optional Default="1.0"]
 * The requested version of the SAD.
 * {@code RequestParams} [Optional]
 * Optional parameters provided as name-value pairs. This specification does not define any parameters. The use of
 * parameters may be defined in profiles of this specification or may be negotiated by other means between a remote
 * signing service and an Identity Provider.
 * {@code ID}
 * Attribute holding an unique identifier for the {@code SADRequest}.
 * 
 * 
 * The following schema fragment defines the {@code } element:
 * 
 *  * {@code 
 * 
 * 
 * 
 *   
 *     
 *     
 *     
 *     
 *     
 *       
 *         
 *           
 *         
 *       
 *     
 *   
 *   
 * }
 * 
 * 
 * @author Martin Lindström ([email protected])
 */
public interface SADRequest extends SAMLObject {

  /** Name of the element. */
  String DEFAULT_ELEMENT_LOCAL_NAME = "SADRequest";

  /** Default element name. */
  QName DEFAULT_ELEMENT_NAME = new QName(SAPConstants.SAP_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAPConstants.SAP_NS_PREFIX);

  /** Local name of the type */
  String TYPE_LOCAL_NAME = "SADRequestType";

  /** QName of the XSI type. */
  QName TYPE_NAME = new QName(SAPConstants.SAP_NS, TYPE_LOCAL_NAME, SAPConstants.SAP_NS_PREFIX);

  /** Name of the RequesterID element. */
  String REQUESTER_ID_LOCAL_NAME = "RequesterID";

  /** Name of the SignRequestID element. */
  String SIGN_REQUEST_ID_LOCAL_NAME = "SignRequestID";

  /** Name of the DocCount element. */
  String DOC_COUNT_LOCAL_NAME = "DocCount";

  /** Name of the RequestedVersion element. */
  String REQUESTED_VERSION_LOCAL_NAME = "RequestedVersion";

  /** ID attribute name. */
  public static final String ID_ATTRIB_NAME = "ID";

  /**
   * Returns the ID attribute of this {@code SADRequest}.
   * 
   * @return the ID of this SAD request
   */
  String getID();

  /**
   * Assigns the ID of this {@code SADRequest}.
   * 
   * @param id
   *          the ID of this SAD request
   */
  public void setID(String id);

  /**
   * Returns the requester ID (entityID of the SP requesting the SAD).
   * 
   * @return the entityID of the requester
   */
  String getRequesterID();

  /**
   * Assigns the requester ID (entityID of the SP requesting the SAD).
   * 
   * @param requesterID
   *          the entityID of the requester
   */
  void setRequesterID(String requesterID);

  /**
   * Returns the value of the {@code RequestID} attribute of the associated {@code SignRequest}.
   * 
   * @return the signature request ID
   */
  String getSignRequestID();

  /**
   * Assigns the value of the {@code RequestID} attribute of the associated {@code SignRequest}.
   * 
   * @param signRequestID
   *          the signature request ID
   */
  void setSignRequestID(String signRequestID);

  /**
   * Returns the number of requested signatures in the associated sign request.
   * 
   * @return the document count
   */
  Integer getDocCount();

  /**
   * Assigns the number of requested signatures in the associated sign request.
   * 
   * @param docCount
   *          the document count
   */
  void setDocCount(Integer docCount);

  /**
   * Returns the requested version of the SAD.
   * 
   * @return the SAD version
   */
  SADVersion getRequestedVersion();

  /**
   * Assigns the requested version of the SAD.
   * 
   * @param sadVersion
   *          the SAD version
   */
  void setRequestedVersion(SADVersion sadVersion);

  /**
   * Returns the {@code RequestParams} element.
   * 
   * @return the {@code RequestParams}, or {@code null}
   */
  RequestParams getRequestParams();

  /**
   * Assigns the {@code RequestParams} element.
   * 
   * @param requestParams
   *          the {@code RequestParams}
   */
  void setRequestParams(RequestParams requestParams);

}