Package net.webpdf.wsclient.schema.operation

Class SignatureType.Add

java.lang.Object

net.webpdf.wsclient.schema.operation.SignatureType.Add

Enclosing class:

SignatureType

public static class SignatureType.Add
extends Object

Java class for anonymous complex type

.

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

 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <all>
         <element name="appearance" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <all>
                   <element name="position" type="{http://schema.webpdf.de/1.0/operation}SignaturePositionType" minOccurs="0"/>
                   <element name="image" type="{http://schema.webpdf.de/1.0/operation}SignatureImageType" minOccurs="0"/>
                   <element name="identifierElements" type="{http://schema.webpdf.de/1.0/operation}SignatureIdentifierType" minOccurs="0"/>
                 </all>
                 <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
                 <attribute name="identifier" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
                 <attribute name="page" default="1">
                   <simpleType>
                     <restriction base="{http://www.w3.org/2001/XMLSchema}int">
                       <minInclusive value="1"/>
                     </restriction>
                   </simpleType>
                 </attribute>
                 <attribute name="showCommonName" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="signer" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <all>
                   <element name="keyPair" type="{http://schema.webpdf.de/1.0/operation}KeyPairType"/>
                 </all>
               </restriction>
             </complexContent>
           </complexType>
         </element>
       </all>
       <attGroup ref="{http://schema.webpdf.de/1.0/operation}SignatureInfoGroup"/>
       <attribute name="certificationLevel" type="{http://schema.webpdf.de/1.0/operation}CertificationLevelType" default="noChanges" />
       <attribute name="fieldName" type="{http://www.w3.org/2001/XMLSchema}string" default="Signature1" />
       <attribute name="keyName" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="keyPassword" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="appendSignature" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SignatureType.Add.Appearance	Java class for anonymous complex type
static class	SignatureType.Add.Signer	Java class for anonymous complex type

Field Summary

Fields

Modifier and Type	Field	Description
protected SignatureType.Add.Appearance	appearance	<?
protected Boolean	appendSignature	<?
protected CertificationLevelType	certificationLevel	<?
protected String	contact	<?
protected String	fieldName	<?
protected String	keyName	<?
protected String	keyPassword	<?
protected String	location	<?
protected String	reason	<?
protected SignatureType.Add.Signer	signer	<?

Constructor Summary

Constructors

Constructor	Description
Add()

Method Summary

Modifier and Type	Method	Description
SignatureType.Add.Appearance	getAppearance()	<?
CertificationLevelType	getCertificationLevel()	<?
String	getContact()	<?
String	getFieldName()	<?
String	getKeyName()	<?
String	getKeyPassword()	<?
String	getLocation()	<?
String	getReason()	<?
SignatureType.Add.Signer	getSigner()	<?
boolean	isAppendSignature()	<?
boolean	isSetAppearance()
boolean	isSetAppendSignature()
boolean	isSetCertificationLevel()
boolean	isSetContact()
boolean	isSetFieldName()
boolean	isSetKeyName()
boolean	isSetKeyPassword()
boolean	isSetLocation()
boolean	isSetReason()
boolean	isSetSigner()
void	setAppearance(SignatureType.Add.Appearance value)	Sets the value of the appearance property.
void	setAppendSignature(boolean value)	Sets the value of the appendSignature property.
void	setCertificationLevel(CertificationLevelType value)	Sets the value of the certificationLevel property.
void	setContact(String value)	Sets the value of the contact property.
void	setFieldName(String value)	Sets the value of the fieldName property.
void	setKeyName(String value)	Sets the value of the keyName property.
void	setKeyPassword(String value)	Sets the value of the keyPassword property.
void	setLocation(String value)	Sets the value of the location property.
void	setReason(String value)	Sets the value of the reason property.
void	setSigner(SignatureType.Add.Signer value)	Sets the value of the signer property.
void	unsetAppendSignature()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

appearance

protected SignatureType.Add.Appearance appearance

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the signature's visual appearance.</p>
 

signer

protected SignatureType.Add.Signer signer

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Contains a key pair (<code>&lt;keyPair&gt;</code>) consisting of the certificate (with public key) and the private key that identifies the signer (<code>&lt;signer&gt;</code>) who performs the signature. The certificate and the signer's private key must be passed as a PEM file in <code>&lt;certificate&gt;</code> and <code>&lt;privateKey&gt;</code> respectively.
                                         The element is optional. If no <code>&lt;keyPair&gt;</code> (consisting of the certificate and the private key) is passed directly, then a certificate must be selected via <code>&lt;keyName&gt;</code>, which is loaded from the server's global keystore.
                                     </p>
 

certificationLevel

protected CertificationLevelType certificationLevel

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This parameter defines the level of the signature.
                                     <ul><li>none = Sign, but do not certify, the document, i.e., additional signatures and changes will be allowed.</li><li>noChanges = Certify the document and do not allow any additional changes anymore.</li><li>formFillingAndSignatures = Certify the document, but allow for fields to be filled out.</li><li>formFillingAndSignaturesAndAnnotations = Certify the document, but allow for fields to be filled out and annotations to be added.</li></ul></p>
 

fieldName

protected String fieldName

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Defines the name of the field (in the document) in which the signature will be saved. If a field name that is not unique is declared, then a unique name will be automatically created.</p>
 

keyName

protected String keyName

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Defines the name of the key (alias) that is to be used to sign the document. This option overwrites the server's configuration setting. Additional information can be found in the "Keystore" chapter.</p>
 

keyPassword

