Package org.apache.jasper

Class EmbeddedServletOptions

  • All Implemented Interfaces:
    Options
    public final class EmbeddedServletOptions
extends java.lang.Object
implements Options
    A class to hold all init parameters specific to the JSP engine.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int checkInterval
      Background compile thread check interval in seconds.
      private boolean classDebugInfo
      Do we want to include debugging information in the class file?
      private java.lang.String classpath
      What classpath should I use while compiling generated servlets?
      private java.lang.String compiler
      Compiler to use.
      private java.lang.String compilerClassName
      The compiler class name.
      private java.lang.String compilerSourceVM
      The compiler source VM.
      private java.lang.String compilerTargetVM
      Compiler target VM.
      private boolean defaultBufferNone  
      private boolean development
      Is Jasper being used in development mode?
      private boolean errorOnUseBeanInvalidClassAttribute  
      boolean fork
      Should Ant fork its java compiles of JSP pages.
      private boolean genStringAsByteArray  
      private boolean genStringAsCharArray
      Are Text strings to be generated as char arrays?
      private java.lang.String ieClassId
      Need to have this as is for versions 4 and 5 of IE.
      private int initialCapacity  
      private boolean isPoolingEnabled
      Determines whether tag handler pooling is enabled.
      private boolean isSmapDumped
      Should SMAP info for JSR45 debugging be dumped to a file?
      private boolean isSmapSuppressed
      Is the generation of SMAP info for JSR45 debuggin suppressed?
      private boolean isValidationEnabled  
      private java.lang.String javaEncoding
      Java platform encoding to generate the JSP page servlet.
      private JspConfig jspConfig
      Jsp config information
      private boolean keepGenerated
      Do you want to keep the generated Java files around?
      private static java.util.logging.Logger log  
      private boolean mappedFile
      Do you want support for "mapped" files? This will generate servlet that has a print statement per line of the JSP file.
      private int modificationTestInterval
      Modification test interval.
      private boolean saveBytecode
      If class files are generated as byte arrays, should they be saved to disk at the end of compilations?
      private java.io.File scratchDir
      I want to see my generated servlets.
      private boolean sendErrorToClient
      Do you want stack traces and such displayed in the client's browser? If this is false, such messages go to the standard error or a log file if the standard error is redirected.
      private java.util.Properties settings  
      private java.lang.String sysClassPath  
      private TagPluginManager tagPluginManager
      TagPluginManager
      private TldScanner tldScanner
      Cache for the TLD locations
      private boolean trimSpaces
      Should white spaces between directives or actions be trimmed?
      private boolean usePrecompiled  
      private boolean xpoweredBy
      Is generation of X-Powered-By response header enabled/disabled?

    • Constructor Summary

      Constructors 
      Constructor Description
      EmbeddedServletOptions​(javax.servlet.ServletConfig config, javax.servlet.ServletContext context)
      Create an EmbeddedServletOptions object using data available from ServletConfig and ServletContext.

    • Field Detail

      • log

        private static java.util.logging.Logger log

      • settings

        private java.util.Properties settings

      • development

        private boolean development
        Is Jasper being used in development mode?

      • fork

        public boolean fork
        Should Ant fork its java compiles of JSP pages.

      • keepGenerated

        private boolean keepGenerated
        Do you want to keep the generated Java files around?

      • saveBytecode

        private boolean saveBytecode
        If class files are generated as byte arrays, should they be saved to disk at the end of compilations?

      • trimSpaces

        private boolean trimSpaces
        Should white spaces between directives or actions be trimmed?

      • isPoolingEnabled

        private boolean isPoolingEnabled
        Determines whether tag handler pooling is enabled.

      • mappedFile

        private boolean mappedFile
        Do you want support for "mapped" files? This will generate servlet that has a print statement per line of the JSP file. This seems like a really nice feature to have for debugging.

      • sendErrorToClient

        private boolean sendErrorToClient
        Do you want stack traces and such displayed in the client's browser? If this is false, such messages go to the standard error or a log file if the standard error is redirected.

      • classDebugInfo

        private boolean classDebugInfo
        Do we want to include debugging information in the class file?

      • checkInterval

        private int checkInterval
        Background compile thread check interval in seconds.

      • isSmapSuppressed

        private boolean isSmapSuppressed
        Is the generation of SMAP info for JSR45 debuggin suppressed?

      • isSmapDumped

        private boolean isSmapDumped
        Should SMAP info for JSR45 debugging be dumped to a file?

      • genStringAsCharArray

        private boolean genStringAsCharArray
        Are Text strings to be generated as char arrays?

      • genStringAsByteArray

        private boolean genStringAsByteArray

      • defaultBufferNone

        private boolean defaultBufferNone

      • errorOnUseBeanInvalidClassAttribute

        private boolean errorOnUseBeanInvalidClassAttribute

      • scratchDir

        private java.io.File scratchDir
        I want to see my generated servlets. Which directory are they in?

      • ieClassId

        private java.lang.String ieClassId
        Need to have this as is for versions 4 and 5 of IE. Can be set from the initParams so if it changes in the future all that is needed is to have a jsp initParam of type ieClassId=""

      • classpath

        private java.lang.String classpath
        What classpath should I use while compiling generated servlets?

      • sysClassPath

        private java.lang.String sysClassPath

      • compiler

        private java.lang.String compiler
        Compiler to use.

      • compilerTargetVM

        private java.lang.String compilerTargetVM
        Compiler target VM.

      • compilerSourceVM

        private java.lang.String compilerSourceVM
        The compiler source VM.

      • compilerClassName

        private java.lang.String compilerClassName
        The compiler class name.

      • tldScanner

        private TldScanner tldScanner
        Cache for the TLD locations

      • jspConfig

        private JspConfig jspConfig
        Jsp config information

      • javaEncoding

        private java.lang.String javaEncoding
        Java platform encoding to generate the JSP page servlet.

      • modificationTestInterval

        private int modificationTestInterval
        Modification test interval.

      • xpoweredBy

        private boolean xpoweredBy
        Is generation of X-Powered-By response header enabled/disabled?

      • usePrecompiled

        private boolean usePrecompiled

      • isValidationEnabled

        private boolean isValidationEnabled

      • initialCapacity

        private int initialCapacity

    • Constructor Detail

      • EmbeddedServletOptions

        public EmbeddedServletOptions​(javax.servlet.ServletConfig config,
                              javax.servlet.ServletContext context)
        Create an EmbeddedServletOptions object using data available from ServletConfig and ServletContext.

    • Method Detail

      • getProperty

        public java.lang.String getProperty​(java.lang.String name)

      • setProperty

        public void setProperty​(java.lang.String name,
                        java.lang.String value)

      • getKeepGenerated

        public boolean getKeepGenerated()
        Are we keeping generated code around?
        Specified by:
        getKeepGenerated in interface Options

      • getSaveBytecode

        public boolean getSaveBytecode()
        Description copied from interface: Options
        If class files are generated as byte arrays, should they be saved to disk at the end of compilations?
        Specified by:
        getSaveBytecode in interface Options

      • getTrimSpaces

        public boolean getTrimSpaces()
        Should white spaces between directives or actions be trimmed?
        Specified by:
        getTrimSpaces in interface Options

      • isPoolingEnabled

        public boolean isPoolingEnabled()
        Description copied from interface: Options
        Returns true if tag handler pooling is enabled, false otherwise.
        Specified by:
        isPoolingEnabled in interface Options

      • getMappedFile

        public boolean getMappedFile()
        Are we supporting HTML mapped servlets?
        Specified by:
        getMappedFile in interface Options

      • getSendErrorToClient

        public boolean getSendErrorToClient()
        Should errors be sent to client or thrown into stderr?
        Specified by:
        getSendErrorToClient in interface Options

      • getClassDebugInfo

        public boolean getClassDebugInfo()
        Should class files be compiled with debug information?
        Specified by:
        getClassDebugInfo in interface Options

      • getCheckInterval

        public int getCheckInterval()
        Background JSP compile thread check intervall
        Specified by:
        getCheckInterval in interface Options

      • getDevelopment

        public boolean getDevelopment()
        Is Jasper being used in development mode?
        Specified by:
        getDevelopment in interface Options

      • isSmapSuppressed

        public boolean isSmapSuppressed()
        Is the generation of SMAP info for JSR45 debuggin suppressed?
        Specified by:
        isSmapSuppressed in interface Options

      • isSmapDumped

        public boolean isSmapDumped()
        Should SMAP info for JSR45 debugging be dumped to a file?
        Specified by:
        isSmapDumped in interface Options

      • genStringAsCharArray

        public boolean genStringAsCharArray()
        Are Text strings to be generated as char arrays?
        Specified by:
        genStringAsCharArray in interface Options

      • genStringAsByteArray

        public boolean genStringAsByteArray()
        Description copied from interface: Options
        Are text strings to be generated as byte arrays, if the page is unbuffered?
        Specified by:
        genStringAsByteArray in interface Options

      • isDefaultBufferNone

        public boolean isDefaultBufferNone()
        Description copied from interface: Options
        If the buffer attribute for the page directive is not specified, is the default "none"?
        Specified by:
        isDefaultBufferNone in interface Options

      • getIeClassId

        public java.lang.String getIeClassId()
        Class ID for use in the plugin tag when the browser is IE.
        Specified by:
        getIeClassId in interface Options

      • getScratchDir

        public java.io.File getScratchDir()
        What is my scratch dir?
        Specified by:
        getScratchDir in interface Options

      • getClassPath

        public java.lang.String getClassPath()
        What classpath should I use while compiling the servlets generated from JSP files?
        Specified by:
        getClassPath in interface Options

      • getSystemClassPath

        public java.lang.String getSystemClassPath()
        Gets the system class path.
        Specified by:
        getSystemClassPath in interface Options
        Returns:
        The system class path

      • isXpoweredBy

        public boolean isXpoweredBy()
        Is generation of X-Powered-By response header enabled/disabled?
        Specified by:
        isXpoweredBy in interface Options

      • getCompiler

        public java.lang.String getCompiler()
        Compiler to use.
        Specified by:
        getCompiler in interface Options

      • getCompilerClassName

        public java.lang.String getCompilerClassName()
        Description copied from interface: Options
        The name of class that implements JavaCompiler, used for Java compilations.
        Specified by:
        getCompilerClassName in interface Options
        See Also:
        Options#getCompilerName

      • getErrorOnUseBeanInvalidClassAttribute

        public boolean getErrorOnUseBeanInvalidClassAttribute()
        Description copied from interface: Options
        Returns true if Jasper issues a compilation error instead of a runtime Instantiation error if the class attribute specified in useBean action is invalid.
        Specified by:
        getErrorOnUseBeanInvalidClassAttribute in interface Options

      • setErrorOnUseBeanInvalidClassAttribute

        public void setErrorOnUseBeanInvalidClassAttribute​(boolean b)

      • getTldScanner

        public TldScanner getTldScanner()
        Description copied from interface: Options
        The cache for the location of the TLD's for the various tag libraries 'exposed' by the web application. A tag library is 'exposed' either explicitely in web.xml or implicitely via the uri tag in the TLD of a taglib deployed in a jar file (WEB-INF/lib).
        Specified by:
        getTldScanner in interface Options
        Returns:
        the instance of the TldScanner for the web-application.

      • getJavaEncoding

        public java.lang.String getJavaEncoding()
        Description copied from interface: Options
        Java platform encoding to generate the JSP page servlet.
        Specified by:
        getJavaEncoding in interface Options

      • getFork

        public boolean getFork()
        Description copied from interface: Options
        boolean flag to tell Ant whether to fork JSP page compilations.
        Specified by:
        getFork in interface Options

      • getJspConfig

        public JspConfig getJspConfig()
        Description copied from interface: Options
        Obtain JSP configuration informantion specified in web.xml.
        Specified by:
        getJspConfig in interface Options

      • getInitialCapacity

        public int getInitialCapacity()
        Gets initial capacity of HashMap which maps JSPs to their corresponding servlets.
        Specified by:
        getInitialCapacity in interface Options

      • getUsePrecompiled

        public boolean getUsePrecompiled()
        Returns the value of the usePrecompiled (or use-precompiled) init param.
        Specified by:
        getUsePrecompiled in interface Options

      • parseCheckInterval

        private void parseCheckInterval​(java.lang.String param)

      • parseModificationTestInterval

        private void parseModificationTestInterval​(java.lang.String param)

      • getBoolean

        private boolean getBoolean​(javax.servlet.ServletConfig config,
                           boolean init,
                           java.lang.String param)

      • isJDK6

        private boolean isJDK6()