Package lucee.loader.engine

Class CFMLEngineWrapper

java.lang.Object

lucee.loader.engine.CFMLEngineWrapper

All Implemented Interfaces:

CFMLEngine

public class CFMLEngineWrapper
extends java.lang.Object
implements CFMLEngine

wrapper for a CFMlEngine

Field Summary

Fields inherited from interface lucee.loader.engine.CFMLEngine

CAN_RESTART, CAN_RESTART_ALL, CAN_RESTART_CONTEXT, CAN_UPDATE, DIALECT_BOTH, DIALECT_CFML, DIALECT_LUCEE

Constructor Summary

Constructors

Constructor	Description
CFMLEngineWrapper(CFMLEngine engine)	constructor of the class

Method Summary

Modifier and Type	Method	Description
void	addServletConfig(javax.servlet.ServletConfig config)
boolean	can(int type, Password password)	checks if process has the right to do was given with type, the engine with given password
void	cli(java.util.Map<java.lang.String,java.lang.String> config, javax.servlet.ServletConfig servletConfig)
ConfigWeb	createConfig(java.io.File contextRoot, java.lang.String host, java.lang.String scriptName)
PageContext	createPageContext(java.io.File contextRoot, java.lang.String host, java.lang.String scriptName, java.lang.String queryString, javax.servlet.http.Cookie[] cookies, java.util.Map<java.lang.String,java.lang.Object> headers, java.util.Map<java.lang.String,java.lang.String> parameters, java.util.Map<java.lang.String,java.lang.Object> attributes, java.io.OutputStream os, long timeout, boolean register)	create and register a PageContext, use releasePageContext when done
boolean	equalTo(CFMLEngine other, boolean checkReferenceEqualityOnly)	this interface is new to this class and not officially part of Lucee 3.x, do not use outside the loader
BundleCollection	getBundleCollection()
org.osgi.framework.BundleContext	getBundleContext()
Cast	getCastUtil()	return the cast util
CFMLEngineFactory	getCFMLEngineFactory()
CFMLFactory	getCFMLFactory(javax.servlet.ServletConfig srvConfig, javax.servlet.http.HttpServletRequest req)
ClassUtil	getClassUtil()
ConfigServer	getConfigServer(java.lang.String key, long timeNonce)
ConfigServer	getConfigServer(Password password)
Creation	getCreationUtil()	returns the decision util
DBUtil	getDBUtil()
Decision	getDecisionUtil()	returns the decision util
CFMLEngine	getEngine()
Excepton	getExceptionUtil()	returns the decision util
java.lang.Object	getFDController()	returns the FusionDebug Engine
HTMLUtil	getHTMLUtil()
HTTPUtil	getHTTPUtil()	returns the HTTP Util
Identification	getIdentification()
Info	getInfo()
java.lang.instrument.Instrumentation	getInstrumentation()
IO	getIOUtil()	returns the IO util
java.lang.Object	getJavaProxyUtil()
ListUtil	getListUtil()
Operation	getOperatonUtil()	return the operation util
ORMUtil	getORMUtil()
ResourceUtil	getResourceUtil()	returns the Resource Util
javax.script.ScriptEngineFactory	getScriptEngineFactory(int dialect)
javax.servlet.ServletConfig[]	getServletConfigs()
Strings	getStringUtil()	returns the IO util
SystemUtil	getSystemUtil()
javax.script.ScriptEngineFactory	getTagEngineFactory(int dialect)
TemplateUtil	getTemplateUtil()
Config	getThreadConfig()
PageContext	getThreadPageContext()
java.util.TimeZone	getThreadTimeZone()
java.net.URL	getUpdateLocation()
java.lang.String	getUpdateType()
java.lang.String	getVersion()
VideoUtil	getVideoUtil()
ZipUtil	getZipUtil()
boolean	isIdentical(CFMLEngine engine)
void	registerThreadPageContext(PageContext pc)
void	releasePageContext(PageContext pc, boolean unregister)
void	reset()	reset the engine
void	reset(java.lang.String configId)	reset a specific config
void	service(javax.servlet.http.HttpServlet servlet, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse rsp)
void	serviceAMF(javax.servlet.http.HttpServlet servlet, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse rsp)
void	serviceCFML(javax.servlet.http.HttpServlet servlet, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse rsp)
void	serviceFile(javax.servlet.http.HttpServlet servlet, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse rsp)
void	serviceRest(javax.servlet.http.HttpServlet servlet, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse rsp)
void	setEngine(CFMLEngine engine)
long	uptime()

