Package se.litsec.swedisheid.opensaml.saml2.signservice.sap

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" />
     <xs:element minOccurs="0" name="RequestParams">
       <xs:complexType>
         <xs:sequence>
           <xs:element maxOccurs="unbounded" minOccurs="0" name="Parameter" type="sap:ParamType" />
         </xs:sequence>
       </xs:complexType>
     </xs:element>
   </xs:sequence>
   <xs:attribute name="ID" type="xs:ID" use="required" />
 </xs:complexType>
    Author:
    Martin Lindström (martin.lindstrom@litsec.se)

    • Field Detail

      • DEFAULT_ELEMENT_NAME

        static final QName DEFAULT_ELEMENT_NAME
        Default element name.

      • TYPE_NAME

        static final QName TYPE_NAME
        QName of the XSI type.

      • REQUESTER_ID_LOCAL_NAME

        static final String REQUESTER_ID_LOCAL_NAME
        Name of the RequesterID element.
        See Also:
        Constant Field Values

      • SIGN_REQUEST_ID_LOCAL_NAME

        static final String SIGN_REQUEST_ID_LOCAL_NAME
        Name of the SignRequestID element.
        See Also:
        Constant Field Values

      • REQUESTED_VERSION_LOCAL_NAME

        static final String REQUESTED_VERSION_LOCAL_NAME
        Name of the RequestedVersion element.
        See Also:
        Constant Field Values

    • Method Detail

      • getID

        String getID()
        Returns the ID attribute of this SADRequest.
        Returns:
        the ID of this SAD request

      • setID

        void setID​(String id)
        Assigns the ID of this SADRequest.
        Parameters:
        id - the ID of this SAD request

      • getRequesterID

        String getRequesterID()
        Returns the requester ID (entityID of the SP requesting the SAD).
        Returns:
        the entityID of the requester

      • setRequesterID

        void setRequesterID​(String requesterID)
        Assigns the requester ID (entityID of the SP requesting the SAD).
        Parameters:
        requesterID - the entityID of the requester

      • getSignRequestID

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

      • setSignRequestID

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

      • getDocCount

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

      • setDocCount

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

      • getRequestedVersion

        SADVersion getRequestedVersion()
        Returns the requested version of the SAD.
        Returns:
        the SAD version

      • setRequestedVersion

        void setRequestedVersion​(SADVersion sadVersion)
        Assigns the requested version of the SAD.
        Parameters:
        sadVersion - the SAD version

      • getRequestParams

        RequestParams getRequestParams()
        Returns the RequestParams element.
        Returns:
        the RequestParams, or null

      • setRequestParams

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