Class PrivateKeyFileDataType

  • All Implemented Interfaces:
    FileDataType<String>

    public class PrivateKeyFileDataType
    extends Object
    implements FileDataType<String>
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p931607_="https://jakarta.ee/xml/ns/jaxb" xmlns:p994488_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Allows the private key to be passed (as a PEM file), for decryption of an asymmetrically encrypted document.
                         The transfer of multiple private keys or other structures is not provided for at this point; exactly one private key is expected for decrypting the document.
                         The rights recipient must already be assigned to the document when the document is encrypted. The certificate and private key must therefore be selected in such a way that they map a rights recipient who was entered in this document when it was encrypted.
                     </p>
     

    Java class for PrivateKeyFileDataType complex type

    .

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

    
     <complexType name="PrivateKeyFileDataType">
       <simpleContent>
         <extension base="<http://www.w3.org/2001/XMLSchema>string">
           <attGroup ref="{http://schema.webpdf.de/1.0/operation}FileDataGroup"/>
           <attribute name="password" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
         </extension>
       </simpleContent>
     </complexType>
     
    • Field Detail

      • value

        protected String value
      • password

        protected String password
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p931607_="https://jakarta.ee/xml/ns/jaxb" xmlns:p994488_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If the private key itself is encrypted (recommended), this password allows read access to the key to make it available for decrypting the document.</p>
         
      • source

        protected FileDataSourceType source
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p931607_="https://jakarta.ee/xml/ns/jaxb" xmlns:p994488_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the data source for the hereby expressed resource.
                                 Possible values are:
                                 <ul><li>value = The element's value shall contain the BASE64 encoded data.</li><li>uri = The data shall be located at the given uri.</li></ul></p>
         
      • uri

        protected String uri
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p931607_="https://jakarta.ee/xml/ns/jaxb" xmlns:p994488_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The uri the data shall be located at. (This shall only have effect, if the "source" is "uri".)</p>
         
    • Constructor Detail

      • PrivateKeyFileDataType

        public PrivateKeyFileDataType()
    • Method Detail

      • setValue

        public void setValue​(String value)
        Sets the value of the value property.
        Specified by:
        setValue in interface FileDataType<String>
        Parameters:
        value - allowed object is String
      • isSetValue

        public boolean isSetValue()
        Description copied from interface: FileDataType
        Returns true, if a direct byte value has been set.
        Specified by:
        isSetValue in interface FileDataType<String>
        Returns:
        true, if a direct byte value has been set.
      • getPassword

        public String getPassword()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p931607_="https://jakarta.ee/xml/ns/jaxb" xmlns:p994488_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If the private key itself is encrypted (recommended), this password allows read access to the key to make it available for decrypting the document.</p>
         
        Returns:
        possible object is String
      • setPassword

        public void setPassword​(String value)
        Sets the value of the password property.
        Parameters:
        value - allowed object is String
        See Also:
        getPassword()
      • isSetPassword

        public boolean isSetPassword()
      • getSource

        public FileDataSourceType getSource()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p931607_="https://jakarta.ee/xml/ns/jaxb" xmlns:p994488_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the data source for the hereby expressed resource.
                                 Possible values are:
                                 <ul><li>value = The element's value shall contain the BASE64 encoded data.</li><li>uri = The data shall be located at the given uri.</li></ul></p>
         
        Specified by:
        getSource in interface FileDataType<String>
        Returns:
        possible object is FileDataSourceType
      • isSetSource

        public boolean isSetSource()
        Description copied from interface: FileDataType
        Returns true, if a file data source has been set.
        Specified by:
        isSetSource in interface FileDataType<String>
        Returns:
        true, if a file data source has been set.
      • getUri

        public String getUri()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p931607_="https://jakarta.ee/xml/ns/jaxb" xmlns:p994488_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The uri the data shall be located at. (This shall only have effect, if the "source" is "uri".)</p>
         
        Specified by:
        getUri in interface FileDataType<String>
        Returns:
        possible object is String
      • isSetUri

        public boolean isSetUri()
        Description copied from interface: FileDataType
        Returns true, if a file source URI has been set.
        Specified by:
        isSetUri in interface FileDataType<String>
        Returns:
        true, if a file source URI has been set.