org.apache.jasper
Class EmbeddedServletOptions

java.lang.Object
  extended by org.apache.jasper.EmbeddedServletOptions
All Implemented Interfaces:
Options

public final class EmbeddedServletOptions
extends Object
implements Options

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

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

Field Summary
 boolean fork
          Should Ant fork its java compiles of JSP pages.
 
Constructor Summary
EmbeddedServletOptions(ServletConfig config, ServletContext context)
          Create an EmbeddedServletOptions object using data available from ServletConfig and ServletContext.
 
Method Summary
 boolean genStringAsByteArray()
          Are text strings to be generated as byte arrays, if the page is unbuffered?
 boolean genStringAsCharArray()
          Are Text strings to be generated as char arrays?
 int getCheckInterval()
          Background JSP compile thread check intervall
 boolean getClassDebugInfo()
          Should class files be compiled with debug information?
 String getClassPath()
          What classpath should I use while compiling the servlets generated from JSP files?
 String getCompiler()
          Compiler to use.
 String getCompilerSourceVM()
          Compiler source VM, e.g.
 String getCompilerTargetVM()
          The compiler target VM, e.g.
 boolean getDevelopment()
          Is Jasper being used in development mode?
 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()
          boolean flag to tell Ant whether to fork JSP page compilations.
 String getIeClassId()
          Class ID for use in the plugin tag when the browser is IE.
 int getInitialCapacity()
          Gets initial capacity of HashMap which maps JSPs to their corresponding servlets.
 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.
 String getProperty(String name)
           
 boolean getSaveBytecode()
          If class files are generated as byte arrays, should they be saved to disk at the end of compilations?
 File getScratchDir()
          What is my scratch dir?
 boolean getSendErrorToClient()
          Should errors be sent to client or thrown into stderr?
 String getSystemClassPath()
          Gets the system class path.
 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 getUsePrecompiled()
          Returns the value of the usePrecompiled (or use-precompiled) init param.
 boolean isDefaultBufferNone()
          If the buffer attribute for the page directive is not specified, is the default "none"?
 boolean isPoolingEnabled()
          Returns true if tag handler pooling is enabled, false otherwise.
 boolean isSmapDumped()
          Should SMAP info for JSR45 debugging be dumped to a file?
 boolean isSmapSuppressed()
          Is the generation of SMAP info for JSR45 debuggin suppressed?
 boolean isValidationEnabled()
           
 boolean isXpoweredBy()
          Is generation of X-Powered-By response header enabled/disabled?
 void setErrorOnUseBeanInvalidClassAttribute(boolean b)
           
 void setProperty(String name, String value)
           
 void setTldLocationsCache(TldLocationsCache tldC)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fork

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

Constructor Detail

EmbeddedServletOptions

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

Method Detail

getProperty

public String getProperty(String name)

setProperty

public void setProperty(String name,
                        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

getModificationTestInterval

public int getModificationTestInterval()
Modification test interval.

Specified by:
getModificationTestInterval 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 String getIeClassId()
Class ID for use in the plugin tag when the browser is IE.

Specified by:
getIeClassId in interface Options

getScratchDir

public File getScratchDir()
What is my scratch dir?

Specified by:
getScratchDir in interface Options

getClassPath

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

Specified by:
getClassPath in interface Options

getSystemClassPath

public 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 String getCompiler()
Compiler to use.

Specified by:
getCompiler in interface Options

getCompilerTargetVM

public String getCompilerTargetVM()
Description copied from interface: Options
The compiler target VM, e.g. 1.1, 1.2, 1.3, 1.4, or 1.5.

Specified by:
getCompilerTargetVM in interface Options
See Also:
Options.getCompilerTargetVM()

getCompilerSourceVM

public String getCompilerSourceVM()
Description copied from interface: Options
Compiler source VM, e.g. 1.3, 1.4, or 1.5.

Specified by:
getCompilerSourceVM in interface Options
See Also:
Options.getCompilerSourceVM()

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)

getTldLocationsCache

public TldLocationsCache getTldLocationsCache()
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:
getTldLocationsCache in interface Options
Returns:
the instance of the TldLocationsCache for the web-application.

setTldLocationsCache

public void setTldLocationsCache(TldLocationsCache tldC)

getJavaEncoding

public 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

getTagPluginManager

public TagPluginManager getTagPluginManager()
Description copied from interface: Options
Obtain a Tag Plugin Manager

Specified by:
getTagPluginManager 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

isValidationEnabled

public boolean isValidationEnabled()
Specified by:
isValidationEnabled in interface Options


Copyright © 2008 Mort Bay Consulting. All Rights Reserved.