railo.runtime.config
Interface Config

All Known Subinterfaces:

ConfigServer, ConfigWeb

public interface Config

interface for Config Object

Field Summary

static short	CLIENT_SCOPE_TYPE_COOKIE Field CLIENT_SCOPE_TYPE_COOKIE
static short	CLIENT_SCOPE_TYPE_DB Field CLIENT_SCOPE_TYPE_DB
static short	CLIENT_SCOPE_TYPE_FILE Field CLIENT_SCOPE_TYPE_FILE
static short	RECOMPILE_AFTER_STARTUP Field RECOMPILE_AT_STARTUP
static short	RECOMPILE_ALWAYS Field RECOMPILE_ALWAYS
static short	RECOMPILE_NEVER Field RECOMPILE_NEVER
static short	SCOPE_SMALL Define a small scope cascading
static short	SCOPE_STANDARD Define a standart scope cascading (like other cf versions)
static short	SCOPE_STRICT Define a strict scope cascading
static short	SESSION_TYPE_CFML Field SESSION_TYPE_CFML
static short	SESSION_TYPE_J2EE Field SESSION_TYPE_J2EE

Method Summary

boolean	allowImplicidQueryCall() return if it is allowed to implizid query call, call a query member witot define name of the query.
boolean	allowRealPath()
boolean	debug() return if debug output will be generated
boolean	doCustomTagDeepSearch()
boolean	doLocalCustomTag() define if railo search in local directory for custom tags or not
ApplicationListener	getApplicationListener() return current application listener
LogAndSource	getApplicationLogger()
TimeSpan	getApplicationTimeout()
PageSource	getBaseComponentPageSource()
java.lang.String	getBaseComponentTemplate()
Resource	getCacheDir()
long	getCacheDirSize()
java.lang.String	getCFCExtension()
java.lang.String	getCFMLExtension() return cfml extesnion
CFXTagPool	getCFXTagPool()
java.lang.ClassLoader	getClassLoader()
Resource	getClientScopeDir()
long	getClientScopeDirSize()
short	getClientType()
java.lang.Class	getClusterClass()
short	getCompileType() return the compile type of this context
int	getComponentDataMemberDefaultAccess()
java.lang.String	getComponentDumpTemplate()
Mapping	getComponentMapping()
Resource	getConfigDir()
Resource	getConfigFile()
ConfigServer	getConfigServer(java.lang.String password)
Struct	getConstants()
Mapping[]	getCustomTagMappings() return the mapping to custom tag directory
DataSource	getDataSource(java.lang.String datasource)
DataSource[]	getDataSources() return the all datasources
java.util.Map	getDataSourcesAsMap()
java.lang.String	getDebugTemplate()
DumpWriter	getDefaultDumpWriter() Deprecated. use instead getDefaultDumpWriter(int defaultType)
DumpWriter	getDefaultDumpWriter(int defaultType) returns the default DumpWriter
java.lang.String	getDefaultEncoding()
ResourceProvider	getDefaultResourceProvider()
Resource	getDeployDirectory() return directory, where railo deploy translated cfml classes (java and class files)
DumpWriter	getDumpWriter(java.lang.String key) Deprecated. use instead getDumpWriter(String key,int defaultType)
DumpWriter	getDumpWriter(java.lang.String key, int defaultType) returns the DumpWriter matching key
boolean	getErrorStatusCode()
java.lang.String	getErrorTemplate() Deprecated. replaced with getErrorTemplate(int status)
java.lang.String	getErrorTemplate(int statusCode)
java.io.PrintWriter	getErrWriter()
LogAndSource	getExceptionLogger()
Resource	getExtensionDirectory()
ExtensionProvider[]	getExtensionProviders()
Extension[]	getExtensions()
CFMLFactory	getFactory()
Resource	getFldFile()
java.lang.String	getId()
long	getLoadTime()
java.util.Locale	getLocale()
int	getLocalMode()
java.lang.String	getMailDefaultEncoding()
LogAndSource	getMailLogger()
Server[]	getMailServers()
int	getMailSpoolInterval()
int	getMailTimeout()
Mapping[]	getMappings()
java.io.PrintWriter	getOutWriter()
PageSource	getPageSource(Mapping[] mappings, java.lang.String realPath, boolean onlyTopLevel)
Resource	getPhysical(Mapping[] mappings, java.lang.String realPath, boolean alsoDefaultMapping)
java.lang.String	getProxyPassword() return default proxy setting password
int	getProxyPort() return default proxy setting port (default 80)
java.lang.String	getProxyServer() return default proxy setting server
java.lang.String	getProxyUsername() return default proxy setting username
boolean	getPSQL()
Resource	getRemoteClientDirectory()
LogAndSource	getRemoteClientLog()
RemoteClient[]	getRemoteClients()
Struct	getRemoteClientUsage()
TimeSpan	getRequestTimeout()
LogAndSource	getRequestTimeoutLogger()
Resource	getResource(java.lang.String path)
java.lang.String	getResourceCharset()
ResourceProvider[]	getResourceProviders()
Resource	getRootDirectory()
java.lang.ClassLoader	getRPCClassLoader(boolean reload)
LogAndSource	getScheduleLogger()
Scheduler	getScheduler()
short	getScopeCascadingType() return how railo cascade scopes
int	getScriptProtect()
SearchEngine	getSearchEngine()
SecurityManager	getSecurityManager()
TimeSpan	getSessionTimeout()
short	getSessionType()
SpoolerEngine	getSpoolerEngine()
Resource	getTempDirectory() return the temp directory
java.lang.String	getTemplateCharset()
java.lang.String	getTimeServer()
long	getTimeServerOffset()
java.util.TimeZone	getTimeZone()
Resource	getTldFile()
LogAndSource	getTraceLogger()
boolean	getTriggerComponentDataMember()
java.net.URL	getUpdateLocation()
java.lang.String	getUpdateType()
double	getVersion()
Resource	getVideoDirectory()
java.lang.String	getVideoProviderLocation()
java.lang.String	getWebCharset()
boolean	hasPassword()
boolean	hasServerPassword()
boolean	isClientCookies()
boolean	isClientManagement()
boolean	isDomainCookies()
boolean	isExtensionEnabled()
boolean	isMailSpoolEnable()
boolean	isProxyEnableFor(java.lang.String host) return if proxy is enabled or not
boolean	isSessionManagement()
boolean	isShowVersion()
boolean	isSuppressWhitespace()
boolean	isVideoAgreementAccepted()
boolean	mergeFormAndURL() e merged return if url and form scope will b
boolean	passwordEqual(java.lang.String password)
void	reloadTimeServerOffset() reload the time offset to a time server
void	reset() reset config
boolean	useComponentShadow() define if components has a "shadow" in the component variables scope or not.

