lucee.runtime

Class PageContext

java.lang.Object

javax.servlet.jsp.PageContext

lucee.runtime.PageContext

public abstract class PageContext
extends javax.servlet.jsp.PageContext

page context for every page object. the PageContext is a jsp page context expanded by CFML functionality. for example you have the method getSession to get jsp combatible session object (HTTPSession) and with sessionScope() you get CFML combatible session object (Struct,Scope).

Field Summary

Fields inherited from class javax.servlet.jsp.PageContext

APPLICATION, APPLICATION_SCOPE, CONFIG, EXCEPTION, OUT, PAGE, PAGE_SCOPE, PAGECONTEXT, REQUEST, REQUEST_SCOPE, RESPONSE, SESSION, SESSION_SCOPE

Constructor Summary

Constructors

Constructor and Description
PageContext()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addPageSource(PageSource ps, boolean alsoInclude) adds a PageSource
abstract Application	applicationScope()
abstract Argument	argumentsScope()
abstract Argument	argumentsScope(boolean bind) return the argument scope
abstract CGI	cgiScope()
abstract void	clear() clear the actuell output buffer
abstract void	clearCatch() clear all catches
abstract void	clearRemoteUser() clear the remote user
abstract Client	clientScope()
abstract Client	clientScopeEL()
abstract void	close() Close the response stream.
abstract Cluster	clusterScope()
abstract Cluster	clusterScope(boolean create) cluster scope
abstract void	compile(PageSource pageSource) compile a CFML Template
abstract void	compile(java.lang.String templatePath) Deprecated. use instead compile(PageSource pageSource)
abstract Cookie	cookieScope()
abstract void	doInclude(PageSource source) Deprecated. use other doInclude methods
abstract void	doInclude(PageSource[] source, boolean runOnce) includes a path from a absolute path
abstract void	doInclude(java.lang.String source) includes a path from a absolute path
abstract void	doInclude(java.lang.String source, boolean runOnce) includes a path from a absolute path
abstract java.lang.Object	evaluate(java.lang.String expression) evaluate given expression
abstract void	execute(java.lang.String relPath, boolean throwException) execute a request n the pageConext
abstract void	executeRest(java.lang.String relPath, boolean throwException)
abstract void	exeLogEnd(int position, java.lang.String id)
abstract void	exeLogStart(int position, java.lang.String id)
abstract void	flush() Flush Content of buffer to the response stream of the Socket.
abstract void	forceWrite(java.lang.String str) Writes a String to the Response Buffer,also when cfoutputonly is true and execution is outside of a cfoutput
abstract Form	formScope()
abstract java.lang.Object	get(java.lang.Object coll, Collection.Key key)
abstract java.lang.Object	get(java.lang.Object coll, Collection.Key key, java.lang.Object defaultValue)
abstract java.lang.Object	get(java.lang.Object coll, java.lang.String key) Deprecated. use instead get(Object, lucee.runtime.type.Collection.Key)
abstract java.lang.Object	get(java.lang.Object coll, java.lang.String key, java.lang.Object defaultValue) Deprecated. use instead get(Object, lucee.runtime.type.Collection.Key, Object)
abstract Component	getActiveComponent()
abstract UDF	getActiveUDF()
abstract ApplicationContext	getApplicationContext()
abstract PageSource	getBasePageSource()
abstract PageException	getCatch()
abstract java.lang.String	getCFID()
abstract CFMLFactory	getCFMLFactory()
abstract java.lang.String	getCFToken()
abstract java.lang.Object	getCollection(java.lang.Object coll, Collection.Key key) same like getProperty but return a collection object (QueryColumn) if return object is a Query
abstract java.lang.Object	getCollection(java.lang.Object coll, Collection.Key key, java.lang.Object defaultValue) same like getProperty but return a collection object (QueryColumn) if return object is a Query
abstract java.lang.Object	getCollection(java.lang.Object coll, java.lang.String key) Deprecated. use instead getCollection(Object, lucee.runtime.type.Collection.Key, Object)
abstract java.lang.Object	getCollection(java.lang.Object coll, java.lang.String key, java.lang.Object defaultValue) Deprecated. use instead getCollection(Object, lucee.runtime.type.Collection.Key, Object)
abstract ConfigWeb	getConfig()
abstract int	getCurrentLevel() returns the current level, how deep is the page stack
abstract PageSource	getCurrentPageSource()
abstract javax.servlet.jsp.tagext.Tag	getCurrentTag() returns the tag that is in use
abstract PageSource	getCurrentTemplatePageSource()
abstract DataSourceManager	getDataSourceManager()
abstract Debugger	getDebugger() return debugger of the page Context
abstract int	getExecutionTime()
abstract FTPPool	getFTPPool()
abstract java.lang.Object	getFunction(java.lang.Object coll, Collection.Key key, java.lang.Object[] args) call a UDF Function and return "return value" of the function
abstract java.lang.Object	getFunction(java.lang.Object coll, java.lang.String key, java.lang.Object[] args) call a UDF Function and return "return value" of the function
abstract java.lang.Object	getFunctionWithNamedValues(java.lang.Object coll, Collection.Key key, java.lang.Object[] args) call a UDF Function and return "return value" of the function
abstract java.lang.Object	getFunctionWithNamedValues(java.lang.Object coll, java.lang.String key, java.lang.Object[] args) call a UDF Function and return "return value" of the function
abstract javax.servlet.http.HttpServletRequest	getHttpServletRequest() return HttpServletRequest, getRequest only returns ServletRequest
abstract javax.servlet.http.HttpServletResponse	getHttpServletResponse() return HttpServletResponse, getResponse only returns ServletResponse
abstract int	getId()
abstract Iterator	getIterator(java.lang.String key) get variable from string definition and cast it to a Iterator Object
abstract java.lang.String	getJSessionId()
abstract java.util.Locale	getLocale()
abstract PageContext	getParentPageContext()
abstract boolean	getPsq() returns if single quotes will be preserved inside a query tag (psq=preserve single quote)
abstract Query	getQuery(java.lang.Object value)
abstract Query	getQuery(java.lang.String key) get variable from string definition and cast it to a Query Object
abstract QueryCache	getQueryCache()
abstract Reference	getReference(java.lang.Object coll, Collection.Key key)
abstract Reference	getReference(java.lang.Object coll, java.lang.String key) Deprecated. use instead getReference(Object, lucee.runtime.type.Collection.Key)
abstract Credential	getRemoteUser()
abstract long	getRequestTimeout()
abstract java.io.OutputStream	getResponseStream()
abstract Resource	getRootTemplateDirectory()
abstract javax.servlet.jsp.JspWriter	getRootWriter()
abstract short	getSessionType()
abstract long	getStartTime()
abstract Array	getTemplatePath() array of current template stack
abstract java.lang.Thread	getThread()
abstract Threads	getThreadScope(Collection.Key name)
abstract Threads	getThreadScope(java.lang.String name) Deprecated. use instead setThreadScope(Collection.Key name,Threads t)
abstract java.lang.String[]	getThreadScopeNames()
abstract java.util.TimeZone	getTimeZone()
abstract java.lang.String	getURLToken()
abstract java.lang.Object	getVariable(java.lang.String var)
abstract VariableUtil	getVariableUtil()
abstract void	handlePageException(PageException pe) specialised method for handlePageException with argument Exception or Throwable
abstract boolean	hasFamily()
abstract void	initBody(javax.servlet.jsp.tagext.BodyTag bodyTag, int state) init body of a tag
abstract boolean	isCFCRequest()
abstract Component	loadComponent(java.lang.String compPath)
abstract java.lang.Object	localGet()
abstract java.lang.Object	localGet(boolean bind)
abstract Local	localScope()
abstract Local	localScope(boolean bind)
abstract java.lang.Object	localTouch()
abstract java.lang.Object	localTouch(boolean bind)
abstract void	outputEnd() ends a cfoutput block
abstract void	outputStart() starts a cfoutput block
abstract void	param(java.lang.String type, java.lang.String name, java.lang.Object defaultValue)
abstract void	param(java.lang.String type, java.lang.String name, java.lang.Object defaultValue, double min, double max)
abstract void	param(java.lang.String type, java.lang.String name, java.lang.Object defaultValue, int maxLength)
abstract void	param(java.lang.String type, java.lang.String name, java.lang.Object defaultValue, java.lang.String pattern)
abstract void	releaseBody(javax.servlet.jsp.tagext.BodyTag bodyTag, int state) release body of a tag
abstract void	removeLastPageSource(boolean alsoInclude) remove the last PageSource
abstract java.lang.Object	removeVariable(java.lang.String var)
abstract Request	requestScope()
abstract void	reuse(javax.servlet.jsp.tagext.Tag tag) puts a tag back to pool
abstract Scope	scope(int type) returns matching scope
abstract java.lang.String	serialize(java.lang.Object expression)
abstract Server	serverScope()
abstract Session	sessionScope()
abstract java.lang.Object	set(java.lang.Object coll, Collection.Key key, java.lang.Object value) set property at a collection object
abstract java.lang.Object	set(java.lang.Object coll, java.lang.String key, java.lang.Object value) Deprecated. use instead set(Object, lucee.runtime.type.Collection.Key, Object)
abstract void	setApplicationContext(ApplicationContext applicationContext)
abstract void	setCatch(PageException pe)
abstract void	setCatch(PageException pe, boolean caught, boolean store)
abstract PageException	setCatch(java.lang.Throwable t) sets a excption
abstract void	setCFOutputOnly(boolean boolEnablecfoutputonly) sets state of cfoutput only
abstract void	setCFOutputOnly(short enablecfoutputonly) sets state of cfoutput only
abstract void	setErrorPage(ErrorPage ep) sets the error page
abstract void	setExecutionTime(int executionTime)
abstract void	setFunctionScopes(Local local, Argument argument)
abstract void	setHeader(java.lang.String name, java.lang.String value) write a value to the header of the response
abstract void	setLocale(java.util.Locale locale)
abstract void	setLocale(java.lang.String strLocale) Deprecated. use instead setLocale(Locale)
abstract void	setPsq(boolean psq) sets if inside a query tag single quote will be preserved (preserve single quote)
abstract void	setRemoteUser(Credential remoteUser)
abstract void	setRequestTimeout(long requestTimeout)
abstract boolean	setSilent() sets the pagecontext silent
abstract void	setThreadScope(Collection.Key name, Threads t)
abstract void	setThreadScope(java.lang.String name, Threads t) Deprecated. use instead setThreadScope(Collection.Key name,Threads t)
abstract void	setTimeZone(java.util.TimeZone timeZone)
abstract java.lang.Object	setVariable(java.lang.String var, java.lang.Object value) sets a value by string syntax ("scopename.key.key" -> "url.name")
abstract void	setVariablesScope(Variables scope) set a other variable scope
abstract void	throwCatch() return throwed exception
abstract PageSource	toPageSource(Resource res, PageSource defaultValue)
abstract java.lang.Object	touch(java.lang.Object coll, Collection.Key key) touch a new property, if property doesn't existset a Struct, otherwise do nothing
abstract java.lang.Object	touch(java.lang.Object coll, java.lang.String key) Deprecated. use instead touch(Object, lucee.runtime.type.Collection.Key)
abstract Undefined	undefinedScope()
abstract boolean	unsetSilent() unsets the pagecontext silent
abstract URLForm	urlFormScope()
abstract URL	urlScope()
abstract Undefined	us()
abstract javax.servlet.jsp.tagext.Tag	use(java.lang.Class tagClass) Deprecated. use instead use(String tagClassName)
abstract javax.servlet.jsp.tagext.Tag	use(java.lang.String tagClassName) returns a tag from tag handler pool
abstract Variables	variablesScope()
abstract void	write(java.lang.String str) Writes a String to the Response Buffer
abstract void	writePSQ(java.lang.Object o) Writes a String to the Response Buffer,also when cfoutputonly is true and execution is outside of a cfoutput