protected String keyPassword

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the password required in order to access the private key with "keyName." This option overwrites the server's configuration setting. Additional information can be found in the "Keystore" chapter.</p>
 

appendSignature

protected Boolean appendSignature

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Deprecated:</b>
                                     Usage of this parameter is discouraged, as it is no longer in use.
                                 </p>
 

location

protected String location

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies the location of the signature.</p>
 

contact

protected String contact

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies the name of the person signing the document.</p>
 

reason

protected String reason

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies the reason why the document is being signed.</p>
 

Constructor Detail

Add

public Add()

Method Detail

getAppearance

public SignatureType.Add.Appearance getAppearance()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the signature's visual appearance.</p>
 

Returns:

possible object is SignatureType.Add.Appearance

setAppearance

public void setAppearance(SignatureType.Add.Appearance value)

Sets the value of the appearance property.

Parameters:

value - allowed object is SignatureType.Add.Appearance

See Also:

getAppearance()

isSetAppearance

public boolean isSetAppearance()

getSigner

public SignatureType.Add.Signer getSigner()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Contains a key pair (<code>&lt;keyPair&gt;</code>) consisting of the certificate (with public key) and the private key that identifies the signer (<code>&lt;signer&gt;</code>) who performs the signature. The certificate and the signer's private key must be passed as a PEM file in <code>&lt;certificate&gt;</code> and <code>&lt;privateKey&gt;</code> respectively.
                                         The element is optional. If no <code>&lt;keyPair&gt;</code> (consisting of the certificate and the private key) is passed directly, then a certificate must be selected via <code>&lt;keyName&gt;</code>, which is loaded from the server's global keystore.
                                     </p>
 

Returns:

possible object is SignatureType.Add.Signer

setSigner

public void setSigner(SignatureType.Add.Signer value)

Sets the value of the signer property.

Parameters:

value - allowed object is SignatureType.Add.Signer

See Also:

getSigner()

isSetSigner

public boolean isSetSigner()

getCertificationLevel

public CertificationLevelType getCertificationLevel()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This parameter defines the level of the signature.
                                     <ul><li>none = Sign, but do not certify, the document, i.e., additional signatures and changes will be allowed.</li><li>noChanges = Certify the document and do not allow any additional changes anymore.</li><li>formFillingAndSignatures = Certify the document, but allow for fields to be filled out.</li><li>formFillingAndSignaturesAndAnnotations = Certify the document, but allow for fields to be filled out and annotations to be added.</li></ul></p>
 

Returns:

possible object is CertificationLevelType

setCertificationLevel

public void setCertificationLevel(CertificationLevelType value)

Sets the value of the certificationLevel property.

Parameters:

value - allowed object is CertificationLevelType

See Also:

getCertificationLevel()

isSetCertificationLevel

public boolean isSetCertificationLevel()

getFieldName

public String getFieldName()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Defines the name of the field (in the document) in which the signature will be saved. If a field name that is not unique is declared, then a unique name will be automatically created.</p>
 

Returns:

possible object is String

setFieldName

public void setFieldName(String value)

Sets the value of the fieldName property.

Parameters:

value - allowed object is String

See Also:

getFieldName()

isSetFieldName

public boolean isSetFieldName()

getKeyName

public String getKeyName()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Defines the name of the key (alias) that is to be used to sign the document. This option overwrites the server's configuration setting. Additional information can be found in the "Keystore" chapter.</p>
 

Returns:

possible object is String

setKeyName

public void setKeyName(String value)

Sets the value of the keyName property.

Parameters:

value - allowed object is String

See Also:

getKeyName()

isSetKeyName

public boolean isSetKeyName()

getKeyPassword

public String getKeyPassword()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the password required in order to access the private key with "keyName." This option overwrites the server's configuration setting. Additional information can be found in the "Keystore" chapter.</p>
 

Returns:

possible object is String

setKeyPassword

public void setKeyPassword(String value)

Sets the value of the keyPassword property.

Parameters:

value - allowed object is String

See Also:

getKeyPassword()

isSetKeyPassword

public boolean isSetKeyPassword()

isAppendSignature

public boolean isAppendSignature()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Deprecated:</b>
                                     Usage of this parameter is discouraged, as it is no longer in use.
                                 </p>
 

Returns:

possible object is Boolean

setAppendSignature

public void setAppendSignature(boolean value)

Sets the value of the appendSignature property.

Parameters:

value - allowed object is Boolean

See Also:

isAppendSignature()

isSetAppendSignature

public boolean isSetAppendSignature()

unsetAppendSignature

public void unsetAppendSignature()

getLocation

public String getLocation()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies the location of the signature.</p>
 

Returns:

possible object is String

setLocation

public void setLocation(String value)

Sets the value of the location property.

Parameters:

value - allowed object is String

See Also:

getLocation()

isSetLocation

public boolean isSetLocation()

getContact

public String getContact()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies the name of the person signing the document.</p>
 

Returns:

possible object is String

setContact

public void setContact(String value)

Sets the value of the contact property.

Parameters:

value - allowed object is String

See Also:

getContact()

isSetContact

public boolean isSetContact()

getReason

public String getReason()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p31332_="https://jakarta.ee/xml/ns/jaxb" xmlns:p993856_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies the reason why the document is being signed.</p>
 

Returns:

possible object is String

setReason

public void setReason(String value)

Sets the value of the reason property.

Parameters:

value - allowed object is String

See Also:

getReason()

isSetReason

public boolean isSetReason()