Field Detail

SCOPE_STRICT

public static final short SCOPE_STRICT

Define a strict scope cascading

See Also:

Constant Field Values

SCOPE_SMALL

public static final short SCOPE_SMALL

Define a small scope cascading

See Also:

Constant Field Values

SCOPE_STANDARD

public static final short SCOPE_STANDARD

Define a standart scope cascading (like other cf versions)

See Also:

Constant Field Values

CLIENT_SCOPE_TYPE_COOKIE

public static final short CLIENT_SCOPE_TYPE_COOKIE

Field CLIENT_SCOPE_TYPE_COOKIE

See Also:

Constant Field Values

CLIENT_SCOPE_TYPE_FILE

public static final short CLIENT_SCOPE_TYPE_FILE

Field CLIENT_SCOPE_TYPE_FILE

See Also:

Constant Field Values

CLIENT_SCOPE_TYPE_DB

public static final short CLIENT_SCOPE_TYPE_DB

Field CLIENT_SCOPE_TYPE_DB

See Also:

Constant Field Values

SESSION_TYPE_CFML

public static final short SESSION_TYPE_CFML

Field SESSION_TYPE_CFML

See Also:

Constant Field Values

SESSION_TYPE_J2EE

public static final short SESSION_TYPE_J2EE

Field SESSION_TYPE_J2EE

See Also:

Constant Field Values