Methods inherited from class javax.servlet.jsp.PageContext

findAttribute, forward, getAttribute, getAttribute, getAttributeNamesInScope, getAttributesScope, getException, getOut, getPage, getRequest, getResponse, getServletConfig, getServletContext, getSession, handlePageException, handlePageException, include, initialize, popBody, pushBody, release, removeAttribute, removeAttribute, setAttribute, setAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

PageContext

public PageContext()

Method Detail

scope

public abstract Scope scope(int type)
                     throws PageException

returns matching scope

Parameters:

type - type of scope (Scope.xx)

Returns:

scope matching to defined scope definition

Throws:

PageException

undefinedScope

public abstract Undefined undefinedScope()

Returns:

undefined scope, undefined scope is a placeholder for the scopecascading

variablesScope

public abstract Variables variablesScope()

Returns:

variables scope

urlScope

public abstract URL urlScope()

Returns:

url scope

formScope

public abstract Form formScope()

Returns:

form scope

urlFormScope

public abstract URLForm urlFormScope()

Returns:

scope mixed url and scope

requestScope

public abstract Request requestScope()

Returns:

request scope

cgiScope

public abstract CGI cgiScope()

Returns:

request scope

applicationScope

public abstract Application applicationScope()
                                      throws PageException

Returns:

