org.apache.jasper
Class EmbededServletOptions

java.lang.Object
  |
  +--org.apache.jasper.EmbededServletOptions

All Implemented Interfaces:

Options

public final class EmbededServletOptions

extends java.lang.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	classDebugInfo Do we want to include debugging information in the class file?
java.lang.String	classpath What classpath should I use while compiling generated servlets?
java.lang.String	ieClassId Need to have this as is for versions 4 and 5 of IE.
java.lang.String	jspCompilerPath Path of the compiler to use for compiling JSP pages.
java.lang.Class	jspCompilerPlugin Plugin class to use to compile JSP pages.
boolean	keepGenerated Do you want to keep the generated Java files around?
boolean	largeFile Flag support for "large" files.
boolean	mappedFile Flag support for "mapped" files.
java.io.File	scratchDir I want to see my generated servlets.
boolean	sendErrorToClient Flag to display stack traces in the client's browser.

Constructor Summary

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

Method Summary

boolean	getClassDebugInfo() Should class files be compiled with debug information?
java.lang.String	getClassPath() What classpath should I use while compiling the servlets generated from JSP files?
java.lang.String	getIeClassId() Class ID for use in the plugin tag when the browser is IE.
java.lang.String	getJavaEncoding() Java platform encoding to generate the JSP page servlet.
java.lang.String	getJspCompilerPath() Path of the compiler to use for compiling JSP pages.
java.lang.Class	getJspCompilerPlugin() What compiler plugin should I use to compile the servlets generated from JSP files?
boolean	getKeepGenerated() Are we keeping generated code around?
boolean	getLargeFile() Are we supporting large files?
boolean	getMappedFile() Are we supporting HTML mapped servlets?
java.io.File	getScratchDir() What is my scratch dir?
boolean	getSendErrorToClient() Should errors be sent to client or thrown into stderr?
TldLocationsCache	getTldLocationsCache() The cache for the location of the TLD's for the various tag libraries 'exposed' by the web application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

keepGenerated

public boolean keepGenerated

Do you want to keep the generated Java files around?

largeFile

public boolean largeFile

Flag support for "large" files. What this essentially means is that we generated code so that the HTML data in a JSP file is stored separately as opposed to those constant string data being used literally in the generated servlet.

mappedFile

public boolean mappedFile

Flag 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

public boolean sendErrorToClient

Flag to display stack traces 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

public boolean classDebugInfo

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

scratchDir

public java.io.File scratchDir

I want to see my generated servlets. Which directory are they in?

ieClassId

public 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

public java.lang.String classpath

What classpath should I use while compiling generated servlets?

jspCompilerPlugin

public java.lang.Class jspCompilerPlugin

Plugin class to use to compile JSP pages.

jspCompilerPath

public java.lang.String jspCompilerPath

Path of the compiler to use for compiling JSP pages.

Constructor Detail

EmbededServletOptions

public EmbededServletOptions(javax.servlet.ServletConfig config,
                             javax.servlet.ServletContext context)

Create an EmbededServletOptions object using data available from ServletConfig and ServletContext.

Method Detail

getKeepGenerated

public boolean getKeepGenerated()

Are we keeping generated code around?

Specified by:

getKeepGenerated in interface Options

getLargeFile

public boolean getLargeFile()

Are we supporting large files?

Specified by:

getLargeFile 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

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

getJspCompilerPlugin

public java.lang.Class getJspCompilerPlugin()

What compiler plugin should I use to compile the servlets generated from JSP files?

Specified by:

getJspCompilerPlugin in interface Options

getJspCompilerPath

public java.lang.String getJspCompilerPath()

Path of the compiler to use for compiling JSP pages.

Specified by:

getJspCompilerPath in interface Options

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.

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