RECOMPILE_NEVER

public static final short RECOMPILE_NEVER

Field RECOMPILE_NEVER

See Also:

Constant Field Values

RECOMPILE_AFTER_STARTUP

public static final short RECOMPILE_AFTER_STARTUP

Field RECOMPILE_AT_STARTUP

See Also:

Constant Field Values

RECOMPILE_ALWAYS

public static final short RECOMPILE_ALWAYS

Field RECOMPILE_ALWAYS

See Also:

Constant Field Values

Method Detail

getScopeCascadingType

public short getScopeCascadingType()

return how railo cascade scopes

Returns:

type of cascading

getCFMLExtension

public java.lang.String getCFMLExtension()

return cfml extesnion

Returns:

cfml extension

getCFCExtension

public java.lang.String getCFCExtension()

getCustomTagMappings

public Mapping[] getCustomTagMappings()

return the mapping to custom tag directory

Returns:

custom tag directory

allowImplicidQueryCall

public boolean allowImplicidQueryCall()

return if it is allowed to implizid query call, call a query member witot define name of the query.

Returns:

is allowed

mergeFormAndURL

public boolean mergeFormAndURL()

e merged return if url and form scope will b

Returns:

merge or not

getApplicationTimeout

public TimeSpan getApplicationTimeout()

Returns:

Returns the applicationTimeout.

getSessionTimeout

public TimeSpan getSessionTimeout()

Returns:

Returns the sessionTimeout.

getRequestTimeout

public TimeSpan getRequestTimeout()

Returns:

Returns the requestTimeout.

isClientCookies

public boolean isClientCookies()

Returns:

Returns the clientCookies.

isClientManagement

public boolean isClientManagement()

Returns:

Returns the clientManagement.

isDomainCookies

public boolean isDomainCookies()

Returns:

Returns the domainCookies.

isSessionManagement

public boolean isSessionManagement()

Returns:

Returns the sessionManagement.

isMailSpoolEnable

public boolean isMailSpoolEnable()

Returns:

Returns the spoolEnable.

getMailTimeout

public int getMailTimeout()

Returns:

Returns the mailTimeout.

getPSQL

public boolean getPSQL()

Returns:

preserve single quotes in cfquery tag or not

getLocale

public java.util.Locale getLocale()

Returns:

Returns the locale.

debug

public boolean debug()

return if debug output will be generated

Returns:

debug or not

getTempDirectory

public Resource getTempDirectory()

return the temp directory

Returns:

temp directory

getMailSpoolInterval

public int getMailSpoolInterval()

Returns:

Returns the spoolInterval.

getTimeZone

public java.util.TimeZone getTimeZone()

Returns:

returns the time zone for this

getTimeServerOffset

public long getTimeServerOffset()

Returns:

returns the offset from the timeserver to local time

hasPassword

public boolean hasPassword()

Returns:

return if a password is set

passwordEqual

public boolean passwordEqual(java.lang.String password)

Parameters:

password -

Returns:

return if a password is set

hasServerPassword

public boolean hasServerPassword()

Returns:

return if a password is set

getMappings

public Mapping[] getMappings()

Returns:

Returns the mappings.

getConfigDir

public Resource getConfigDir()

Returns:

Returns the configDir.

getConfigFile

public Resource getConfigFile()

Returns:

Returns the configFile.

getLoadTime

public long getLoadTime()

Returns:

Returns the loadTime.

getBaseComponentTemplate

public java.lang.String getBaseComponentTemplate()

Returns:

Returns the baseComponent.

getClientType

public short getClientType()

Returns:

returns the client type

getComponentDataMemberDefaultAccess

public int getComponentDataMemberDefaultAccess()

Returns:

Returns the componentDataMemberDefaultAccess.

getTimeServer

public java.lang.String getTimeServer()

Returns:

Returns the timeServer.

getComponentDumpTemplate

public java.lang.String getComponentDumpTemplate()

Returns:

Returns the componentDump.

getId

public java.lang.String getId()

Returns:

id of the config

getDebugTemplate

public java.lang.String getDebugTemplate()

Returns:

Returns the debug Template.