application scope

Throws:

PageException

argumentsScope

public abstract Argument argumentsScope()

Returns:

arguments scope

argumentsScope

public abstract Argument argumentsScope(boolean bind)

return the argument scope

Parameters:

bind - indicate that the Argument Scope is binded for using outsite of the udf

Returns:

Argument Scope

localScope

public abstract Local localScope()

Returns:

arguments scope

localScope

public abstract Local localScope(boolean bind)

localGet

public abstract java.lang.Object localGet()
                                   throws PageException

Throws:

PageException

localGet

public abstract java.lang.Object localGet(boolean bind)
                                   throws PageException

Throws:

PageException

localTouch

public abstract java.lang.Object localTouch()
                                     throws PageException

Throws:

PageException

localTouch

public abstract java.lang.Object localTouch(boolean bind)
                                     throws PageException

Throws:

PageException

sessionScope

public abstract Session sessionScope()
                              throws PageException

Returns:

session scope

Throws:

PageException

setFunctionScopes

public abstract void setFunctionScopes(Local local,
                     Argument argument)

serverScope

public abstract Server serverScope()
                            throws PageException

Returns:

server scope

Throws:

PageException

cookieScope

public abstract Cookie cookieScope()

Returns:

cookie scope

clientScope

public abstract Client clientScope()
                            throws PageException

