Package net.webpdf.parameter.schema.extraction.info

Class PasswordType

  • public class PasswordType
extends Object
     <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">An element of this type shall contain information concerning the used encryption and the used encryption key.</p>

    Java class for PasswordType complex type

    .

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

    
 <complexType name="PasswordType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="hasOpenPassword" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="hasPermissionPassword" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="hasAsymmetricEncryption" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="keyLength" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="keyAlgorithm" type="{http://schema.webpdf.de/1.0/extraction/info}KeyAlgorithmType" default="none" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • hasOpenPassword

        protected Boolean hasOpenPassword
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this is set to "true", the document is encrypted and requires a password to be opened.</p>

      • hasPermissionPassword

        protected Boolean hasPermissionPassword
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this is set to "true", the document has a change protection and a password is required to claim ownership and modify the document.</p>

      • hasAsymmetricEncryption

        protected Boolean hasAsymmetricEncryption
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this is set to "true", the document is asymmetrically encrypted and a matching private key is required to decrypt it.
                         Otherwise the document is symetrically encrypted and requires a password.
                     </p>

      • keyLength

        protected Integer keyLength
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The Bit length of the key used for encryption.</p>

      • keyAlgorithm

        protected KeyAlgorithmType keyAlgorithm
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The algorithm used for encryption.
                         <ul><li>none = The document is not encrypted.</li><li>aes = The document has been encrypted using the Advanced Encryption Standard.</li><li>rc4 = The document has been encrypted using the RC4 cipher.</li></ul></p>

    • Constructor Detail

      • PasswordType

        public PasswordType()

    • Method Detail

      • isHasOpenPassword

        public boolean isHasOpenPassword()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this is set to "true", the document is encrypted and requires a password to be opened.</p>
        Returns:
        possible object is Boolean

      • setHasOpenPassword

        public void setHasOpenPassword​(Boolean value)
        Sets the value of the hasOpenPassword property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isHasOpenPassword()

      • isHasPermissionPassword

        public boolean isHasPermissionPassword()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this is set to "true", the document has a change protection and a password is required to claim ownership and modify the document.</p>
        Returns:
        possible object is Boolean

      • setHasPermissionPassword

        public void setHasPermissionPassword​(Boolean value)
        Sets the value of the hasPermissionPassword property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isHasPermissionPassword()

      • isHasAsymmetricEncryption

        public boolean isHasAsymmetricEncryption()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this is set to "true", the document is asymmetrically encrypted and a matching private key is required to decrypt it.
                         Otherwise the document is symetrically encrypted and requires a password.
                     </p>
        Returns:
        possible object is Boolean

      • setHasAsymmetricEncryption

        public void setHasAsymmetricEncryption​(Boolean value)
        Sets the value of the hasAsymmetricEncryption property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isHasAsymmetricEncryption()

      • getKeyLength

        public int getKeyLength()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The Bit length of the key used for encryption.</p>
        Returns:
        possible object is Integer

      • setKeyLength

        public void setKeyLength​(Integer value)
        Sets the value of the keyLength property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getKeyLength()

      • getKeyAlgorithm

        public KeyAlgorithmType getKeyAlgorithm()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The algorithm used for encryption.
                         <ul><li>none = The document is not encrypted.</li><li>aes = The document has been encrypted using the Advanced Encryption Standard.</li><li>rc4 = The document has been encrypted using the RC4 cipher.</li></ul></p>
        Returns:
        possible object is KeyAlgorithmType