Class XmlSignerEndpointBuilderFactory.XmlSignerHeaderNameBuilder

  • Enclosing interface:
    XmlSignerEndpointBuilderFactory

    public static class XmlSignerEndpointBuilderFactory.XmlSignerHeaderNameBuilder
    extends Object
    The builder of headers' name for the XML Security Sign component.
    • Constructor Detail

      • XmlSignerHeaderNameBuilder

        public XmlSignerHeaderNameBuilder()
    • Method Detail

      • xmlSignatureMessageIsPlainText

        public String xmlSignatureMessageIsPlainText()
        Header for indicating that the message body contains non-xml plain text. This header is used in the XML signature generator. If the value is set to Boolean#TRUE then the message body is treated as plain text Overwrites the configuration parameter XmlSignerConfiguration#setPlainText(Boolean). The option is a: Boolean type. Group: producer
        Returns:
        the name of the header XmlSignatureMessageIsPlainText.
      • xmlSignaturePlainTextEncoding

        public String xmlSignaturePlainTextEncoding()
        Header indicating the encoding of the plain text message body. Used in the XML signature generator if the header HEADER_MESSAGE_IS_PLAIN_TEXT is set to Boolean#TRUE. Overwrites the configuration parameter XmlSignerConfiguration#setPlainTextEncoding(String). The option is a: String type. Group: producer
        Returns:
        the name of the header XmlSignaturePlainTextEncoding.
      • xmlSignatureOmitXmlDeclaration

        public String xmlSignatureOmitXmlDeclaration()
        Header which indicates that either the resulting signature document in the signature generation case or the resulting output of the verifier should not contain an XML declaration. If the header is not specified then a XML declaration is created. There is one exception: If the verifier result is a plain text this header has no effect. Possible values of the header are Boolean#TRUE or Boolean#FALSE. Overwrites the configuration parameter XmlSignatureConfiguration#setOmitXmlDeclaration(Boolean). The option is a: Boolean type. Group: producer
        Returns:
        the name of the header XmlSignatureOmitXmlDeclaration.
      • xmlSignatureContentReferenceUri

        public String xmlSignatureContentReferenceUri()
        The content reference URI. The option is a: String type. Group: producer
        Returns:
        the name of the header XmlSignatureContentReferenceUri.
      • xmlSignatureContentReferenceType

        public String xmlSignatureContentReferenceType()
        The content reference type. The option is a: String type. Group: producer
        Returns:
        the name of the header XmlSignatureContentReferenceType.
      • xmlSignatureSchemaResourceUri

        public String xmlSignatureSchemaResourceUri()
        The schema resource URI. The option is a: String type. Group: producer
        Returns:
        the name of the header XmlSignatureSchemaResourceUri.
      • xmlSignatureXpathsToIdAttributes

        public String xmlSignatureXpathsToIdAttributes()
        XPaths to id attributes. The option is a: String type. Group: producer
        Returns:
        the name of the header XmlSignatureXpathsToIdAttributes.
      • xmlSignatureTransformMethods

        public String xmlSignatureTransformMethods()
        Header for dynamic specifying the transform methods of the reference to the signed data. The value of the header must be a comma separated list with the transform algorithms, for example: http://www.w3.org/2000/09/xmldsig#enveloped-signature,http://www.w3.org/TR/2001/REC-xml-c14n-20010315 Used for the XML signer. This header will overwrite the configuration property transformMethods. You cannot use transform algorithms, which need parameters like http://www.w3.org/TR/1999/REC-xslt-19991116, http://www.w3.org/2002/06/xmldsig-filter2, or http://www.w3.org/TR/1999/REC-xpath-19991116. The option is a: String type. Group: producer
        Returns:
        the name of the header XmlSignatureTransformMethods.
      • xmlSignatureXAdESQualifyingPropertiesId

        public String xmlSignatureXAdESQualifyingPropertiesId()
        for the 'Id' attribute value of QualifyingProperties element. The option is a: String type. Group: producer
        Returns:
        the name of the header XmlSignatureXAdESQualifyingPropertiesId.
      • xmlSignatureXAdESSignedDataObjectPropertiesId

        public String xmlSignatureXAdESSignedDataObjectPropertiesId()
        for the 'Id' attribute value of SignedDataObjectProperties element. The option is a: String type. Group: producer
        Returns:
        the name of the header XmlSignatureXAdESSignedDataObjectPropertiesId.
      • xmlSignatureXAdESSignedSignaturePropertiesId

        public String xmlSignatureXAdESSignedSignaturePropertiesId()
        for the 'Id' attribute value of SignedSignatureProperties element. The option is a: String type. Group: producer
        Returns:
        the name of the header XmlSignatureXAdESSignedSignaturePropertiesId.
      • xmlSignatureXAdESDataObjectFormatEncoding

        public String xmlSignatureXAdESDataObjectFormatEncoding()
        for the value of the Encoding element of the DataObjectFormat element. The option is a: String type. Group: producer
        Returns:
        the name of the header XmlSignatureXAdESDataObjectFormatEncoding.
      • xmlSignatureXAdESNamespace

        public String xmlSignatureXAdESNamespace()
        overwrites the XAdES namespace parameter value. The option is a: String type. Group: producer
        Returns:
        the name of the header XmlSignatureXAdESNamespace.
      • xmlSignatureXAdESPrefix

        public String xmlSignatureXAdESPrefix()
        overwrites the XAdES prefix parameter value. The option is a: String type. Group: producer
        Returns:
        the name of the header XmlSignatureXAdESPrefix.
      • charsetName

        public String charsetName()
        The name of the charset. The option is a: String type. Group: producer
        Returns:
        the name of the header CharsetName.