getErrorTemplate

public java.lang.String getErrorTemplate()

Deprecated. replaced with getErrorTemplate(int status)

Returns:

Returns the error Template.

getErrorTemplate

public java.lang.String getErrorTemplate(int statusCode)

getSessionType

public short getSessionType()

Returns:

Returns the sessionType.

getWebCharset

public java.lang.String getWebCharset()

Returns:

returns the charset for the response and request

getTemplateCharset

public java.lang.String getTemplateCharset()

Returns:

returns the charset used to read cfml files

getResourceCharset

public java.lang.String getResourceCharset()

Returns:

returns the charset used to read and write resources

getMailDefaultEncoding

public java.lang.String getMailDefaultEncoding()

Returns:

returns the default encoding for mail

getUpdateType

public java.lang.String getUpdateType()

Returns:

returns update type (auto or manual)

getUpdateLocation

public java.net.URL getUpdateLocation()

Returns:

returns URL for update

getDeployDirectory

public Resource getDeployDirectory()

return directory, where railo deploy translated cfml classes (java and class files)

Returns:

deploy directory

getRootDirectory

public Resource getRootDirectory()

Returns:

Returns the rootDir.

getSecurityManager

public SecurityManager getSecurityManager()

Returns:

Returns the accessor.

getCFXTagPool

public CFXTagPool getCFXTagPool()
                         throws PageException

Returns:

Returns the cfxTagPool.

Throws:

PageException

getApplicationLogger

public LogAndSource getApplicationLogger()

Returns:

returns the application logger

getExceptionLogger

public LogAndSource getExceptionLogger()

Returns:

returns the exception logger

getTraceLogger

public LogAndSource getTraceLogger()

Returns:

returns the trace logger

getConfigServer

public ConfigServer getConfigServer(java.lang.String password)
                             throws PageException

Parameters:

password -

Returns:

ConfigServer

Throws:

PageException

getMailLogger

public LogAndSource getMailLogger()

Returns:

Returns the mailLogger.

getRequestTimeoutLogger

public LogAndSource getRequestTimeoutLogger()

Returns:

Returns the request timeout Directory.

getScheduleLogger

public LogAndSource getScheduleLogger()

Returns:

returns schedule logger

reloadTimeServerOffset

public void reloadTimeServerOffset()

reload the time offset to a time server

reset

public void reset()

reset config

getSearchEngine

public SearchEngine getSearchEngine()

Returns:

return the search Storage

getScheduler

public Scheduler getScheduler()

Returns:

return the Scheduler

getMailServers

public Server[] getMailServers()

Returns:

return all defined Mail Servers

getCompileType

public short getCompileType()

return the compile type of this context

getDataSources

public DataSource[] getDataSources()

return the all datasources

getResource

public Resource getResource(java.lang.String path)

Parameters:

path - get a resource that match this path

Returns:

resource matching path

getApplicationListener

public ApplicationListener getApplicationListener()

return current application listener

Returns:

application listener

getScriptProtect

public int getScriptProtect()

Returns:

the scriptProtect

getProxyPassword

public java.lang.String getProxyPassword()

return default proxy setting password

Returns:

the password for proxy

getProxyPort

public int getProxyPort()

return default proxy setting port (default 80)

Returns:

the port for proxy

getProxyServer

public java.lang.String getProxyServer()

return default proxy setting server

Returns:

the server for proxy

getProxyUsername

public java.lang.String getProxyUsername()

return default proxy setting username

Returns:

the username for proxy

isProxyEnableFor

public boolean isProxyEnableFor(java.lang.String host)

return if proxy is enabled or not

Returns:

is proxy enabled

getTriggerComponentDataMember

public boolean getTriggerComponentDataMember()

Returns:

the triggerComponentDataMember

getClientScopeDir

public Resource getClientScopeDir()

getClientScopeDirSize

public long getClientScopeDirSize()

getRPCClassLoader

public java.lang.ClassLoader getRPCClassLoader(boolean reload)
                                        throws java.io.IOException

Throws:

java.io.IOException

getCacheDir

public Resource getCacheDir()

getCacheDirSize

