Class XmlSignatureConstants


  • public final class XmlSignatureConstants
    extends Object
    • Field Detail

      • HEADER_MESSAGE_IS_PLAIN_TEXT

        @Metadata(javaType="Boolean",
                  applicableFor="xmlsecurity-sign")
        public static final String HEADER_MESSAGE_IS_PLAIN_TEXT
        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)
        See Also:
        Constant Field Values
      • HEADER_PLAIN_TEXT_ENCODING

        @Metadata(javaType="String",
                  applicableFor="xmlsecurity-sign")
        public static final String HEADER_PLAIN_TEXT_ENCODING
        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).
        See Also:
        Constant Field Values
      • HEADER_OMIT_XML_DECLARATION

        @Metadata(javaType="Boolean")
        public static final String HEADER_OMIT_XML_DECLARATION
        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).

        See Also:
        Constant Field Values
      • HEADER_CONTENT_REFERENCE_URI

        @Metadata(description="The content reference URI",
                  javaType="String",
                  applicableFor="xmlsecurity-sign")
        public static final String HEADER_CONTENT_REFERENCE_URI
        See Also:
        Constant Field Values
      • HEADER_CONTENT_REFERENCE_TYPE

        @Metadata(description="The content reference type",
                  javaType="String",
                  applicableFor="xmlsecurity-sign")
        public static final String HEADER_CONTENT_REFERENCE_TYPE
        See Also:
        Constant Field Values
      • HEADER_SCHEMA_RESOURCE_URI

        @Metadata(description="The schema resource URI",
                  javaType="String")
        public static final String HEADER_SCHEMA_RESOURCE_URI
        See Also:
        Constant Field Values
      • HEADER_XPATHS_TO_ID_ATTRIBUTES

        @Metadata(description="XPaths to id attributes",
                  javaType="String")
        public static final String HEADER_XPATHS_TO_ID_ATTRIBUTES
        See Also:
        Constant Field Values
      • HEADER_TRANSFORM_METHODS

        @Metadata(javaType="String",
                  applicableFor="xmlsecurity-sign")
        public static final String HEADER_TRANSFORM_METHODS
        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.

        See Also:
        Constant Field Values
      • HEADER_XADES_QUALIFYING_PROPERTIES_ID

        @Metadata(description="for the \'Id\' attribute value of `QualifyingProperties` element",
                  javaType="String")
        public static final String HEADER_XADES_QUALIFYING_PROPERTIES_ID
        Header for the 'Id' attribute value of the XAdES element 'QualifyingProperties'
        See Also:
        Constant Field Values
      • HEADER_XADES_SIGNED_DATA_OBJECT_PROPERTIES_ID

        @Metadata(description="for the \'Id\' attribute value of `SignedDataObjectProperties` element",
                  javaType="String")
        public static final String HEADER_XADES_SIGNED_DATA_OBJECT_PROPERTIES_ID
        Header for the 'Id' attribute value of the XAdES element 'SignedDataObjectProperties'
        See Also:
        Constant Field Values
      • HEADER_XADES_SIGNED_SIGNATURE_PROPERTIES_ID

        @Metadata(description="for the \'Id\' attribute value of `SignedSignatureProperties` element",
                  javaType="String")
        public static final String HEADER_XADES_SIGNED_SIGNATURE_PROPERTIES_ID
        Header for the 'Id' attribute value of the XAdES element 'SignedSignatureProperties'
        See Also:
        Constant Field Values
      • HEADER_XADES_DATA_OBJECT_FORMAT_ENCODING

        @Metadata(description="for the value of the Encoding element of the `DataObjectFormat` element",
                  javaType="String")
        public static final String HEADER_XADES_DATA_OBJECT_FORMAT_ENCODING
        Header for the "Encoding" element contained in the "DataObjectFormat" XAdES element.
        See Also:
        Constant Field Values
      • HEADER_XADES_NAMESPACE

        @Metadata(description="overwrites the XAdES namespace parameter value",
                  javaType="String")
        public static final String HEADER_XADES_NAMESPACE
        Header for the XAdES namespace. Different namespaces represent different XAdES specification versions. Currently supported namespaces are: http://uri.etsi.org/01903/v1.1.1#, http://uri.etsi.org/01903/v1.2.2#, http://uri.etsi.org/01903/v1.3.2#.
        See Also:
        Constant Field Values
      • HEADER_XADES_PREFIX

        @Metadata(description="overwrites the XAdES prefix parameter value",
                  javaType="String")
        public static final String HEADER_XADES_PREFIX
        Header for the XAdES namespace prefix. An empty string means that no prefix shall be used. A null header value will have no effect.
        See Also:
        Constant Field Values
      • CHARSET_NAME

        @Metadata(description="The name of the charset",
                  javaType="String")
        public static final String CHARSET_NAME
        See Also:
        Constant Field Values