Methods inherited from class java.lang.Object

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

Constructor Detail

CFMLEngineWrapper

public CFMLEngineWrapper(CFMLEngine engine)

constructor of the class

Parameters:

engine - engine to wrap

Method Detail

addServletConfig

public void addServletConfig(javax.servlet.ServletConfig config)
                      throws javax.servlet.ServletException

Specified by:

addServletConfig in interface CFMLEngine

Throws:

javax.servlet.ServletException

service

public void service(javax.servlet.http.HttpServlet servlet,
                    javax.servlet.http.HttpServletRequest req,
                    javax.servlet.http.HttpServletResponse rsp)
             throws javax.servlet.ServletException,
                    java.io.IOException

Specified by:

service in interface CFMLEngine

Throws:

javax.servlet.ServletException

java.io.IOException

serviceCFML

public void serviceCFML(javax.servlet.http.HttpServlet servlet,
                        javax.servlet.http.HttpServletRequest req,
                        javax.servlet.http.HttpServletResponse rsp)
                 throws javax.servlet.ServletException,
                        java.io.IOException

Specified by:

serviceCFML in interface CFMLEngine

Throws:

javax.servlet.ServletException

java.io.IOException

serviceAMF

public void serviceAMF(javax.servlet.http.HttpServlet servlet,
                       javax.servlet.http.HttpServletRequest req,
                       javax.servlet.http.HttpServletResponse rsp)
                throws javax.servlet.ServletException,
                       java.io.IOException

Specified by:

serviceAMF in interface CFMLEngine

Throws:

javax.servlet.ServletException

java.io.IOException

serviceFile

public void serviceFile(javax.servlet.http.HttpServlet servlet,
                        javax.servlet.http.HttpServletRequest req,
                        javax.servlet.http.HttpServletResponse rsp)
                 throws javax.servlet.ServletException,
                        java.io.IOException

Specified by:

serviceFile in interface CFMLEngine

Throws:

javax.servlet.ServletException

java.io.IOException

serviceRest

public void serviceRest(javax.servlet.http.HttpServlet servlet,
                        javax.servlet.http.HttpServletRequest req,
                        javax.servlet.http.HttpServletResponse rsp)
                 throws javax.servlet.ServletException,
                        java.io.IOException

Specified by:

serviceRest in interface CFMLEngine

Throws:

javax.servlet.ServletException

java.io.IOException

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface CFMLEngine

Returns:

returns the version of the engine in the format [x.x.x.xxx]

getUpdateType

public java.lang.String getUpdateType()

Specified by:

getUpdateType in interface CFMLEngine

Returns:

returns how this engine will be updated (auto, manual)

getUpdateLocation

public java.net.URL getUpdateLocation()

Specified by:

getUpdateLocation in interface CFMLEngine

Returns:

return location URL to get updates for the engines

getIdentification

public Identification getIdentification()

Specified by:

getIdentification in interface CFMLEngine

can

public boolean can(int type,
                   Password password)

Description copied from interface: CFMLEngine

checks if process has the right to do was given with type, the engine with given password

Specified by:

can in interface CFMLEngine

Parameters:

type - restart type (CFMLEngine.CAN_UPDATE, CFMLEngine.CAN_RESTART)

password - password for the env

Returns:

has right

getCFMLEngineFactory

public CFMLEngineFactory getCFMLEngineFactory()

Specified by:

getCFMLEngineFactory in interface CFMLEngine

Returns:

returns the engine that has produced this engine

reset

public void reset()

Description copied from interface: CFMLEngine

reset the engine

Specified by:

reset in interface CFMLEngine

