Interface SADRequest

All Superinterfaces:
SAMLObject, XMLObject
All Known Implementing Classes:
SADRequestImpl

public interface SADRequest extends SAMLObject
Definitions of the SADRequest type:

The SAD Request is provided in a <sap:SADRequest> element. The element has the following elements and attributes:

RequesterID [Required]
Specifies the SAML entityID of the requesting entity. The value for this element should be the same identifier as given in the <saml2:Issuer> element of the <saml2p:AuthnRequest> that encapsulates the <sap:SADRequest> extension.
SignRequestID [Required]
Specifies the value of the RequestID attribute of the associated SignRequest.
DocCount [Required]
The number of requested signatures in the associated sign request.
RequestedVersion [Optional Default="1.0"]
The requested version of the SAD.
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.
ID
Attribute holding an unique identifier for the SADRequest.
The following schema fragment defines the <sap:SADRequest> element:

<xs:element name="SADRequest" type="sap:SADRequestType" />

<xs:complexType name="SADRequestType">
  <xs:sequence>
    <xs:element name="RequesterID" type="xs:string" />
    <xs:element name="SignRequestID" type="xs:string" />
    <xs:element name="DocCount" type="xs:int" />
    <xs:element name="RequestedVersion" type="xs:string" default="1.0" minOccurs="0" />
    <xs:element minOccurs="0" name="RequestParams">
      <xs:complexType>
        <xs:sequence>
          <xs:element maxOccurs="unbounded" minOccurs="0" name="Parameter" type="sap:ParameterType" />
        </xs:sequence>
      </xs:complexType>
    </xs:element>
  </xs:sequence>
  <xs:attribute name="ID" type="xs:ID" use="required" />
</xs:complexType>
Author:
Martin Lindström (martin@idsec.se)
  • Field Details

    • DEFAULT_ELEMENT_LOCAL_NAME

      @Nonnull static final String DEFAULT_ELEMENT_LOCAL_NAME
      Name of the element.
      See Also:
    • DEFAULT_ELEMENT_NAME

      @Nonnull static final QName DEFAULT_ELEMENT_NAME
      Default element name.
    • TYPE_LOCAL_NAME

      @Nonnull static final String TYPE_LOCAL_NAME
      Local name of the type
      See Also:
    • TYPE_NAME

      @Nonnull static final QName TYPE_NAME
      QName of the XSI type.
    • REQUESTER_ID_LOCAL_NAME

      @Nonnull static final String REQUESTER_ID_LOCAL_NAME
      Name of the RequesterID element.
      See Also:
    • SIGN_REQUEST_ID_LOCAL_NAME

      @Nonnull static final String SIGN_REQUEST_ID_LOCAL_NAME
      Name of the SignRequestID element.
      See Also:
    • DOC_COUNT_LOCAL_NAME

      @Nonnull static final String DOC_COUNT_LOCAL_NAME
      Name of the DocCount element.
      See Also:
    • REQUESTED_VERSION_LOCAL_NAME

      @Nonnull static final String REQUESTED_VERSION_LOCAL_NAME
      Name of the RequestedVersion element.
      See Also:
    • ID_ATTRIB_NAME

      @Nonnull static final String ID_ATTRIB_NAME
      ID attribute name.
      See Also:
  • Method Details

    • getID

      @Nullable String getID()
      Returns the ID attribute of this SADRequest.
      Returns:
      the ID of this SAD request
    • setID

      void setID(@Nullable String id)
      Assigns the ID of this SADRequest.
      Parameters:
      id - the ID of this SAD request
    • getRequesterID

      @Nullable String getRequesterID()
      Returns the requester ID (entityID of the SP requesting the SAD).
      Returns:
      the entityID of the requester
    • setRequesterID

      void setRequesterID(@Nullable String requesterID)
      Assigns the requester ID (entityID of the SP requesting the SAD).
      Parameters:
      requesterID - the entityID of the requester
    • getSignRequestID

      @Nullable String getSignRequestID()
      Returns the value of the RequestID attribute of the associated SignRequest.
      Returns:
      the signature request ID
    • setSignRequestID

      void setSignRequestID(@Nullable String signRequestID)
      Assigns the value of the RequestID attribute of the associated SignRequest.
      Parameters:
      signRequestID - the signature request ID
    • getDocCount

      @Nullable Integer getDocCount()
      Returns the number of requested signatures in the associated sign request.
      Returns:
      the document count
    • setDocCount

      void setDocCount(@Nullable Integer docCount)
      Assigns the number of requested signatures in the associated sign request.
      Parameters:
      docCount - the document count
    • getRequestedVersion

      @Nonnull SADVersion getRequestedVersion()
      Returns the requested version of the SAD.
      Returns:
      the SAD version (1.0 if not set)
      Throws:
      IllegalArgumentException - if the version is not a valid version string
    • setRequestedVersion

      void setRequestedVersion(@Nullable SADVersion sadVersion)
      Assigns the requested version of the SAD.
      Parameters:
      sadVersion - the SAD version
    • getRequestParams

      @Nullable RequestParams getRequestParams()
      Returns the RequestParams element.
      Returns:
      the RequestParams, or null
    • setRequestParams

      void setRequestParams(@Nullable RequestParams requestParams)
      Assigns the RequestParams element.
      Parameters:
      requestParams - the RequestParams