org.apache.sling.scripting.jsp.jasper

Class EmbeddedServletOptions

java.lang.Object

org.apache.sling.scripting.jsp.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

Fields

Modifier and Type	Field and Description
boolean	fork Should Ant fork its java compiles of JSP pages.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	genStringAsCharArray() Are Text strings to be generated as char arrays?
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	getCompilerClassName() Java compiler class to use.
String	getCompilerSourceVM() Compiler source VM, e.g. 1.3, 1.4, or 1.5.
String	getCompilerTargetVM() The compiler target VM, e.g. 1.1, 1.2, 1.3, 1.4, or 1.5.
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() 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.
String	getJavaEncoding() Java platform encoding to generate the JSP page servlet.
ClassLoader	getJspClassLoader() Return null to force use of the JasperLoader.
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?
String	getProperty(String name)
String	getScratchDir() What is my scratch dir?
boolean	getSendErrorToClient() Should errors be sent to client or thrown into stderr?
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	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	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(javax.servlet.ServletConfig config,
                      javax.servlet.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

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

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

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 String 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?

getJspClassLoader

public ClassLoader getJspClassLoader()

Return null to force use of the JasperLoader.

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()

getCompilerClassName

public String getCompilerClassName()

Java compiler class to use.

Specified by:

getCompilerClassName in interface Options

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

getDisplaySourceFragment

public boolean getDisplaySourceFragment()

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

Specified by:

getDisplaySourceFragment in interface Options