reset

public void reset(java.lang.String configId)

Description copied from interface: CFMLEngine

reset a specific config

Specified by:

reset in interface CFMLEngine

Parameters:

configId - id of the config to reset

setEngine

public void setEngine(CFMLEngine engine)

getEngine

public CFMLEngine getEngine()

isIdentical

public boolean isIdentical(CFMLEngine engine)

getCastUtil

public Cast getCastUtil()

Description copied from interface: CFMLEngine

return the cast util

Specified by:

getCastUtil in interface CFMLEngine

Returns:

operaton util

getOperatonUtil

public Operation getOperatonUtil()

Description copied from interface: CFMLEngine

return the operation util

Specified by:

getOperatonUtil in interface CFMLEngine

Returns:

operaton util

getDecisionUtil

public Decision getDecisionUtil()

Description copied from interface: CFMLEngine

returns the decision util

Specified by:

getDecisionUtil in interface CFMLEngine

Returns:

decision util

getExceptionUtil

public Excepton getExceptionUtil()

Description copied from interface: CFMLEngine

returns the decision util

Specified by:

getExceptionUtil in interface CFMLEngine

Returns:

decision util

getCreationUtil

public Creation getCreationUtil()

Description copied from interface: CFMLEngine

returns the decision util

Specified by:

getCreationUtil in interface CFMLEngine

Returns:

decision util

getJavaProxyUtil

public java.lang.Object getJavaProxyUtil()

Specified by:

getJavaProxyUtil in interface CFMLEngine

getIOUtil

public IO getIOUtil()

Description copied from interface: CFMLEngine

returns the IO util

Specified by:

getIOUtil in interface CFMLEngine

Returns:

decision util

getCFMLFactory

public CFMLFactory getCFMLFactory(javax.servlet.ServletConfig srvConfig,
                                  javax.servlet.http.HttpServletRequest req)
                           throws javax.servlet.ServletException

Specified by:

getCFMLFactory in interface CFMLEngine

Throws:

javax.servlet.ServletException

getFDController

public java.lang.Object getFDController()

Description copied from interface: CFMLEngine

returns the FusionDebug Engine

Specified by:

getFDController in interface CFMLEngine

Returns:

IFDController

getHTTPUtil

public HTTPUtil getHTTPUtil()

Description copied from interface: CFMLEngine

returns the HTTP Util

Specified by:

getHTTPUtil in interface CFMLEngine

Returns:

the HTTP Util

getResourceUtil

public ResourceUtil getResourceUtil()

Description copied from interface: CFMLEngine

returns the Resource Util

Specified by:

getResourceUtil in interface CFMLEngine

Returns:

Blaze DS Util

getThreadPageContext

public PageContext getThreadPageContext()

Specified by:

getThreadPageContext in interface CFMLEngine

Returns:

return existing PageContext for the current PageContext

getThreadConfig

public Config getThreadConfig()

Specified by:

getThreadConfig in interface CFMLEngine

getVideoUtil

public VideoUtil getVideoUtil()

Specified by:

getVideoUtil in interface CFMLEngine

getZipUtil

public ZipUtil getZipUtil()

Specified by:

getZipUtil in interface CFMLEngine

getStringUtil

public Strings getStringUtil()

Description copied from interface: CFMLEngine

returns the IO util

Specified by:

getStringUtil in interface CFMLEngine

Returns:

decision util

equalTo

public boolean equalTo(CFMLEngine other,
                       boolean checkReferenceEqualityOnly)

this interface is new to this class and not officially part of Lucee 3.x, do not use outside the loader

Parameters:

other - engine to compare

checkReferenceEqualityOnly - check reference equality only

Returns:

is equal to given engine

cli

public void cli(java.util.Map<java.lang.String,java.lang.String> config,
                javax.servlet.ServletConfig servletConfig)
         throws java.io.IOException,
                javax.servlet.jsp.JspException,
                javax.servlet.ServletException

Specified by:

cli in interface CFMLEngine

Throws:

java.io.IOException

javax.servlet.jsp.JspException