Returns:

cookie scope

Throws:

PageException

clientScopeEL

public abstract Client clientScopeEL()

clusterScope

public abstract Cluster clusterScope()
                              throws PageException

Returns:

cluster scope

Throws:

PageException

clusterScope

public abstract Cluster clusterScope(boolean create)
                              throws PageException

cluster scope

Parameters:

create - return null when false and scope does not exist

Returns:

cluster scope or null

Throws:

PageException

set

public abstract java.lang.Object set(java.lang.Object coll,
                   java.lang.String key,
                   java.lang.Object value)
                              throws PageException

Deprecated. use instead set(Object, lucee.runtime.type.Collection.Key, Object)

set property at a collection object

Parameters:

coll - Collection Object (Collection, HashMap aso.)

key - key of the new value

value - new Value

Returns:

value setted

Throws:

PageException

set

public abstract java.lang.Object set(java.lang.Object coll,
                   Collection.Key key,
                   java.lang.Object value)
                              throws PageException

set property at a collection object

Parameters:

coll - Collection Object (Collection, HashMap aso.)

key - key of the new value

value - new Value

Returns:

value setted

Throws:

PageException

touch

public abstract java.lang.Object touch(java.lang.Object coll,
                     java.lang.String key)
                                throws PageException

Deprecated. use instead touch(Object, lucee.runtime.type.Collection.Key)

touch a new property, if property doesn't existset a Struct, otherwise do nothing

Parameters:

coll - Collection Object

key - key to touch

Returns:

Property

Throws:

PageException

touch

public abstract java.lang.Object touch(java.lang.Object coll,
                     Collection.Key key)
                                throws PageException

touch a new property, if property doesn't existset a Struct, otherwise do nothing

Parameters:

coll - Collection Object

key - key to touch

Returns:

Property

Throws:

PageException

getCollection

public abstract java.lang.Object getCollection(java.lang.Object coll,
                             java.lang.String key)
                                        throws PageException

Deprecated. use instead getCollection(Object, lucee.runtime.type.Collection.Key, Object)

same like getProperty but return a collection object (QueryColumn) if return object is a Query

Parameters:

coll - Collection Object

key - key to touch

Returns:

Property or QueryColumn

Throws:

PageException

getCollection

public abstract java.lang.Object getCollection(java.lang.Object coll,
                             Collection.Key key)
                                        throws PageException

same like getProperty but return a collection object (QueryColumn) if return object is a Query

Parameters:

coll - Collection Object

key - key to touch

Returns:

Property or QueryColumn

Throws:

PageException

getCollection

public abstract java.lang.Object getCollection(java.lang.Object coll,
                             java.lang.String key,
                             java.lang.Object defaultValue)

Deprecated. use instead getCollection(Object, lucee.runtime.type.Collection.Key, Object)

same like getProperty but return a collection object (QueryColumn) if return object is a Query

Parameters:

coll - Collection Object

key - key to touch

Returns:

Property or QueryColumn

getCollection

public abstract java.lang.Object getCollection(java.lang.Object coll,
                             Collection.Key key,
                             java.lang.Object defaultValue)

same like getProperty but return a collection object (QueryColumn) if return object is a Query

Parameters:

coll - Collection Object

key - key to touch

Returns:

Property or QueryColumn

get

public abstract java.lang.Object get(java.lang.Object coll,
                   java.lang.String key)
                              throws PageException

Deprecated. use instead get(Object, lucee.runtime.type.Collection.Key)

Parameters:

coll - Collection to get value

key - key of the value

Returns:

return value of a Collection, throws Exception if value doesn't exist

Throws:

PageException

get

public abstract java.lang.Object get(java.lang.Object coll,
                   Collection.Key key)
                              throws PageException

Parameters:

coll - Collection to get value

key - key of the value

Returns:

return value of a Collection, throws Exception if value doesn't exist

Throws:

PageException

getReference

public abstract Reference getReference(java.lang.Object coll,
                     java.lang.String key)
                                throws PageException

Deprecated. use instead getReference(Object, lucee.runtime.type.Collection.Key)

Parameters:

coll - Collection to get value

key - key of the value

Returns:

return value of a Collection, throws Exception if value doesn't exist

Throws:

PageException

getReference

public abstract Reference getReference(java.lang.Object coll,
                     Collection.Key key)
                                throws PageException

Parameters:

coll - Collection to get value

key - key of the value

Returns:

return value of a Collection, throws Exception if value doesn't exist

Throws:

PageException

get

public abstract java.lang.Object get(java.lang.Object coll,
                   java.lang.String key,
                   java.lang.Object defaultValue)

Deprecated. use instead get(Object, lucee.runtime.type.Collection.Key, Object)

Parameters:

coll - Collection to get value

key - key of the value

Returns:

return value of a Collection, return null if value not exist

get

public abstract java.lang.Object get(java.lang.Object coll,
                   Collection.Key key,
                   java.lang.Object defaultValue)

Parameters:

coll - Collection to get value

key - key of the value

Returns:

return value of a Collection, return null if value not exist

setVariable

public abstract java.lang.Object setVariable(java.lang.String var,
                           java.lang.Object value)
                                      throws PageException

sets a value by string syntax ("scopename.key.key" -> "url.name")

Parameters:

var - Variable String name to set

value - value to set

Returns:

setted value

Throws:

PageException

getVariable

public abstract java.lang.Object getVariable(java.lang.String var)
                                      throws PageException

Parameters:

var - variable name to get

Returns:

return a value by string syntax ("scopename.key.key" -> "url.name")

Throws:

PageException

evaluate

public abstract java.lang.Object evaluate(java.lang.String expression)
                                   throws PageException

evaluate given expression

Parameters:

expression - expression to evaluate

Returns:

return value generated by expression or null

Throws:

PageException

serialize

public abstract java.lang.String serialize(java.lang.Object expression)
                                    throws PageException

Throws:

PageException

removeVariable

public abstract java.lang.Object removeVariable(java.lang.String var)
                                         throws PageException

Parameters:

var - variable name to get

Returns:

return a value by string syntax ("scopename.key.key" -> "url.name")

Throws:

PageException

getQuery

public abstract Query getQuery(java.lang.String key)
                        throws PageException

get variable from string definition and cast it to a Query Object

Parameters:

key - Variable Name to get

Returns:

Query

Throws:

PageException

getQuery

public abstract Query getQuery(java.lang.Object value)
                        throws PageException

Throws:

PageException

setHeader

public abstract void setHeader(java.lang.String name,
             java.lang.String value)

write a value to the header of the response

Parameters:

name - name of the value to set

value - value to set

getCFID

public abstract java.lang.String getCFID()

Returns:

returns the cfid of the actuell user

getCFToken

public abstract java.lang.String getCFToken()

Returns:

returns the actuell cftoken of the user

getJSessionId

public abstract java.lang.String getJSessionId()

Returns:

return the session id

getURLToken

public abstract java.lang.String getURLToken()

Returns:

returns the urltoken of the actuell user

getId

public abstract int getId()

Returns:

returns the page context id

getRootWriter

public abstract javax.servlet.jsp.JspWriter getRootWriter()

getLocale

public abstract java.util.Locale getLocale()

Returns:

Returns the locale.

setLocale

public abstract void setLocale(java.util.Locale locale)

Parameters:

strLocale - The locale to set as String.

setLocale

public abstract void setLocale(java.lang.String strLocale)
                        throws PageException

Deprecated. use instead setLocale(Locale)

Parameters:

strLocale - The locale to set as String.

Throws:

PageException

getConfig

public abstract ConfigWeb getConfig()

Returns:

