Manages runtime settings for fonts, cache, charts, configuration, and other settings.
backup* |
---|
private
void
backup
(
daFile
)
Creates a backup (.bak) version of the specified file. Output: suppressed Parameters: daFile: any, optional, daFile - Name of file for which to create a backup copy. |
clearComponentCache |
void
clearComponentCache
(
)
Clears the Component cache. Output: suppressed |
clearQueryCache |
void
clearQueryCache
(
)
Removes all cached queries Output: suppressed |
clearTemplateFolderFromCache |
void
clearTemplateFolderFromCache
(
path=""
)
Clears the template cache for specific folder recursively. Output: suppressed Parameters: path: any, optional, path - Path to the folder |
clearTrustedCache |
void
clearTrustedCache
(
templateList=""
)
Clears the template cache. Output: suppressed Parameters: templateList: any, optional, templateList - a comma separated list of compiled templates full path to be deleted from cache |
deleteClientStore |
public
deleteClientStore
(
required string
name
)
Removes a data source type of client variable store. Available only for users in one of the roles: admin Output: suppressed Parameters: name: string, required, name - Name of data source to remove as a client variable store. |
deleteFont |
public
deleteFont
(
required
fontFile
)
Deletes a font from the ColdFusion list of registered fonts. Output: suppressed Parameters: fontFile: any, required, fontFile - Name of the font to delete. |
executeClassPath* |
private
executeClassPath
(
required
name
)
Executes the named executable process with the specified classpath setting. Output: Parameters: name: any, required, name - Name of executable process to run on the ColdFusion server. |
getCacheProperty |
public
any
getCacheProperty
(
required
propertyName
)
Returns the value of a ColdFusion cache property setting. Output: suppressed Parameters: propertyName: any, required, propertyName - Valid Properties are:
|
getCacheServerSettings |
any
getCacheServerSettings
(
required
engine
)
returns spoolChunkSize,maxElementsCheck,idletimeCheckThreadInterval Output: suppressed Parameters: engine: any, required, engine - engine name : either memcached or redis |
getChartProperty |
public
any
getChartProperty
(
required
propertyName
)
Returns the value of a Charting property. Output: suppressed Parameters: propertyName: any, required, propertyName - Valid Properties are:
|
getClientStores |
public
getClientStores
(
string
name
)
Returns a specific client data store or a list of client data stores. Available only for users in one of the roles: admin Output: suppressed Parameters: name: string, optional, name - Name of a specific client data store. |
getFonts |
public
struct
getFonts
(
fontFamily
)
Returns font information (family, face, type, use, path) for all fonts or for a specified font. Output: suppressed Parameters: fontFamily: any, optional, fontFamily - Specifies a font name. |
getInstanceName |
any
getInstanceName
(
)
returns the current instance name Output: suppressed |
getJvmProperty |
public
any
getJvmProperty
(
required
propertyName
)
Returns the value of a Java Virtual Machine (JVM) property. Output: suppressed Parameters: propertyName: any, required, propertyName - Valid Properties are:
|
getLastClientID |
public
numeric
getLastClientID
(
)
Returns the ID for the last client. Available only for users in one of the roles: admin Output: suppressed |
getMemcachedServer |
any
getMemcachedServer
(
)
gets currently set memcached server. Output: suppressed |
getOption* |
private
getOption
(
required
option
)
Returns the value of a specified JVM option. Output: Parameters: option: any, required, option - Name of the option to retrieve. |
getOptionList* |
private
getOptionList
(
required
vmArgs
)
Splits JVM arguments into a list that can be handled one by one. Output: Parameters: vmArgs: any, required, vmArgs - JVM arguments. |
getPath |
public
getPath
(
required
path,
required
type
)
Filters the classpath to replace ';' and ':\\' with commas, specifying whether to remove or return ColdFusion-only items. Output: suppressed Parameters: path: any, required, path - Classpath string to parse. type: any, required, type - Specify 'cf' for this parameter to return ColdFusion-only items. |
getProps* |
private
getProps
(
)
Returns the Java configuration properties (server configuration only). Output: |
getRuntimeProperty |
public
any
getRuntimeProperty
(
required
propertyName
)
Returns the value of a ColdFusion performance property setting. Output: suppressed Parameters: propertyName: any, required, propertyName - Valid Properties are:
|
getScopeProperty |
public
any
getScopeProperty
(
required
propertyName
)
Returns the value of a scope property. Output: suppressed Parameters: propertyName: any, required, propertyName - Valid Properties are:
|
isRESTDiscoveryEnabled |
boolean
isRESTDiscoveryEnabled
(
)
Returns if REST Discovery is enabled or not Output: suppressed |
saveJvmConfig* |
private
saveJvmConfig
(
)
Saves the JVM configuration setting to the jvm.config file (server configuration only). Output: |
setCacheProperty |
public
void
setCacheProperty
(
required
propertyName,
required
propertyValue
)
Sets the value of a ColdFusion cache property setting. Output: suppressed Parameters: propertyName: any, required, propertyName - Valid Properties are:
propertyValue: any, required, propertyValue - Value to set for the specified property. |
setCachingRedisServer |
void
setCachingRedisServer
(
required
host,
required
port,
required
password,
required boolean
cluster
)
SetJCS cluster DSN name. Output: suppressed Parameters: host: any, required, host - Host address of server port: any, required, port - Port of server password: any, required, password - Password of server cluster: boolean, required, cluster - Whether cluster is enabled in redis or not |
setChartProperty |
public
void
setChartProperty
(
required
propertyName,
required
propertyValue
)
Sets the value of a Charting property. Output: suppressed Parameters: propertyName: any, required, propertyName - Valid Properties are:
propertyValue: any, required, propertyValue - Value to set for the specified property. |
setClientStore |
public
setClientStore
(
required string
description,
required boolean
disable_globals,
required string
name,
required boolean
purge,
required numeric
timeout,
required string
type,
string
dsn=""
)
Sets the properties of a client data store. Available only for users in one of the roles: admin Output: suppressed Parameters: description: string, required, description - A description of the client data store and its settings. disable_globals: boolean, required, disable_globals - Specifies whether to disable global client variables. Specify true or false. name: string, required, name - Name of client data store:
purge: boolean, required, purge - Set to have ColdFusion periodically purge client data that has not been accessed in the specified number of days - true/false timeout: numeric, required, timeout - Number of days after which ColdFusion is to purge client data that has not been accessed. type: string, required, type - Type of client data store. dsn: string, optional, dsn - If client data store is a data source, name of the data source. |
setFont |
public
setFont
(
required
fontFile
)
Adds a new font and registers it with ColdFusion. Output: suppressed Parameters: fontFile: any, required, fontFile - Specifies a fully qualified path/filename to the font file to add. |
setJCSClusterDsnName |
void
setJCSClusterDsnName
(
required
dsn,
required boolean
createTables
)
SetJCS cluster DSN name. Output: suppressed Parameters: dsn: any, required, dsn - Name of datasource createTables: boolean, required, createTables - Whether to create tables or not |
setJvmConfig* |
private
void
setJvmConfig
(
minHeapArg="[runtime expression]",
maxHeapArg="[runtime expression]",
jvmArgs="[runtime expression]"
)
Sets JVM arguments in the jvm.config file (server configuration only). Output: suppressed Parameters: minHeapArg: any, optional, minHeapArg - Minimum heap size. maxHeapArg: any, optional, maxHeapArg - Maximum heap size. jvmArgs: any, optional, jvmArgs - Other JVM arguments. |
setJvmProperty |
public
void
setJvmProperty
(
required
propertyName,
required
propertyValue
)
Sets the value of a Java Virtual Machine property. Output: suppressed Parameters: propertyName: any, required, propertyName - Valid Properties are:
propertyValue: any, required, propertyValue - The value to set for the specified property. |
setLastClientID |
public
void
setLastClientID
(
required numeric
lastid
)
Stores the ID of the last client to visit the site. Available only for users in one of the roles: admin Output: suppressed Parameters: lastid: numeric, required, lastid - ID number for the last client. |
setMemcachedServer |
void
setMemcachedServer
(
required
servers
)
Sets memcached server. Output: suppressed Parameters: servers: any, required, servers - Comma delimited servers |
setRESTDiscoveryEnabled |
void
setRESTDiscoveryEnabled
(
boolean
enabled="true"
)
Enables or disable REST Discovery Output: suppressed Parameters: enabled: boolean, optional, enabled |
setRuntimeProperty |
public
void
setRuntimeProperty
(
required
propertyName,
required
propertyValue
)
Sets the value of a ColdFusion performance property. Output: suppressed Parameters: propertyName: any, required, propertyName - Valid Properties are:
propertyValue: any, required, propertyValue - Value to set for the specified property. |
setScopeProperty |
public
void
setScopeProperty
(
required
propertyName,
required
propertyValue
)
Sets the value of a scope property. Output: suppressed Parameters: propertyName: any, required, propertyName - Valid Properties are:
propertyValue: any, required, propertyValue - Value to set for the specified property. |
setServerCachingEngine |
void
setServerCachingEngine
(
required
engine
)
Changes the server level caching engine. Output: suppressed Parameters: engine: any, required, engine - 1 for ehcache, 2 for jcs, 3 for memcached, 4 for redis |
splitargs* |
private
splitargs
(
required
string
)
Splits a list of string arguments into an array. Output: Parameters: string: any, required, string - Internal use. |
stopApplication |
void
stopApplication
(
required
appName
)
Stops the named application. Output: suppressed Parameters: appName: any, required, appName - Name of the application |
verifyRedisCacheStorageConnection |
void
verifyRedisCacheStorageConnection
(
sessionStorageHost="",
numeric
sessionStoragePort="6379",
sessionStoragePassword,
sessionStorageIsCluster
)
Verifies Connection to the Redis cache storage Output: suppressed Parameters: sessionStorageHost: any, optional, sessionStorageHost - Redis Storage Hostname sessionStoragePort: numeric, optional, sessionStoragePort - Redis Storage Port sessionStoragePassword: any, optional, sessionStoragePassword - Redis cache Storage Password sessionStorageIsCluster: any, optional, sessionStorageIsCluster - Is cluster enabled |
verifySessionStorageConnection |
void
verifySessionStorageConnection
(
sessionStorageHost="",
numeric
sessionStoragePort="6379",
sessionStoragePassword
)
Verifies Connection to the External Session Storage (Redis) Output: suppressed Parameters: sessionStorageHost: any, optional, sessionStorageHost - External Session Storage Hostname sessionStoragePort: numeric, optional, sessionStoragePort - External Session Storage Port sessionStoragePassword: any, optional, sessionStoragePassword - External Session Storage Password |