Class SettingsType


  • public class SettingsType
    extends Object
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p400085_="https://jakarta.ee/xml/ns/jaxb" xmlns:p45416_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to configure global settings that should be respected when running the web service operation. This concerns e.g. settings whether the execution of the operation is allowed within the scope of the PDF document settings or how the result of the operation should be handled.</p>
     

    Java class for SettingsType complex type

    .

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

    
     <complexType name="SettingsType">
       <complexContent>
         <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
           <all>
             <element name="signature" type="{http://schema.webpdf.de/1.0/operation}SignatureSettingsType" minOccurs="0"/>
             <element name="compress" minOccurs="0">
               <complexType>
                 <complexContent>
                   <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                     <all>
                       <element name="compressObjects" type="{http://schema.webpdf.de/1.0/operation}CompressObjectsType" minOccurs="0"/>
                     </all>
                     <attribute name="compressProfile" type="{http://schema.webpdf.de/1.0/operation}CompressProfileType" default="never" />
                   </restriction>
                 </complexContent>
               </complexType>
             </element>
             <element name="pdfa" type="{http://schema.webpdf.de/1.0/operation}PdfaSettingsType" minOccurs="0"/>
             <element name="http" type="{http://schema.webpdf.de/1.0/operation}HttpSettingsType" minOccurs="0"/>
           </all>
         </restriction>
       </complexContent>
     </complexType>
     
    • Field Detail

      • signature

        protected SignatureSettingsType signature
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p400085_="https://jakarta.ee/xml/ns/jaxb" xmlns:p45416_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The <code>signature</code> element allows to make settings for automatic handling of digital signatures. The web service operation checks whether it´s execution is valid for a given signed document according to the settings or whether invalidation of the existing signatures is allowed. Thus, the settings allow for intentional invalidation of signatures.
                                 </p>
         
      • compress

        protected SettingsType.Compress compress
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p400085_="https://jakarta.ee/xml/ns/jaxb" xmlns:p45416_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The <code>compress</code> element can be used to automatically compress the contents of the PDF document when saving it. Whenever the web service operation saves the PDF document, it should try to compress it according to the settings specified here. Document compression can also be triggered specifically via the 'compress' web service instead.
                                 </p>
         
      • pdfa

        protected PdfaSettingsType pdfa
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p400085_="https://jakarta.ee/xml/ns/jaxb" xmlns:p45416_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">
                                     The <code>pdfa</code> element allows to make settings for automatic handling of PDF/A documents. The web service operation checks whether it´s execution is valid for a given PDF/A document according to the settings.
                                 </p>
         
      • http

        protected HttpSettingsType http
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p400085_="https://jakarta.ee/xml/ns/jaxb" xmlns:p45416_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The <code>http</code> element allows to define the options for all external HTTP requests made by the server during the execution of the web service operation.
                                 </p>
         
    • Constructor Detail

      • SettingsType

        public SettingsType()
    • Method Detail

      • getSignature

        public SignatureSettingsType getSignature()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p400085_="https://jakarta.ee/xml/ns/jaxb" xmlns:p45416_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The <code>signature</code> element allows to make settings for automatic handling of digital signatures. The web service operation checks whether it´s execution is valid for a given signed document according to the settings or whether invalidation of the existing signatures is allowed. Thus, the settings allow for intentional invalidation of signatures.
                                 </p>
         
        Returns:
        possible object is SignatureSettingsType
      • isSetSignature

        public boolean isSetSignature()
      • getCompress

        public SettingsType.Compress getCompress()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p400085_="https://jakarta.ee/xml/ns/jaxb" xmlns:p45416_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The <code>compress</code> element can be used to automatically compress the contents of the PDF document when saving it. Whenever the web service operation saves the PDF document, it should try to compress it according to the settings specified here. Document compression can also be triggered specifically via the 'compress' web service instead.
                                 </p>
         
        Returns:
        possible object is SettingsType.Compress
      • isSetCompress

        public boolean isSetCompress()
      • getPdfa

        public PdfaSettingsType getPdfa()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p400085_="https://jakarta.ee/xml/ns/jaxb" xmlns:p45416_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">
                                     The <code>pdfa</code> element allows to make settings for automatic handling of PDF/A documents. The web service operation checks whether it´s execution is valid for a given PDF/A document according to the settings.
                                 </p>
         
        Returns:
        possible object is PdfaSettingsType
      • isSetPdfa

        public boolean isSetPdfa()
      • getHttp

        public HttpSettingsType getHttp()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p400085_="https://jakarta.ee/xml/ns/jaxb" xmlns:p45416_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The <code>http</code> element allows to define the options for all external HTTP requests made by the server during the execution of the web service operation.
                                 </p>
         
        Returns:
        possible object is HttpSettingsType
      • isSetHttp

        public boolean isSetHttp()