Returns the Config Object of the PageContext.

getHttpServletRequest

public abstract javax.servlet.http.HttpServletRequest getHttpServletRequest()

return HttpServletRequest, getRequest only returns ServletRequest

Returns:

HttpServletRequest

getHttpServletResponse

public abstract javax.servlet.http.HttpServletResponse getHttpServletResponse()

return HttpServletResponse, getResponse only returns ServletResponse

Returns:

HttpServletResponse

getResponseStream

public abstract java.io.OutputStream getResponseStream()
                                                throws java.io.IOException

Throws:

java.io.IOException

getCurrentTag

public abstract javax.servlet.jsp.tagext.Tag getCurrentTag()

returns the tag that is in use

Returns:

Returns the currentTag.

getApplicationContext

public abstract ApplicationContext getApplicationContext()

Returns:

Returns the applicationContext.

write

public abstract void write(java.lang.String str)
                    throws java.io.IOException

Writes a String to the Response Buffer

Parameters:

str -

Throws:

java.io.IOException

forceWrite

public abstract void forceWrite(java.lang.String str)
                         throws java.io.IOException

Writes a String to the Response Buffer,also when cfoutputonly is true and execution is outside of a cfoutput

Parameters:

str -

Throws:

java.io.IOException

writePSQ

public abstract void writePSQ(java.lang.Object o)
                       throws java.io.IOException,
                              PageException

Writes a String to the Response Buffer,also when cfoutputonly is true and execution is outside of a cfoutput

Parameters:

o -

Throws:

java.io.IOException

PageException

getCurrentPageSource

public abstract PageSource getCurrentPageSource()

Returns:

the current template PageSource

getCurrentTemplatePageSource

public abstract PageSource getCurrentTemplatePageSource()

Returns:

the current template PageSource

getBasePageSource

public abstract PageSource getBasePageSource()

Returns:

base template file

setSilent

public abstract boolean setSilent()

sets the pagecontext silent

Returns:

return setting that was before

unsetSilent

public abstract boolean unsetSilent()

unsets the pagecontext silent

Returns:

return setting that was before

getDebugger

public abstract Debugger getDebugger()

return debugger of the page Context

Returns:

debugger

getExecutionTime

public abstract int getExecutionTime()

Returns:

Returns the executionTime.

setExecutionTime

public abstract void setExecutionTime(int executionTime)

Parameters:

executionTime - The executionTime to set.

getRemoteUser

public abstract Credential getRemoteUser()
                                  throws PageException

Returns:

Returns the remoteUser.

Throws:

PageException

clearRemoteUser

public abstract void clearRemoteUser()

clear the remote user

setRemoteUser

public abstract void setRemoteUser(Credential remoteUser)

Parameters:

remoteUser - The remoteUser to set.

getTemplatePath

public abstract Array getTemplatePath()
                               throws PageException

array of current template stack

Returns:

array

Throws:

PageException

getCurrentLevel

public abstract int getCurrentLevel()

returns the current level, how deep is the page stack

Returns:

level

getVariableUtil

public abstract VariableUtil getVariableUtil()

Returns:

Returns the variableUtil.

setApplicationContext

public abstract void setApplicationContext(ApplicationContext applicationContext)

Parameters:

applicationContext - The applicationContext to set.

toPageSource

public abstract PageSource toPageSource(Resource res,
                      PageSource defaultValue)

setVariablesScope

public abstract void setVariablesScope(Variables scope)

set a other variable scope

Parameters:

scope -

doInclude

public abstract void doInclude(PageSource source)
                        throws PageException

Deprecated. use other doInclude methods

includes a path from a absolute path

Parameters:

source - absolute path as file object

Throws:

javax.servlet.ServletException

PageException

doInclude

public abstract void doInclude(PageSource[] source,
             boolean runOnce)
                        throws PageException

includes a path from a absolute path

Parameters:

source - absolute path as file object

runOnce - include only once per request

Throws:

javax.servlet.ServletException

PageException

doInclude

public abstract void doInclude(java.lang.String source)
                        throws PageException

includes a path from a absolute path

Parameters:

source - absolute path as file object

Throws:

javax.servlet.ServletException

PageException

doInclude

public abstract void doInclude(java.lang.String source,
             boolean runOnce)
                        throws PageException

includes a path from a absolute path

Parameters:

source - absolute path as file object

runOnce - include only once per request

Throws:

javax.servlet.ServletException

PageException

clear

public abstract void clear()

clear the actuell output buffer

getFTPPool

