Apache Tomcat 6.0.43

org.apache.jasper
Interface Options

All Known Implementing Classes:
EmbeddedServletOptions, JspC

public interface Options

A class to hold all init parameters specific to the JSP engine.

Author:
Anil K. Vijendran, Hans Bergsten, Pierre Delisle

Method Summary
 boolean genStringAsCharArray()
          Indicates whether text strings are to be generated as char arrays.
 java.util.Map getCache()
          The web-application wide cache for the TagLibraryInfo tag library descriptors, used if isCaching() returns true.
 int getCheckInterval()
          Background compile thread check interval in seconds
 boolean getClassDebugInfo()
          Should we include debug information in compiled class?
 java.lang.String getClassPath()
          What classpath should I use while compiling the servlets generated from JSP files?
 java.lang.String getCompiler()
          Compiler to use.
 java.lang.String getCompilerClassName()
          Jasper Java compiler class to use.
 java.lang.String getCompilerSourceVM()
          The compiler source VM, e.g. 1.3, 1.4, 1.5 or 1.6.
 java.lang.String getCompilerTargetVM()
          The compiler target VM, e.g. 1.1, 1.2, 1.3, 1.4, 1.5 or 1.6.
 boolean getDevelopment()
          Is Jasper being used in development mode?
 boolean getDisplaySourceFragment()
          Should we include a source fragment in exception messages, which could be displayed to the developer ?
 boolean getErrorOnUseBeanInvalidClassAttribute()
          Returns true if Jasper issues a compilation error instead of a runtime Instantiation error if the class attribute specified in useBean action is invalid.
 boolean getFork()
          The boolean flag to tell Ant whether to fork JSP page compilations.
 java.lang.String getIeClassId()
          Gets the class-id value that is sent to Internet Explorer when using <jsp:plugin> tags.
 java.lang.String getJavaEncoding()
          Java platform encoding to generate the JSP page servlet.
 JspConfig getJspConfig()
          Obtain JSP configuration informantion specified in web.xml.
 boolean getKeepGenerated()
          Are we keeping generated code around?
 boolean getMappedFile()
          Are we supporting HTML mapped servlets?
 int getModificationTestInterval()
          Modification test interval.
 boolean getRecompileOnFail()
          Re-compile on failure.
 java.io.File getScratchDir()
          What is my scratch dir?
 boolean getSendErrorToClient()
          Deprecated.  
 TagPluginManager getTagPluginManager()
          Obtain a Tag Plugin Manager
 TldLocationsCache getTldLocationsCache()
          The cache for the location of the TLD's for the various tag libraries 'exposed' by the web application.
 boolean getTrimSpaces()
          Should white spaces between directives or actions be trimmed?
 boolean isCaching()
          Is caching enabled (used for precompilation).
 boolean isPoolingEnabled()
          Returns true if tag handler pooling is enabled, false otherwise.
 boolean isSmapDumped()
          Indicates whether SMAP info for JSR45 debugging should be dumped to a file.
 boolean isSmapSuppressed()
          Is the generation of SMAP info for JSR45 debugging suppressed?
 boolean isXpoweredBy()
          Is generation of X-Powered-By response header enabled/disabled?
 

Method Detail

getErrorOnUseBeanInvalidClassAttribute

boolean getErrorOnUseBeanInvalidClassAttribute()
Returns true if Jasper issues a compilation error instead of a runtime Instantiation error if the class attribute specified in useBean action is invalid.


getKeepGenerated

boolean getKeepGenerated()
Are we keeping generated code around?


isPoolingEnabled

boolean isPoolingEnabled()
Returns true if tag handler pooling is enabled, false otherwise.


getMappedFile

boolean getMappedFile()
Are we supporting HTML mapped servlets?


getSendErrorToClient

@Deprecated
boolean getSendErrorToClient()
Deprecated. 

Should errors be sent to client or thrown into stderr?


getClassDebugInfo

boolean getClassDebugInfo()
Should we include debug information in compiled class?


getCheckInterval

int getCheckInterval()
Background compile thread check interval in seconds


getDevelopment

boolean getDevelopment()
Is Jasper being used in development mode?


getDisplaySourceFragment

boolean getDisplaySourceFragment()
Should we include a source fragment in exception messages, which could be displayed to the developer ?


isSmapSuppressed

boolean isSmapSuppressed()
Is the generation of SMAP info for JSR45 debugging suppressed?


isSmapDumped

boolean isSmapDumped()
Indicates whether SMAP info for JSR45 debugging should be dumped to a file. Ignored if suppressSmap() is true.


getTrimSpaces

boolean getTrimSpaces()
Should white spaces between directives or actions be trimmed?


getIeClassId

java.lang.String getIeClassId()
Gets the class-id value that is sent to Internet Explorer when using <jsp:plugin> tags.

Returns:
Class-id value

getScratchDir

java.io.File getScratchDir()
What is my scratch dir?


getClassPath

java.lang.String getClassPath()
What classpath should I use while compiling the servlets generated from JSP files?


getCompiler

java.lang.String getCompiler()
Compiler to use.

If null (the default), the java compiler from Eclipse JDT project, bundled with Tomcat, will be used. Otherwise, the javac task from Apache Ant will be used to call an external java compiler and the value of this option will be passed to it. See Apache Ant documentation for the possible values.


getCompilerTargetVM

java.lang.String getCompilerTargetVM()
The compiler target VM, e.g. 1.1, 1.2, 1.3, 1.4, 1.5 or 1.6.


getCompilerSourceVM

java.lang.String getCompilerSourceVM()
The compiler source VM, e.g. 1.3, 1.4, 1.5 or 1.6.


getCompilerClassName

java.lang.String getCompilerClassName()
Jasper Java compiler class to use.


getTldLocationsCache

TldLocationsCache getTldLocationsCache()
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).

Returns:
the instance of the TldLocationsCache for the web-application.

getJavaEncoding

java.lang.String getJavaEncoding()
Java platform encoding to generate the JSP page servlet.


getFork

boolean getFork()
The boolean flag to tell Ant whether to fork JSP page compilations.

Is used only when Jasper uses an external java compiler (wrapped through a javac Apache Ant task).


getJspConfig

JspConfig getJspConfig()
Obtain JSP configuration informantion specified in web.xml.


isXpoweredBy

boolean isXpoweredBy()
Is generation of X-Powered-By response header enabled/disabled?


getTagPluginManager

TagPluginManager getTagPluginManager()
Obtain a Tag Plugin Manager


genStringAsCharArray

boolean genStringAsCharArray()
Indicates whether text strings are to be generated as char arrays.

Returns:
true if text strings are to be generated as char arrays, false otherwise

getModificationTestInterval

int getModificationTestInterval()
Modification test interval.


getRecompileOnFail

boolean getRecompileOnFail()
Re-compile on failure.


isCaching

boolean isCaching()
Is caching enabled (used for precompilation).


getCache

java.util.Map getCache()
The web-application wide cache for the TagLibraryInfo tag library descriptors, used if isCaching() returns true.

Using this cache avoids the cost of repeating the parsing of a tag library descriptor XML file (performed by TagLibraryInfoImpl.parseTLD).

Returns:
the Map(String uri, TagLibraryInfo tld) instance.

Apache Tomcat 6.0.43

Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.