javax.servlet.ServletException

registerThreadPageContext

public void registerThreadPageContext(PageContext pc)

Specified by:

registerThreadPageContext in interface CFMLEngine

getConfigServer

public ConfigServer getConfigServer(Password password)
                             throws PageException

Specified by:

getConfigServer in interface CFMLEngine

Throws:

PageException

getConfigServer

public ConfigServer getConfigServer(java.lang.String key,
                                    long timeNonce)
                             throws PageException

Specified by:

getConfigServer in interface CFMLEngine

Throws:

PageException

uptime

public long uptime()

Specified by:

uptime in interface CFMLEngine

getInfo

public Info getInfo()

Specified by:

getInfo in interface CFMLEngine

getBundleContext

public org.osgi.framework.BundleContext getBundleContext()

Specified by:

getBundleContext in interface CFMLEngine

getClassUtil

public ClassUtil getClassUtil()

Specified by:

getClassUtil in interface CFMLEngine

getScriptEngineFactory

public javax.script.ScriptEngineFactory getScriptEngineFactory(int dialect)

Specified by:

getScriptEngineFactory in interface CFMLEngine

getTagEngineFactory

public javax.script.ScriptEngineFactory getTagEngineFactory(int dialect)

Specified by:

getTagEngineFactory in interface CFMLEngine

getServletConfigs

public javax.servlet.ServletConfig[] getServletConfigs()

Specified by:

getServletConfigs in interface CFMLEngine

getListUtil

public ListUtil getListUtil()

Specified by:

getListUtil in interface CFMLEngine

getDBUtil

public DBUtil getDBUtil()

Specified by:

getDBUtil in interface CFMLEngine

getORMUtil

public ORMUtil getORMUtil()

Specified by:

getORMUtil in interface CFMLEngine

getTemplateUtil

public TemplateUtil getTemplateUtil()

Specified by:

getTemplateUtil in interface CFMLEngine

createPageContext

public PageContext createPageContext(java.io.File contextRoot,
                                     java.lang.String host,
                                     java.lang.String scriptName,
                                     java.lang.String queryString,
                                     javax.servlet.http.Cookie[] cookies,
                                     java.util.Map<java.lang.String,java.lang.Object> headers,
                                     java.util.Map<java.lang.String,java.lang.String> parameters,
                                     java.util.Map<java.lang.String,java.lang.Object> attributes,
                                     java.io.OutputStream os,
                                     long timeout,
                                     boolean register)
                              throws javax.servlet.ServletException

Description copied from interface: CFMLEngine

create and register a PageContext, use releasePageContext when done

Specified by:

createPageContext in interface CFMLEngine

Parameters:

contextRoot - context root

host - host name

scriptName - script name

queryString - query string

cookies - cookies

headers - header elements

parameters - parameters

attributes - attributes

os - output stream to write response body

timeout - timeout for the thread

register - register to thread or not

Returns:

PageContext Object created

Throws:

javax.servlet.ServletException - in case the PC cannot be created

releasePageContext

public void releasePageContext(PageContext pc,
                               boolean unregister)

Specified by:

releasePageContext in interface CFMLEngine

createConfig

public ConfigWeb createConfig(java.io.File contextRoot,
                              java.lang.String host,
                              java.lang.String scriptName)
                       throws javax.servlet.ServletException

Specified by:

createConfig in interface CFMLEngine

Throws:

javax.servlet.ServletException

getBundleCollection

public BundleCollection getBundleCollection()

Specified by:

getBundleCollection in interface CFMLEngine

getHTMLUtil

public HTMLUtil getHTMLUtil()

Specified by:

getHTMLUtil in interface CFMLEngine

getThreadTimeZone

public java.util.TimeZone getThreadTimeZone()

Specified by:

getThreadTimeZone in interface CFMLEngine

getSystemUtil

public SystemUtil getSystemUtil()

Specified by:

getSystemUtil in interface CFMLEngine

getInstrumentation

public java.lang.instrument.Instrumentation getInstrumentation()

Specified by:

getInstrumentation in interface CFMLEngine