Package lucee.runtime

Interface PageSource

All Superinterfaces:

java.io.Serializable

public interface PageSource
extends java.io.Serializable

extends the source file with class features

Method Summary

Modifier and Type	Method	Description
boolean	executable()	returns true if the page source can be executed, means the source exists or is trusted and loaded
boolean	exists()
int	getAccessCount()
java.lang.String	getClassName()
java.lang.String	getComponentName()
int	getDialect()
java.lang.String	getDisplayPath()
java.lang.String	getFileName()
java.lang.String	getJavaName()
long	getLastAccessTime()
Mapping	getMapping()
Resource	getPhyscalFile()	return file object, based on physical path and realpath
PageSource	getRealPage(java.lang.String realPath)	get an new Pagesource from realpath
java.lang.String	getRealpath()	returns the realpath without the mapping
java.lang.String	getRealpathWithVirtual()	Returns the full name (mapping/realpath).
Resource	getResource()	if the pageSource is based on an archive, Lucee returns the ra:// path if the mapping physical path and archive is invalid or not defined, it is possible this method returns null
Resource	getResourceTranslated(PageContext pc)	if the pageSource is based on an archive, translate the source to a zip:// Resource
java.lang.String[]	getSource()
Page	loadPage(PageContext pc, boolean forceReload)	loads a page
Page	loadPage(PageContext pc, boolean forceReload, Page defaultValue)	loads a page
Page	loadPageThrowTemplateException(PageContext pc, boolean forceReload, Page defaultValue)	loads a page
boolean	physcalExists()
void	setLastAccessTime()	set time last accessed (now)
void	setLastAccessTime(long lastAccess)	sets time last accessed page

Method Detail

loadPage

Page loadPage(PageContext pc,
              boolean forceReload)
       throws PageException

loads a page

Parameters:

pc -

forceReload -

Throws:

PageException - throws an exception when compilation fails or page does not exist

loadPageThrowTemplateException

Page loadPageThrowTemplateException(PageContext pc,
                                    boolean forceReload,
                                    Page defaultValue)
                             throws PageException

loads a page

Parameters:

pc -

forceReload -

defaultValue -

Throws:

PageException - throws an exception when compilation fails

loadPage

Page loadPage(PageContext pc,
              boolean forceReload,
              Page defaultValue)

loads a page

Parameters:

pc -

forceReload -

defaultValue -

getRealpath

java.lang.String getRealpath()

returns the realpath without the mapping

Returns:

Returns the realpath.

getRealpathWithVirtual

java.lang.String getRealpathWithVirtual()

Returns the full name (mapping/realpath).

Returns:

mapping/realpath

getFileName

java.lang.String getFileName()

Returns:

return the file name of the source file (test.cfm)

getResource

Resource getResource()

if the pageSource is based on an archive, Lucee returns the ra:// path if the mapping physical path and archive is invalid or not defined, it is possible this method returns null

Returns:

return the Resource matching this PageSource

getResourceTranslated

Resource getResourceTranslated(PageContext pc)
                        throws PageException

if the pageSource is based on an archive, translate the source to a zip:// Resource

Parameters:

pc - the Page Context Object

Returns:

return the Resource matching this PageSource

Throws:

PageException

getClassName

java.lang.String getClassName()

Returns:

returns the full classname (package and name) matching to filename (Example: my.package.test_cfm)

getJavaName

java.lang.String getJavaName()

getComponentName

java.lang.String getComponentName()

Returns:

returns the a package matching to file (Example: lucee.web)

getMapping

Mapping getMapping()

Returns:

returns mapping where PageSource based on

exists

boolean exists()

Returns:

returns if page source exists or not

physcalExists

boolean physcalExists()

Returns:

returns if the physical part of the source file exists

getSource

java.lang.String[] getSource()
                      throws java.io.IOException

Returns:

return the source of the file as String array

Throws:

java.io.IOException

getRealPage

PageSource getRealPage(java.lang.String realPath)

get an new Pagesource from realpath

Parameters:

realPath -

Returns:

new Pagesource

setLastAccessTime

void setLastAccessTime(long lastAccess)

sets time last accessed page

Parameters:

lastAccess - time ast accessed

getLastAccessTime

long getLastAccessTime()

Returns:

returns time last accessed page

setLastAccessTime

void setLastAccessTime()

set time last accessed (now)

getAccessCount

int getAccessCount()

Returns:

returns how many this page is accessed since server is in use.

getPhyscalFile

Resource getPhyscalFile()

return file object, based on physical path and realpath

Returns:

file Object

getDisplayPath

java.lang.String getDisplayPath()

Returns:

return source path as String

getDialect

int getDialect()

executable

boolean executable()

returns true if the page source can be executed, means the source exists or is trusted and loaded