railo.runtime.config
Interface Config

All Known Subinterfaces:
ConfigServer, ConfigWeb
All Known Implementing Classes:
ConfigImpl, ConfigServerImpl, ConfigWebImpl

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
 Class getAdminSyncClass()
           
 ApplicationListener getApplicationListener()
          return current application listener
 LogAndSource getApplicationLogger()
           
 TimeSpan getApplicationTimeout()
           
 PageSource getBaseComponentPageSource()
           
 String getBaseComponentTemplate()
           
 Resource getCacheDir()
           
 long getCacheDirSize()
           
 String getCFCExtension()
           
 String[] getCFMLExtensions()
          return cfml extesnion
 CFXTagPool getCFXTagPool()
           
 ClassLoader getClassLoader()
           
 Resource getClientScopeDir()
           
 long getClientScopeDirSize()
           
 short getClientType()
           
 Class getClusterClass()
           
 short getCompileType()
          return the compile type of this context
 int getComponentDataMemberDefaultAccess()
           
 String getComponentDumpTemplate()
           
 Mapping getComponentMapping()
          FUTURE deprecated use public Mapping[] getComponentMappings() instead
 Resource getConfigDir()
           
 Resource getConfigFile()
           
 ConfigServer getConfigServer()
          Deprecated. replaced with getConfigServer(String password)
 ConfigServer getConfigServer(String password)
           
 Struct getConstants()
           
 String[] getCustomTagExtensions()
           
 Mapping[] getCustomTagMappings()
          return the mapping to custom tag directory
 DataSource getDataSource(String datasource)
           
 DataSource[] getDataSources()
          return the all datasources
 Map getDataSourcesAsMap()
           
 String getDebugTemplate()
           
 DumpWriter getDefaultDumpWriter()
          Deprecated. use instead getDefaultDumpWriter(int defaultType)
 DumpWriter getDefaultDumpWriter(int defaultType)
          returns the default DumpWriter
 String getDefaultEncoding()
           
 ResourceProvider getDefaultResourceProvider()
           
 Resource getDeployDirectory()
          return directory, where railo deploy translated cfml classes (java and class files)
 DumpWriter getDumpWriter(String key)
          Deprecated. use instead getDumpWriter(String key,int defaultType)
 DumpWriter getDumpWriter(String key, int defaultType)
          returns the DumpWriter matching key
 boolean getErrorStatusCode()
           
 String getErrorTemplate()
          Deprecated. replaced with getErrorTemplate(int status)
 String getErrorTemplate(int statusCode)
           
 PrintWriter getErrWriter()
           
 LogAndSource getExceptionLogger()
           
 Resource getExtensionDirectory()
           
 ExtensionProvider[] getExtensionProviders()
           
 Extension[] getExtensions()
           
 CFMLFactory getFactory()
           
 Resource getFldFile()
           
 String getId()
           
 long getLoadTime()
           
 Locale getLocale()
           
 int getLocalMode()
           
 String getMailDefaultEncoding()
           
 LogAndSource getMailLogger()
           
 Server[] getMailServers()
           
 int getMailSpoolInterval()
           
 int getMailTimeout()
           
 Mapping[] getMappings()
           
 PrintWriter getOutWriter()
           
 PageSource getPageSource(Mapping[] mappings, String realPath, boolean onlyTopLevel)
          get PageSource of the first Mapping that match the given criteria
 Resource getPhysical(Mapping[] mappings, String realPath, boolean alsoDefaultMapping)
          get Resource of the first Mapping that match the given criteria
 String getProxyPassword()
          return default proxy setting password
 int getProxyPort()
          return default proxy setting port (default 80)
 String getProxyServer()
          return default proxy setting server
 String getProxyUsername()
          return default proxy setting username
 boolean getPSQL()
           
 Resource getRemoteClientDirectory()
           
 LogAndSource getRemoteClientLog()
           
 RemoteClient[] getRemoteClients()
           
 Struct getRemoteClientUsage()
           
 TimeSpan getRequestTimeout()
           
 LogAndSource getRequestTimeoutLogger()
           
 Resource getResource(String path)
           
 String getResourceCharset()
           
 ResourceProvider[] getResourceProviders()
           
 Resource getRootDirectory()
           
 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
 String getTemplateCharset()
           
 String getTimeServer()
           
 long getTimeServerOffset()
           
 TimeZone getTimeZone()
           
 Resource getTldFile()
           
 LogAndSource getTraceLogger()
           
 boolean getTriggerComponentDataMember()
           
 URL getUpdateLocation()
           
 String getUpdateType()
           
 double getVersion()
           
 Resource getVideoDirectory()
           
 Class getVideoExecuterClass()
           
 String getWebCharset()
           
 boolean hasPassword()
           
 boolean hasServerPassword()
           
 boolean isClientCookies()
           
 boolean isClientManagement()
           
 boolean isDomainCookies()
           
 boolean isExtensionEnabled()
           
 boolean isMailSpoolEnable()
           
 boolean isProxyEnableFor(String host)
          return if proxy is enabled or not
 boolean isSessionManagement()
           
 boolean isShowVersion()
           
 boolean isSuppressWhitespace()
           
 boolean mergeFormAndURL()
          e merged return if url and form scope will b
 boolean passwordEqual(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

static final short SCOPE_STRICT
Define a strict scope cascading

See Also:
Constant Field Values

SCOPE_SMALL

static final short SCOPE_SMALL
Define a small scope cascading

See Also:
Constant Field Values

SCOPE_STANDARD

static final short SCOPE_STANDARD
Define a standart scope cascading (like other cf versions)

See Also:
Constant Field Values

CLIENT_SCOPE_TYPE_COOKIE

static final short CLIENT_SCOPE_TYPE_COOKIE
Field CLIENT_SCOPE_TYPE_COOKIE

See Also:
Constant Field Values

CLIENT_SCOPE_TYPE_FILE

static final short CLIENT_SCOPE_TYPE_FILE
Field CLIENT_SCOPE_TYPE_FILE

See Also:
Constant Field Values

CLIENT_SCOPE_TYPE_DB

static final short CLIENT_SCOPE_TYPE_DB
Field CLIENT_SCOPE_TYPE_DB

See Also:
Constant Field Values

SESSION_TYPE_CFML

static final short SESSION_TYPE_CFML
Field SESSION_TYPE_CFML

See Also:
Constant Field Values

SESSION_TYPE_J2EE

static final short SESSION_TYPE_J2EE
Field SESSION_TYPE_J2EE

See Also:
Constant Field Values

RECOMPILE_NEVER

static final short RECOMPILE_NEVER
Field RECOMPILE_NEVER

See Also:
Constant Field Values

RECOMPILE_AFTER_STARTUP

static final short RECOMPILE_AFTER_STARTUP
Field RECOMPILE_AT_STARTUP

See Also:
Constant Field Values

RECOMPILE_ALWAYS

static final short RECOMPILE_ALWAYS
Field RECOMPILE_ALWAYS

See Also:
Constant Field Values
Method Detail

getScopeCascadingType

short getScopeCascadingType()
return how railo cascade scopes

Returns:
type of cascading

getCFMLExtensions

String[] getCFMLExtensions()
return cfml extesnion

Returns:
cfml extension

getCFCExtension

String getCFCExtension()

getCustomTagMappings

Mapping[] getCustomTagMappings()
return the mapping to custom tag directory

Returns:
custom tag directory

allowImplicidQueryCall

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

boolean mergeFormAndURL()
e merged return if url and form scope will b

Returns:
merge or not

getApplicationTimeout

TimeSpan getApplicationTimeout()
Returns:
Returns the applicationTimeout.

getSessionTimeout

TimeSpan getSessionTimeout()
Returns:
Returns the sessionTimeout.

getRequestTimeout

TimeSpan getRequestTimeout()
Returns:
Returns the requestTimeout.

isClientCookies

boolean isClientCookies()
Returns:
Returns the clientCookies.

isClientManagement

boolean isClientManagement()
Returns:
Returns the clientManagement.

isDomainCookies

boolean isDomainCookies()
Returns:
Returns the domainCookies.

isSessionManagement

boolean isSessionManagement()
Returns:
Returns the sessionManagement.

isMailSpoolEnable

boolean isMailSpoolEnable()
Returns:
Returns the spoolEnable.

getMailTimeout

int getMailTimeout()
Returns:
Returns the mailTimeout.

getPSQL

boolean getPSQL()
Returns:
preserve single quotes in cfquery tag or not

getLocale

Locale getLocale()
Returns:
Returns the locale.

debug

boolean debug()
return if debug output will be generated

Returns:
debug or not

getTempDirectory

Resource getTempDirectory()
return the temp directory

Returns:
temp directory

getMailSpoolInterval

int getMailSpoolInterval()
Returns:
Returns the spoolInterval.

getTimeZone

TimeZone getTimeZone()
Returns:
returns the time zone for this

getTimeServerOffset

long getTimeServerOffset()
Returns:
returns the offset from the timeserver to local time

hasPassword

boolean hasPassword()
Returns:
return if a password is set

passwordEqual

boolean passwordEqual(String password)
Parameters:
password -
Returns:
return if a password is set

hasServerPassword

boolean hasServerPassword()
Returns:
return if a password is set

getMappings

Mapping[] getMappings()
Returns:
Returns the mappings.

getConfigDir

Resource getConfigDir()
Returns:
Returns the configDir.

getConfigFile

Resource getConfigFile()
Returns:
Returns the configFile.

getLoadTime

long getLoadTime()
Returns:
Returns the loadTime.

getBaseComponentTemplate

String getBaseComponentTemplate()
Returns:
Returns the baseComponent.

getClientType

short getClientType()
Returns:
returns the client type

getComponentDataMemberDefaultAccess

int getComponentDataMemberDefaultAccess()
Returns:
Returns the componentDataMemberDefaultAccess.

getTimeServer

String getTimeServer()
Returns:
Returns the timeServer.

getComponentDumpTemplate

String getComponentDumpTemplate()
Returns:
Returns the componentDump.

getId

String getId()
Returns:
id of the config

getDebugTemplate

String getDebugTemplate()
Returns:
Returns the debug Template.

getErrorTemplate

String getErrorTemplate()
Deprecated. replaced with getErrorTemplate(int status)

Returns:
Returns the error Template.

getErrorTemplate

String getErrorTemplate(int statusCode)

getSessionType

short getSessionType()
Returns:
Returns the sessionType.

getWebCharset

String getWebCharset()
Returns:
returns the charset for the response and request

getTemplateCharset

String getTemplateCharset()
Returns:
returns the charset used to read cfml files

getResourceCharset

String getResourceCharset()
Returns:
returns the charset used to read and write resources

getMailDefaultEncoding

String getMailDefaultEncoding()
Returns:
returns the default encoding for mail

getUpdateType

String getUpdateType()
Returns:
returns update type (auto or manual)

getUpdateLocation

URL getUpdateLocation()
Returns:
returns URL for update

getDeployDirectory

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

Returns:
deploy directory

getRootDirectory

Resource getRootDirectory()
Returns:
Returns the rootDir.

getSecurityManager

SecurityManager getSecurityManager()
Returns:
Returns the accessor.

getCFXTagPool

CFXTagPool getCFXTagPool()
                         throws PageException
Returns:
Returns the cfxTagPool.
Throws:
PageException

getApplicationLogger

LogAndSource getApplicationLogger()
Returns:
returns the application logger

getExceptionLogger

LogAndSource getExceptionLogger()
Returns:
returns the exception logger

getTraceLogger

LogAndSource getTraceLogger()
Returns:
returns the trace logger

getConfigServer

ConfigServer getConfigServer(String password)
                             throws PageException
Parameters:
password -
Returns:
ConfigServer
Throws:
PageException

getConfigServer

ConfigServer getConfigServer()
Deprecated. replaced with getConfigServer(String password)

Returns:

getMailLogger

LogAndSource getMailLogger()
Returns:
Returns the mailLogger.

getRequestTimeoutLogger

LogAndSource getRequestTimeoutLogger()
Returns:
Returns the request timeout Directory.

getScheduleLogger

LogAndSource getScheduleLogger()
Returns:
returns schedule logger

reloadTimeServerOffset

void reloadTimeServerOffset()
reload the time offset to a time server


reset

void reset()
reset config


getSearchEngine

SearchEngine getSearchEngine()
Returns:
return the search Storage

getScheduler

Scheduler getScheduler()
Returns:
return the Scheduler

getMailServers

Server[] getMailServers()
Returns:
return all defined Mail Servers

getCompileType

short getCompileType()
return the compile type of this context


getDataSources

DataSource[] getDataSources()
return the all datasources


getResource

Resource getResource(String path)
Parameters:
path - get a resource that match this path
Returns:
resource matching path

getApplicationListener

ApplicationListener getApplicationListener()
return current application listener

Returns:
application listener

getScriptProtect

int getScriptProtect()
Returns:
the scriptProtect

getProxyPassword

String getProxyPassword()
return default proxy setting password

Returns:
the password for proxy

getProxyPort

int getProxyPort()
return default proxy setting port (default 80)

Returns:
the port for proxy

getProxyServer

String getProxyServer()
return default proxy setting server

Returns:
the server for proxy

getProxyUsername

String getProxyUsername()
return default proxy setting username

Returns:
the username for proxy

isProxyEnableFor

boolean isProxyEnableFor(String host)
return if proxy is enabled or not

Returns:
is proxy enabled

getTriggerComponentDataMember

boolean getTriggerComponentDataMember()
Returns:
the triggerComponentDataMember

getClientScopeDir

Resource getClientScopeDir()

getClientScopeDirSize

long getClientScopeDirSize()

getRPCClassLoader

ClassLoader getRPCClassLoader(boolean reload)
                              throws IOException
Throws:
IOException

getCacheDir

Resource getCacheDir()

getCacheDirSize

long getCacheDirSize()

getDefaultDumpWriter

DumpWriter getDefaultDumpWriter()
Deprecated. use instead getDefaultDumpWriter(int defaultType)

returns the default DumpWriter

Parameters:
defaultType -
Returns:
default DumpWriter

getDefaultDumpWriter

DumpWriter getDefaultDumpWriter(int defaultType)
returns the default DumpWriter

Parameters:
defaultType -
Returns:
default DumpWriter

getDumpWriter

DumpWriter getDumpWriter(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

DumpWriter getDumpWriter(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

boolean useComponentShadow()
define if components has a "shadow" in the component variables scope or not.

Returns:

getComponentMapping

Mapping getComponentMapping()
FUTURE deprecated use public Mapping[] getComponentMappings() instead


doCustomTagDeepSearch

boolean doCustomTagDeepSearch()

getErrWriter

PrintWriter getErrWriter()

getOutWriter

PrintWriter getOutWriter()
Returns:
returns the out print writer stream

doLocalCustomTag

boolean doLocalCustomTag()
define if railo search in local directory for custom tags or not

Returns:
search in local dir?

getCustomTagExtensions

String[] getCustomTagExtensions()

getErrorStatusCode

boolean getErrorStatusCode()
Returns:
if error status code will be returned or not

getLocalMode

int getLocalMode()

getClusterClass

Class getClusterClass()
Returns:
return the class defined for the cluster scope

getClassLoader

ClassLoader getClassLoader()
Returns:
classloader of ths context

getExtensionDirectory

Resource getExtensionDirectory()

getExtensionProviders

ExtensionProvider[] getExtensionProviders()

getExtensions

Extension[] getExtensions()

getBaseComponentPageSource

PageSource getBaseComponentPageSource()

allowRealPath

boolean allowRealPath()

getConstants

Struct getConstants()

getDataSource

DataSource getDataSource(String datasource)
                         throws PageException
Throws:
PageException

getDataSourcesAsMap

Map getDataSourcesAsMap()

getDefaultEncoding

String getDefaultEncoding()

getDefaultResourceProvider

ResourceProvider getDefaultResourceProvider()

getFactory

CFMLFactory getFactory()

isExtensionEnabled

boolean isExtensionEnabled()

getFldFile

Resource getFldFile()

getTldFile

Resource getTldFile()
Returns:
the tldFile

getPageSource

PageSource getPageSource(Mapping[] mappings,
                         String realPath,
                         boolean onlyTopLevel)
get PageSource of the first Mapping that match the given criteria

Parameters:
mappings - per application mappings
realPath - path to get PageSource for
onlyTopLevel - checks only toplevel mappings

getPhysical

Resource getPhysical(Mapping[] mappings,
                     String realPath,
                     boolean alsoDefaultMapping)
get Resource of the first Mapping that match the given criteria

Parameters:
mappings - per application mappings
realPath - path to get PageSource for
onlyTopLevel - checks only toplevel mappings

getRemoteClientDirectory

Resource getRemoteClientDirectory()

getRemoteClientLog

LogAndSource getRemoteClientLog()

getRemoteClients

RemoteClient[] getRemoteClients()

getSpoolerEngine

SpoolerEngine getSpoolerEngine()

getResourceProviders

ResourceProvider[] getResourceProviders()

getVersion

double getVersion()

getVideoDirectory

Resource getVideoDirectory()

isShowVersion

boolean isShowVersion()

isSuppressWhitespace

boolean isSuppressWhitespace()

getRemoteClientUsage

Struct getRemoteClientUsage()

getAdminSyncClass

Class getAdminSyncClass()

getVideoExecuterClass

Class getVideoExecuterClass()


Copyright © 2012 Railo