public abstract FTPPool getFTPPool()

Returns:

returns the ftp pool

getRequestTimeout

public abstract long getRequestTimeout()

Returns:

return the request timeout for this pagecontext in milli seconds

getQueryCache

public abstract QueryCache getQueryCache()

Returns:

returns the query cache

setRequestTimeout

public abstract void setRequestTimeout(long requestTimeout)

Parameters:

requestTimeout - The requestTimeout to set.

setCFOutputOnly

public abstract void setCFOutputOnly(boolean boolEnablecfoutputonly)

sets state of cfoutput only

Parameters:

boolEnablecfoutputonly -

getPsq

public abstract boolean getPsq()

returns if single quotes will be preserved inside a query tag (psq=preserve single quote)

Returns:

preserve single quote

close

public abstract void close()

Close the response stream.

addPageSource

public abstract void addPageSource(PageSource ps,
                 boolean alsoInclude)

adds a PageSource

Parameters:

ps -

alsoInclude -

clearCatch

public abstract void clearCatch()

clear all catches

execute

public abstract void execute(java.lang.String relPath,
           boolean throwException)
                      throws PageException

execute a request n the pageConext

Parameters:

relPath -

Throws:

PageException

java.io.IOException

executeRest

public abstract void executeRest(java.lang.String relPath,
               boolean throwException)
                          throws PageException

Throws:

PageException

flush

public abstract void flush()

Flush Content of buffer to the response stream of the Socket.

getFunction

public abstract java.lang.Object getFunction(java.lang.Object coll,
                           java.lang.String key,
                           java.lang.Object[] args)
                                      throws PageException

call a UDF Function and return "return value" of the function

Parameters:

coll - Collection of the UDF Function

key - name of the function

args - arguments to call the function

Returns:

return value of the function

Throws:

PageException

getFunction

public abstract java.lang.Object getFunction(java.lang.Object coll,
                           Collection.Key key,
                           java.lang.Object[] args)
                                      throws PageException

call a UDF Function and return "return value" of the function

Parameters:

coll - Collection of the UDF Function

key - name of the function

args - arguments to call the function

Returns:

return value of the function

Throws:

PageException

getFunctionWithNamedValues

public abstract java.lang.Object getFunctionWithNamedValues(java.lang.Object coll,
                                          java.lang.String key,
                                          java.lang.Object[] args)
                                                     throws PageException

call a UDF Function and return "return value" of the function

Parameters:

coll - Collection of the UDF Function

key - name of the function

args - arguments to call the function

Returns:

return value of the function

Throws:

PageException

getFunctionWithNamedValues

public abstract java.lang.Object getFunctionWithNamedValues(java.lang.Object coll,
                                          Collection.Key key,
                                          java.lang.Object[] args)
                                                     throws PageException

call a UDF Function and return "return value" of the function

Parameters:

coll - Collection of the UDF Function

key - name of the function

args - arguments to call the function

Returns:

return value of the function

Throws:

PageException

getIterator

public abstract Iterator getIterator(java.lang.String key)
                              throws PageException

get variable from string definition and cast it to a Iterator Object

Parameters:

key - Variable Name to get

Returns:

Iterator

Throws:

PageException

getRootTemplateDirectory

public abstract Resource getRootTemplateDirectory()

Returns:

directory of root template file

getStartTime

public abstract long getStartTime()

Returns:

Returns the startTime.

getThread

public abstract java.lang.Thread getThread()

Returns:

Returns the thread.

handlePageException

public abstract void handlePageException(PageException pe)

specialised method for handlePageException with argument Exception or Throwable

Parameters:

pe - Page Exception

outputEnd

public abstract void outputEnd()

ends a cfoutput block

outputStart

public abstract void outputStart()

starts a cfoutput block

removeLastPageSource

public abstract void removeLastPageSource(boolean alsoInclude)

remove the last PageSource

Parameters:

alsoInclude -

reuse

public abstract void reuse(javax.servlet.jsp.tagext.Tag tag)
                    throws PageException

puts a tag back to pool

Parameters:

tag - tags to puts back

Throws:

PageException

setCatch

public abstract PageException setCatch(java.lang.Throwable t)

sets a excption

Parameters:

t -

Returns:

PageExcption

getCatch

public abstract PageException getCatch()

setCatch

public abstract void setCatch(PageException pe)

setCatch

public abstract void setCatch(PageException pe,
            boolean caught,
            boolean store)

exeLogStart

public abstract void exeLogStart(int position,
               java.lang.String id)