public long getCacheDirSize()

getDefaultDumpWriter

public DumpWriter getDefaultDumpWriter()

Deprecated. use instead getDefaultDumpWriter(int defaultType)

returns the default DumpWriter

Returns:

default DumpWriter

getDefaultDumpWriter

public DumpWriter getDefaultDumpWriter(int defaultType)

returns the default DumpWriter

Parameters:

defaultType -

Returns:

default DumpWriter

getDumpWriter

public DumpWriter getDumpWriter(java.lang.String key,
                                int defaultType)
                         throws PageException

returns the DumpWriter matching key

Parameters:

key - key for DumpWriter

defaultType -

Returns:

matching DumpWriter

Throws:

PageException - if there is no DumpWriter for this key

getDumpWriter

public DumpWriter getDumpWriter(java.lang.String key)
                         throws PageException

Deprecated. use instead getDumpWriter(String key,int defaultType)

returns the DumpWriter matching key

Parameters:

key - key for DumpWriter

Returns:

matching DumpWriter

Throws:

PageException - if there is no DumpWriter for this key

useComponentShadow

public boolean useComponentShadow()

define if components has a "shadow" in the component variables scope or not.

Returns:

getComponentMapping

public Mapping getComponentMapping()

doCustomTagDeepSearch

public boolean doCustomTagDeepSearch()

getErrWriter

public java.io.PrintWriter getErrWriter()

getOutWriter

public java.io.PrintWriter getOutWriter()

Returns:

returns the out print writer stream

doLocalCustomTag

public boolean doLocalCustomTag()

define if railo search in local directory for custom tags or not

Returns:

search in local dir?

getErrorStatusCode

public boolean getErrorStatusCode()

Returns:

if error status code will be returned or not

getLocalMode

public int getLocalMode()

getClusterClass

public java.lang.Class getClusterClass()

Returns:

return the class defined for the cluster scope

getClassLoader

public java.lang.ClassLoader getClassLoader()

Returns:

classloader of ths context

getExtensionDirectory

public Resource getExtensionDirectory()

getExtensionProviders

public ExtensionProvider[] getExtensionProviders()

getExtensions

public Extension[] getExtensions()

getBaseComponentPageSource

public PageSource getBaseComponentPageSource()

allowRealPath

public boolean allowRealPath()

getConstants

public Struct getConstants()

getDataSource

public DataSource getDataSource(java.lang.String datasource)
                         throws PageException

Throws:

PageException

getDataSourcesAsMap

public java.util.Map getDataSourcesAsMap()

getDefaultEncoding

public java.lang.String getDefaultEncoding()

getDefaultResourceProvider

public ResourceProvider getDefaultResourceProvider()

getFactory

public CFMLFactory getFactory()

isExtensionEnabled

public boolean isExtensionEnabled()

getFldFile

public Resource getFldFile()

getTldFile

public Resource getTldFile()

Returns:

the tldFile

getPageSource

public PageSource getPageSource(Mapping[] mappings,
                                java.lang.String realPath,
                                boolean onlyTopLevel)

getPhysical

public Resource getPhysical(Mapping[] mappings,
                            java.lang.String realPath,
                            boolean alsoDefaultMapping)

Parameters:

realPath -

alsoDefaultMapping - ignore default mapping (/) or not

Returns:

physical path from mapping

getRemoteClientDirectory

public Resource getRemoteClientDirectory()

getRemoteClientLog

public LogAndSource getRemoteClientLog()

getRemoteClients

public RemoteClient[] getRemoteClients()

getSpoolerEngine

public SpoolerEngine getSpoolerEngine()

getResourceProviders

public ResourceProvider[] getResourceProviders()

getVersion

public double getVersion()

getVideoDirectory

public Resource getVideoDirectory()

getVideoProviderLocation

public java.lang.String getVideoProviderLocation()

isShowVersion

public boolean isShowVersion()

isSuppressWhitespace

public boolean isSuppressWhitespace()

isVideoAgreementAccepted

public boolean isVideoAgreementAccepted()

getRemoteClientUsage

public Struct getRemoteClientUsage()