Package eu.europa.esig.dss.model

Class CommonCommitmentType

java.lang.Object
eu.europa.esig.dss.model.CommonCommitmentType
All Implemented Interfaces:
CommitmentType, ObjectIdentifier, OidAndUriBasedEnum, OidBasedEnum, OidDescription, UriBasedEnum, Serializable
public class CommonCommitmentType extends Object implements CommitmentType
This class provides a basic implementation of CommitmentType providing a possibility to create a customized CommitmentType signed property.
See Also:

  • Constructor Details

    • CommonCommitmentType

      public CommonCommitmentType()
      Default constructor instantiating object with null values

  • Method Details

    • getUri

      public String getUri()
      Description copied from interface: UriBasedEnum
      Returns a URI
      Specified by:
      getUri in interface UriBasedEnum
      Returns:
      String

    • setUri

      public void setUri(String uri)
      Sets URI identifying the CommitmentType Use : CONDITIONAL (should be present in XAdES, JAdES)
      Parameters:
      uri - String

    • getOid

      public String getOid()
      Description copied from interface: OidBasedEnum
      This method returns the OID value
      Specified by:
      getOid in interface OidBasedEnum
      Returns:
      the OID value

    • setOid

      public void setOid(String oid)
      Sets OID identifying the CommitmentType Use : CONDITIONAL (shall be present in CAdES, PAdES. May be present in XAdES, JAdES). Note : when using OID in XAdES, a Qualifier shall be defined within the method setQualifier(qualifier). See EN 319 132-1 "5.1.2 The ObjectIdentifierType data type" for more information.
      Parameters:
      oid - String

    • getQualifier

      public ObjectIdentifierQualifier getQualifier()
      Description copied from interface: ObjectIdentifier
      Returns Object Identifier Qualifier
      Specified by:
      getQualifier in interface ObjectIdentifier
      Returns:
      ObjectIdentifierQualifier

    • setQualifier

      public void setQualifier(ObjectIdentifierQualifier qualifier)
      Sets Qualifier defining the type of OID identifier used for CommitmentType. See EN 319 132-1 "5.1.2 The ObjectIdentifierType data type" for more information. Use : CONDITIONAL (shall be present XAdES when using OID identifier, but not URI) Note : used only in XAdES
      Parameters:
      qualifier - ObjectIdentifierQualifier

    • getDescription

      public String getDescription()
      Description copied from interface: OidDescription
      This method returns the literal description of the OID
      Specified by:
      getDescription in interface OidDescription
      Returns:
      the OID description

    • setDescription

      public void setDescription(String description)
      Sets text describing the CommitmentType object. Use : OPTIONAL
      Parameters:
      description - String

    • getDocumentationReferences

      public String[] getDocumentationReferences()
      Description copied from interface: ObjectIdentifier
      Returns a list of URI-based references NOTE: used in XAdES
      Specified by:
      getDocumentationReferences in interface ObjectIdentifier
      Returns:
      an array of URI String references

    • setDocumentationReferences

      public void setDocumentationReferences(String... documentationReferences)
      Sets references pointing to a documentation describing the CommitmentType Use : OPTIONAL
      Parameters:
      documentationReferences - array of Strings

    • getSignedDataObjects

      public String[] getSignedDataObjects()
      Gets references to signed data objects for the current CommitmentType
      Returns:
      array of Strings

    • setSignedDataObjects

      public void setSignedDataObjects(String... signedDataObjects)
      Sets signed data objects referenced by the current CommitmentType. When CommitmentType is made for a subset of signed data objects, each element of the array shall refer one ds:Reference element within the ds:SignedInfo element or within a signed ds:Manifest element. When CommitmentType is made for all signed data objects, the array shall be: - empty (default), then AllSignedDataObjects element will be created; or - contain references to all signed data objects (one ObjectReference will be created for each). Use : OPTIONAL (XAdES only)
      Parameters:
      signedDataObjects - array of Strings

    • getCommitmentTypeQualifiers

      public CommitmentQualifier[] getCommitmentTypeQualifiers()
      Gets custom CommitmentTypeQualifiers List
      Returns:
      array of DSSDocuments

    • setCommitmentTypeQualifiers

      public void setCommitmentTypeQualifiers(CommitmentQualifier... commitmentTypeQualifiers)
      Sets custom CommitmentTypeQualifiers List. Use : OPTIONAL
      Parameters:
      commitmentTypeQualifiers - array of CommitmentQualifiers representing content of the CommitmentTypeQualifier element