exeLogEnd

public abstract void exeLogEnd(int position,
             java.lang.String id)

setCFOutputOnly

public abstract void setCFOutputOnly(short enablecfoutputonly)

sets state of cfoutput only

Parameters:

enablecfoutputonly -

setErrorPage

public abstract void setErrorPage(ErrorPage ep)

sets the error page

Parameters:

ep -

setPsq

public abstract void setPsq(boolean psq)

sets if inside a query tag single quote will be preserved (preserve single quote)

Parameters:

psq - sets preserve single quote for query

throwCatch

public abstract void throwCatch()
                         throws PageException

return throwed exception

Throws:

PageException

use

public abstract javax.servlet.jsp.tagext.Tag use(java.lang.Class tagClass)
                                          throws PageException

Deprecated. use instead use(String tagClassName)

returns a tag from tag handler pool

Parameters:

tagClass - class to load from ta handler pool

Returns:

tag matching class

Throws:

PageException

use

public abstract javax.servlet.jsp.tagext.Tag use(java.lang.String tagClassName)
                                          throws PageException

returns a tag from tag handler pool

Parameters:

tagClassName -

Returns:

matching tag

Throws:

PageException

us

public abstract Undefined us()

Returns:

undefined scope, undefined scope is a placeholder for the scopecascading

compile

public abstract void compile(java.lang.String templatePath)
                      throws PageException

Deprecated. use instead compile(PageSource pageSource)

compile a CFML Template

Parameters:

templatePath -

Throws:

PageException

compile

public abstract void compile(PageSource pageSource)
                      throws PageException

compile a CFML Template

Parameters:

pageSource -

Throws:

PageException

initBody

public abstract void initBody(javax.servlet.jsp.tagext.BodyTag bodyTag,
            int state)
                       throws javax.servlet.jsp.JspException

init body of a tag

Parameters:

bodyTag -

state -

Throws:

javax.servlet.jsp.JspException

releaseBody

public abstract void releaseBody(javax.servlet.jsp.tagext.BodyTag bodyTag,
               int state)

release body of a tag

Parameters:

bodyTag -

state -

param

public abstract void param(java.lang.String type,
         java.lang.String name,
         java.lang.Object defaultValue)
                    throws PageException

Parameters:

type -

name -

defaultValue -

Throws:

PageException

param

public abstract void param(java.lang.String type,
         java.lang.String name,
         java.lang.Object defaultValue,
         int maxLength)
                    throws PageException

Parameters:

type -

name -

defaultValue -

maxLength -

Throws:

PageException

param

public abstract void param(java.lang.String type,
         java.lang.String name,
         java.lang.Object defaultValue,
         java.lang.String pattern)
                    throws PageException

Parameters:

type -

name -

defaultValue -

Throws:

PageException

param

public abstract void param(java.lang.String type,
         java.lang.String name,
         java.lang.Object defaultValue,
         double min,
         double max)
                    throws PageException

Parameters:

type -

name -

defaultValue -

Throws:

PageException

isCFCRequest

public abstract boolean isCFCRequest()

getDataSourceManager

public abstract DataSourceManager getDataSourceManager()

getCFMLFactory

public abstract CFMLFactory getCFMLFactory()

getParentPageContext

public abstract PageContext getParentPageContext()

getThreadScope

public abstract Threads getThreadScope(java.lang.String name)

Deprecated. use instead setThreadScope(Collection.Key name,Threads t)

Parameters:

name -

Returns:

getThreadScope

public abstract Threads getThreadScope(Collection.Key name)

setThreadScope

public abstract void setThreadScope(java.lang.String name,
                  Threads t)

Deprecated. use instead setThreadScope(Collection.Key name,Threads t)

set a thread to the context

Parameters:

name -

t -

setThreadScope

public abstract void setThreadScope(Collection.Key name,
                  Threads t)

getThreadScopeNames

public abstract java.lang.String[] getThreadScopeNames()

Returns:

return a Array with names off all threads running.

hasFamily

public abstract boolean hasFamily()

loadComponent

public abstract Component loadComponent(java.lang.String compPath)
                                 throws PageException

Throws:

PageException

getActiveComponent

public abstract Component getActiveComponent()

Returns:

Returns the active Component.

getActiveUDF

public abstract UDF getActiveUDF()

getTimeZone

public abstract java.util.TimeZone getTimeZone()

setTimeZone

public abstract void setTimeZone(java.util.TimeZone timeZone)

getSessionType

public abstract short getSessionType()