lucee.runtime.listener

Interface ApplicationListener

public interface ApplicationListener

interface for PageContext to interact with CFML

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFC_EXTENSION
static int	MODE_CURRENT
static int	MODE_CURRENT_OR_ROOT
static int	MODE_CURRENT2ROOT
static int	MODE_ROOT

Method Summary

Methods

Modifier and Type	Method and Description
int	getMode()
java.lang.String	getType()
boolean	hasOnApplicationStart()
boolean	hasOnSessionStart(PageContext pc)
void	onApplicationEnd(CFMLFactory cfmlFactory, java.lang.String applicationName) this method will be called when a application scope ends
boolean	onApplicationStart(PageContext pc) this method will be called when a new application context starts
void	onDebug(PageContext pc) called after "onRequestEnd" to generate debugging output, will only be called when debugging is enabled
void	onError(PageContext pc, PageException pe) this method will be called if server has a error (exception) not throwed by a try-catch block
void	onRequest(PageContext pc, PageSource requestedPage, RequestListener rl) this method will be called the application self
void	onServerEnd() this method will be called when the server shutdown correctly (no crashes)
void	onServerStart() this method will be called when a server starts
void	onSessionEnd(CFMLFactory cfmlFactory, java.lang.String applicationName, java.lang.String cfid) this method will be called when a session ends
void	onSessionStart(PageContext pc) this method will be called when a new session starts
void	onTimeout(PageContext pc) will be called when server is run int a timeout
void	setMode(int mode)
void	setType(java.lang.String type)

Field Detail

MODE_CURRENT2ROOT

static final int MODE_CURRENT2ROOT

See Also:

Constant Field Values

MODE_CURRENT

static final int MODE_CURRENT

See Also:

Constant Field Values

MODE_ROOT

static final int MODE_ROOT

See Also:

Constant Field Values

MODE_CURRENT_OR_ROOT

static final int MODE_CURRENT_OR_ROOT

See Also:

Constant Field Values

CFC_EXTENSION

static final java.lang.String CFC_EXTENSION

See Also:

Constant Field Values

Method Detail

setMode

void setMode(int mode)

getMode

int getMode()

getType

java.lang.String getType()

Returns:

the type

setType

void setType(java.lang.String type)

Parameters:

type - the type to set

onRequest

void onRequest(PageContext pc,
             PageSource requestedPage,
             RequestListener rl)
               throws PageException

this method will be called the application self

Parameters:

pc -

requestedPage -

Throws:

PageException

javax.servlet.ServletException

onSessionStart

void onSessionStart(PageContext pc)
                    throws PageException

this method will be called when a new session starts

Throws:

PageException

onSessionEnd

void onSessionEnd(CFMLFactory cfmlFactory,
                java.lang.String applicationName,
                java.lang.String cfid)
                  throws PageException

this method will be called when a session ends

Parameters:

cfmlFactory -

applicationName -

cfid -

Throws:

PageException

onApplicationStart

boolean onApplicationStart(PageContext pc)
                           throws PageException

this method will be called when a new application context starts

Throws:

PageException

onApplicationEnd

void onApplicationEnd(CFMLFactory cfmlFactory,
                    java.lang.String applicationName)
                      throws PageException

this method will be called when a application scope ends

Throws:

PageException

onServerStart

void onServerStart()
                   throws PageException

this method will be called when a server starts

Throws:

PageException

onServerEnd

void onServerEnd()
                 throws PageException

this method will be called when the server shutdown correctly (no crashes)

Throws:

PageException

onError

void onError(PageContext pc,
           PageException pe)

this method will be called if server has a error (exception) not throwed by a try-catch block

Parameters:

pe - PageExcpetion Exception that has been throwed

onDebug

void onDebug(PageContext pc)
             throws PageException

called after "onRequestEnd" to generate debugging output, will only be called when debugging is enabled

Throws:

PageException

onTimeout

void onTimeout(PageContext pc)

will be called when server is run int a timeout

hasOnApplicationStart

boolean hasOnApplicationStart()

hasOnSessionStart

boolean hasOnSessionStart(PageContext pc)