XmlSignature (JAXB Diagnostic Data Model 5.2.d4j.1 API)

java.lang.Object
- eu.europa.esig.dss.jaxb.diagnostic.XmlSignature

public class XmlSignature
extends Object

Java class for Signature complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Signature">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="SignatureFilename" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="ParentId" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ErrorMessage" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="DateTime" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="SignatureFormat" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="StructuralValidation" type="{http://dss.esig.europa.eu/validation/diagnostic}StructuralValidation" minOccurs="0"/>
         <element name="BasicSignature" type="{http://dss.esig.europa.eu/validation/diagnostic}BasicSignature"/>
         <element name="SigningCertificate" type="{http://dss.esig.europa.eu/validation/diagnostic}SigningCertificate" minOccurs="0"/>
         <element name="CertificateChain" type="{http://dss.esig.europa.eu/validation/diagnostic}CertificateChain" minOccurs="0"/>
         <element name="ContentType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ContentIdentifier" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ContentHints" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="SignatureProductionPlace" type="{http://dss.esig.europa.eu/validation/diagnostic}SignatureProductionPlace" minOccurs="0"/>
         <element name="CommitmentTypeIndication" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="Indication" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="ClaimedRoles" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="ClaimedRoles" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="CertifiedRoles" type="{http://dss.esig.europa.eu/validation/diagnostic}CertifiedRole" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Policy" type="{http://dss.esig.europa.eu/validation/diagnostic}Policy" minOccurs="0"/>
         <element name="Timestamps" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="Timestamp" type="{http://dss.esig.europa.eu/validation/diagnostic}Timestamp" maxOccurs="unbounded" minOccurs="0"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="SignatureScopes" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="SignatureScope" type="{http://dss.esig.europa.eu/validation/diagnostic}SignatureScope" maxOccurs="unbounded" minOccurs="0"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
       </sequence>
       <attribute name="Id" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="CounterSignature" type="{http://www.w3.org/2001/XMLSchema}boolean" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected XmlBasicSignature`	`basicSignature`
`protected List<XmlChainItem>`	`certificateChain`
`protected List<XmlCertifiedRole>`	`certifiedRoles`
`protected List<String>`	`claimedRoles`
`protected List<String>`	`commitmentTypeIndication`
`protected String`	`contentHints`
`protected String`	`contentIdentifier`
`protected String`	`contentType`
`protected Boolean`	`counterSignature`
`protected Date`	`dateTime`
`protected String`	`errorMessage`
`protected String`	`id`
`protected String`	`parentId`
`protected XmlPolicy`	`policy`
`protected String`	`signatureFilename`
`protected String`	`signatureFormat`
`protected XmlSignatureProductionPlace`	`signatureProductionPlace`
`protected List<XmlSignatureScope>`	`signatureScopes`
`protected XmlSigningCertificate`	`signingCertificate`
`protected XmlStructuralValidation`	`structuralValidation`
`protected List<XmlTimestamp>`	`timestamps`

Constructor Summary

Constructors
Constructor and Description

XmlSignature()

Constructors
Constructor and Description
`XmlSignature()`

Method Summary

Methods
Modifier and Type	Method and Description
`XmlBasicSignature`	`getBasicSignature()` Gets the value of the basicSignature property.
`List<XmlChainItem>`	`getCertificateChain()`
`List<XmlCertifiedRole>`	`getCertifiedRoles()` Gets the value of the certifiedRoles property.
`List<String>`	`getClaimedRoles()`
`List<String>`	`getCommitmentTypeIndication()`
`String`	`getContentHints()` Gets the value of the contentHints property.
`String`	`getContentIdentifier()` Gets the value of the contentIdentifier property.
`String`	`getContentType()` Gets the value of the contentType property.
`Date`	`getDateTime()` Gets the value of the dateTime property.
`String`	`getErrorMessage()` Gets the value of the errorMessage property.
`String`	`getId()` Gets the value of the id property.
`String`	`getParentId()` Gets the value of the parentId property.
`XmlPolicy`	`getPolicy()` Gets the value of the policy property.
`String`	`getSignatureFilename()` Gets the value of the signatureFilename property.
`String`	`getSignatureFormat()` Gets the value of the signatureFormat property.
`XmlSignatureProductionPlace`	`getSignatureProductionPlace()` Gets the value of the signatureProductionPlace property.
`List<XmlSignatureScope>`	`getSignatureScopes()`
`XmlSigningCertificate`	`getSigningCertificate()` Gets the value of the signingCertificate property.
`XmlStructuralValidation`	`getStructuralValidation()` Gets the value of the structuralValidation property.
`List<XmlTimestamp>`	`getTimestamps()`
`Boolean`	`isCounterSignature()` Gets the value of the counterSignature property.
`void`	`setBasicSignature(XmlBasicSignature value)` Sets the value of the basicSignature property.
`void`	`setCertificateChain(List<XmlChainItem> certificateChain)`
`void`	`setClaimedRoles(List<String> claimedRoles)`
`void`	`setCommitmentTypeIndication(List<String> commitmentTypeIndication)`
`void`	`setContentHints(String value)` Sets the value of the contentHints property.
`void`	`setContentIdentifier(String value)` Sets the value of the contentIdentifier property.
`void`	`setContentType(String value)` Sets the value of the contentType property.
`void`	`setCounterSignature(Boolean value)` Sets the value of the counterSignature property.
`void`	`setDateTime(Date value)` Sets the value of the dateTime property.
`void`	`setErrorMessage(String value)` Sets the value of the errorMessage property.
`void`	`setId(String value)` Sets the value of the id property.
`void`	`setParentId(String value)` Sets the value of the parentId property.
`void`	`setPolicy(XmlPolicy value)` Sets the value of the policy property.
`void`	`setSignatureFilename(String value)` Sets the value of the signatureFilename property.
`void`	`setSignatureFormat(String value)` Sets the value of the signatureFormat property.
`void`	`setSignatureProductionPlace(XmlSignatureProductionPlace value)` Sets the value of the signatureProductionPlace property.
`void`	`setSignatureScopes(List<XmlSignatureScope> signatureScopes)`
`void`	`setSigningCertificate(XmlSigningCertificate value)` Sets the value of the signingCertificate property.
`void`	`setStructuralValidation(XmlStructuralValidation value)` Sets the value of the structuralValidation property.
`void`	`setTimestamps(List<XmlTimestamp> timestamps)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - signatureFilename
```
protected String signatureFilename
```
  - parentId
```
protected String parentId
```
  - errorMessage
```
protected String errorMessage
```
  - dateTime
```
protected Date dateTime
```
  - signatureFormat
```
protected String signatureFormat
```
  - structuralValidation
```
protected XmlStructuralValidation structuralValidation
```
  - basicSignature
```
protected XmlBasicSignature basicSignature
```
  - signingCertificate
```
protected XmlSigningCertificate signingCertificate
```
  - certificateChain
```
protected List<XmlChainItem> certificateChain
```
  - contentType
```
protected String contentType
```
  - contentIdentifier
```
protected String contentIdentifier
```
  - contentHints
```
protected String contentHints
```
  - signatureProductionPlace
```
protected XmlSignatureProductionPlace signatureProductionPlace
```
  - commitmentTypeIndication
```
protected List<String> commitmentTypeIndication
```
  - claimedRoles
```
protected List<String> claimedRoles
```
  - certifiedRoles
```
protected List<XmlCertifiedRole> certifiedRoles
```
  - policy
```
protected XmlPolicy policy
```
  - timestamps
```
protected List<XmlTimestamp> timestamps
```
  - signatureScopes
```
protected List<XmlSignatureScope> signatureScopes
```
  - id
```
protected String id
```
  - counterSignature
```
protected Boolean counterSignature
```
- Constructor Detail
  - XmlSignature
```
public XmlSignature()
```
- Method Detail
  - getSignatureFilename
```
public String getSignatureFilename()
```
    Gets the value of the signatureFilename property.
    
    Returns:
    possible object is String
  - setSignatureFilename
```
public void setSignatureFilename(String value)
```
    Sets the value of the signatureFilename property.
    
    Parameters:
    value - allowed object is String
  - getParentId
```
public String getParentId()
```
    Gets the value of the parentId property.
    
    Returns:
    possible object is String
  - setParentId
```
public void setParentId(String value)
```
    Sets the value of the parentId property.
    
    Parameters:
    value - allowed object is String
  - getErrorMessage
```
public String getErrorMessage()
```
    Gets the value of the errorMessage property.
    
    Returns:
    possible object is String
  - setErrorMessage
```
public void setErrorMessage(String value)
```
    Sets the value of the errorMessage property.
    
    Parameters:
    value - allowed object is String
  - getDateTime
```
public Date getDateTime()
```
    Gets the value of the dateTime property.
    
    Returns:
    possible object is String
  - setDateTime
```
public void setDateTime(Date value)
```
    Sets the value of the dateTime property.
    
    Parameters:
    value - allowed object is String
  - getSignatureFormat
```
public String getSignatureFormat()
```
    Gets the value of the signatureFormat property.
    
    Returns:
    possible object is String
  - setSignatureFormat
```
public void setSignatureFormat(String value)
```
    Sets the value of the signatureFormat property.
    
    Parameters:
    value - allowed object is String
  - getStructuralValidation
```
public XmlStructuralValidation getStructuralValidation()
```
    Gets the value of the structuralValidation property.
    
    Returns:
    possible object is XmlStructuralValidation
  - setStructuralValidation
```
public void setStructuralValidation(XmlStructuralValidation value)
```
    Sets the value of the structuralValidation property.
    
    Parameters:
    value - allowed object is XmlStructuralValidation
  - getBasicSignature
```
public XmlBasicSignature getBasicSignature()
```
    Gets the value of the basicSignature property.
    
    Returns:
    possible object is XmlBasicSignature
  - setBasicSignature
```
public void setBasicSignature(XmlBasicSignature value)
```
    Sets the value of the basicSignature property.
    
    Parameters:
    value - allowed object is XmlBasicSignature
  - getSigningCertificate
```
public XmlSigningCertificate getSigningCertificate()
```
    Gets the value of the signingCertificate property.
    
    Returns:
    possible object is XmlSigningCertificate
  - setSigningCertificate
```
public void setSigningCertificate(XmlSigningCertificate value)
```
    Sets the value of the signingCertificate property.
    
    Parameters:
    value - allowed object is XmlSigningCertificate
  - getContentType
```
public String getContentType()
```
    Gets the value of the contentType property.
    
    Returns:
    possible object is String
  - setContentType
```
public void setContentType(String value)
```
    Sets the value of the contentType property.
    
    Parameters:
    value - allowed object is String
  - getContentIdentifier
```
public String getContentIdentifier()
```
    Gets the value of the contentIdentifier property.
    
    Returns:
    possible object is String
  - setContentIdentifier
```
public void setContentIdentifier(String value)
```
    Sets the value of the contentIdentifier property.
    
    Parameters:
    value - allowed object is String
  - getContentHints
```
public String getContentHints()
```
    Gets the value of the contentHints property.
    
    Returns:
    possible object is String
  - setContentHints
```
public void setContentHints(String value)
```
    Sets the value of the contentHints property.
    
    Parameters:
    value - allowed object is String
  - getSignatureProductionPlace
```
public XmlSignatureProductionPlace getSignatureProductionPlace()
```
    Gets the value of the signatureProductionPlace property.
    
    Returns:
    possible object is XmlSignatureProductionPlace
  - setSignatureProductionPlace
```
public void setSignatureProductionPlace(XmlSignatureProductionPlace value)
```
    Sets the value of the signatureProductionPlace property.
    
    Parameters:
    value - allowed object is XmlSignatureProductionPlace
  - getCertifiedRoles
```
public List<XmlCertifiedRole> getCertifiedRoles()
```
    Gets the value of the certifiedRoles property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the certifiedRoles property.
    For example, to add a new item, do as follows:
```
    getCertifiedRoles().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list XmlCertifiedRole
  - getPolicy
```
public XmlPolicy getPolicy()
```
    Gets the value of the policy property.
    
    Returns:
    possible object is XmlPolicy
  - setPolicy
```
public void setPolicy(XmlPolicy value)
```
    Sets the value of the policy property.
    
    Parameters:
    value - allowed object is XmlPolicy
  - getId
```
public String getId()
```
    Gets the value of the id property.
    
    Returns:
    possible object is String
  - setId
```
public void setId(String value)
```
    Sets the value of the id property.
    
    Parameters:
    value - allowed object is String
  - isCounterSignature
```
public Boolean isCounterSignature()
```
    Gets the value of the counterSignature property.
    
    Returns:
    possible object is Boolean
  - setCounterSignature
```
public void setCounterSignature(Boolean value)
```
    Sets the value of the counterSignature property.
    
    Parameters:
    value - allowed object is Boolean
  - getCertificateChain
```
public List<XmlChainItem> getCertificateChain()
```
  - setCertificateChain
```
public void setCertificateChain(List<XmlChainItem> certificateChain)
```
  - getCommitmentTypeIndication
```
public List<String> getCommitmentTypeIndication()
```
  - setCommitmentTypeIndication
```
public void setCommitmentTypeIndication(List<String> commitmentTypeIndication)
```
  - getClaimedRoles
```
public List<String> getClaimedRoles()
```
  - setClaimedRoles
```
public void setClaimedRoles(List<String> claimedRoles)
```
  - getTimestamps
```
public List<XmlTimestamp> getTimestamps()
```
  - setTimestamps
```
public void setTimestamps(List<XmlTimestamp> timestamps)
```
  - getSignatureScopes
```
public List<XmlSignatureScope> getSignatureScopes()
```
  - setSignatureScopes
```
public void setSignatureScopes(List<XmlSignatureScope> signatureScopes)
```

Class XmlSignature

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

signatureFilename

parentId

errorMessage

dateTime

signatureFormat

structuralValidation

basicSignature

signingCertificate

certificateChain

contentType

contentIdentifier

contentHints

signatureProductionPlace

commitmentTypeIndication

claimedRoles

certifiedRoles

policy

timestamps

signatureScopes

id

counterSignature

Constructor Detail

XmlSignature

Method Detail

getSignatureFilename

setSignatureFilename

getParentId

setParentId

getErrorMessage

setErrorMessage

getDateTime

setDateTime

getSignatureFormat

setSignatureFormat

getStructuralValidation

setStructuralValidation

getBasicSignature

setBasicSignature

getSigningCertificate

setSigningCertificate

getContentType

setContentType

getContentIdentifier

setContentIdentifier

getContentHints

setContentHints

getSignatureProductionPlace

setSignatureProductionPlace

getCertifiedRoles

getPolicy

setPolicy

getId

setId

isCounterSignature

setCounterSignature

getCertificateChain

setCertificateChain

getCommitmentTypeIndication

setCommitmentTypeIndication

getClaimedRoles

setClaimedRoles

getTimestamps

setTimestamps

getSignatureScopes

setSignatureScopes