servermanager.cfc

CFIDE.adminapi.servermanager
Component servermanager (Server Manager)

Provides API for accessing server manager information.

hierarchy: WEB-INF.cftags.component
CFIDE.adminapi.base
CFIDE.adminapi.servermanager
path: {web-root}\CFIDE\adminapi\servermanager.cfc
serializable: Yes
properties:
methods: applyHotfix, archiveLogFile, buildArchive, buildChartingXML*, buildConfigxml, builddebugsettingsxml*, builddsnsxml*, builddsnxml*, buildgatewaysxml*, buildgatewayxml*, buildjvmsettingsxml*, buildlogsettingsxml*, buildmailsettingsxml*, buildmappingsxml*, buildmemoryvarsxml*, buildrequestparamsxml*, buildScheduledTasksxml*, buildserversettingsxml*, buildtaskxml*, checkPositive*, clearTemplateCache, convertToTitleCase, createArchive, createDSNFromMap*, deleteArchive, deleteDatasources, deleteLogFile, deleteMappings, deletescheduledtasks, deployLocalArchive, deployRemoteArchive, editArchive, getAdminVariant, getapplets, getArchive, getArchiveContent, getArchives, getBuildNumber, getcfxtags, getChartingSettings, getcollections, getConfigFeatures, getDatasources, getDebugParams, getDrivers, getEdition*, getGateways, getJVMSettings, getLogFiles, getLoggingSettings, getMailSettings, getMappings, getMemoryVarSettings, getODBCDSNs, getRequestTuningParams, getscheduledtask, getScheduledTasks, getServerRestartFeatures, getServerSettings, getwebservices, init, isJ2EEInstall, isJRunInstall, isJVMSettingsAvailable, monitorGatewayInstances, pauseAllScheduledTasks, pauseScheduledTasks, populateArchiveWrapper*, populateGatewayWrapper*, populateScheduledTask*, populateSchedulerWrapper*, removeHotfix, resumeallscheduledtasks, resumescheduledtasks, runAllscheduledtasks, runscheduledtasks, setChartingSettings, setDatasources, setDebugParams, setDSN, <

;a href=”#method_setJVMSettings”>setJVMSettings, setLoggingSettings, setMailSettings, setMappings, setMemoryVarSettings, setRequestTuningParams, setScheduledTasks, setServerSettings, setupAccessDatasource, setupODBCSocketDatasource, startAllGatewayInstances, startGatewayInstance, stopAllGatewayInstances, stopGatewayInstance, verifyAdminRoles*, verifyChartingSettings*, verifyDatasources, verifyMailSettings*, verifyMappings*, verifyMemoryVarParams*, verifySchedulerWrapper*, viewLogFile
inherited methods: dump, getInstallType, getJRunRootDir, isAdminUser, RDSInvoker, setJrunSN

* – private method

applyHotfix
remote void applyHotfix (

)

Applies the hotfix.

Output:

archiveLogFile
remote void archiveLogFile ( required string logfilename
)

Archives a log file, given the logfile name.

Output:
Parameters:
logfilename: string, required, logfilename

buildArchive
remote void buildArchive ( required string archivename, required string filepath
)

Builds a ColdFusion archive, given the archivename and the filepath where the archive has to be built.

Output:
Parameters:
archivename: string, required, archivename
filepath: string, required, filepath

buildChartingXML*
private void buildChartingXML ( required any docroot, required any parentNode
)

Output:
Parameters:
docroot: any, required, docroot
parentNode: any, required, parentNode

buildConfigxml
remote any buildConfigxml ( required array featuresarr
)

Constructs the configuration xml. An array of features is provided as input, based on which the xml file is populated.

Output:
Parameters:
featuresarr: array, required, featuresarr

builddebugsettingsxml*
private void builddebugsettingsxml ( required any docroot, required any parentNode
)

Output:
Parameters:
docroot: any, required, docroot
parentNode: any, required, parentNode

builddsnsxml*
private void builddsnsxml ( required any docroot, required any parentNode
)

Output:
Parameters:
docroot: any, required, docroot
parentNode: any, required, parentNode

builddsnxml*
private void builddsnxml ( required any docroot, required any parentNode, required CFIDE.adminapi._servermanager.dswrapper dwrapper
)

Output:
Parameters:
docroot: any, required, docroot
parentNode: any, required, parentNode
dwrapper: CFIDE.adminapi._servermanager.dswrapper, required, dwrapper

buildgatewaysxml*
private void buildgatewaysxml ( required any docroot, required any parentNode
)

Output:
Parameters:
docroot: any, required, docroot
parentNode: any, required, parentNode

buildgatewayxml*
private void buildgatewayxml ( required any docroot, required any parentNode, required CFIDE.adminapi._servermanager.gatewaywrapper gwrapper
)

Output:
Parameters:
docroot: any, required, docroot
parentNode: any, required, parentNode
gwrapper: CFIDE.adminapi._servermanager.gatewaywrapper, required, gwrapper

buildjvmsettingsxml*
private void buildjvmsettingsxml ( required any docroot, required any parentNode
)

Output:
Parameters:
docroot: any, required, docroot
parentNode: any, required, parentNode

buildlogsettingsxml*
private void buildlogsettingsxml ( required any docroot, required any parentNode
)

Output:
Parameters:
docroot: any, required, docroot
parentNode: any, required, parentNode

buildmailsettingsxml*
private void buildmailsettingsxml ( required any docroot, required any parentNode
)

Output:
Parameters:
docroot: any, required, docroot
parentNode: any, required, parentNode

buildmappingsxml*
private void buildmappingsxml ( required any docroot, required any parentNode
)

Output:
Parameters:
docroot: any, required, docroot
parentNode: any, required, parentNode

buildmemoryvarsxml*
private void buildmemoryvarsxml ( required any docroot, required any parentNode
)

Builds the part of the xml containing memory variable settings

Output:
Parameters:
docroot: any, required, docroot
parentNode: any, required, parentNode

buildrequestparamsxml*
private void buildrequestparamsxml ( required any docroot, required any parentNode
)

Builds the part of the xml containing request tuning parameters

Output:
Parameters:
docroot: any, required, docroot
parentNode: any, required, parentNode

buildScheduledTasksxml*
private void buildScheduledTasksxml ( required any docroot, required any parentNode
)

Output:
Parameters:
docroot: any, required, docroot
parentNode: any, required, parentNode

buildserversettingsxml*
private void buildserversettingsxml ( required any docroot, required any parentNode
)

Builds the part of the xml containing server settings

Output:
Parameters:
docroot: any, required, docroot
parentNode: any, required, parentNode

buildtaskxml*
private void buildtaskxml ( required any docroot, required any parentNode, required CFIDE.adminapi._servermanager.schedulerwrapper twrapper
)

Output:
Parameters:
docroot: any, required, docroot
parentNode: any, required, parentNode
twrapper: CFIDE.adminapi._servermanager.schedulerwrapper, required, twrapper

checkPositive*
private string checkPositive ( required var, required setting
)

Verifies if the given variable has a positive value. This API returns an error message incase error occurs

Output:
Parameters:
var: any, required, var
setting: any, required, setting

clearTemplateCache
remote void clearTemplateCache (

)

Clears the template cache

Output:

convertToTitleCase
public string convertToTitleCase ( required string strval
)

Output:
Parameters:
strval: string, required, strval

createArchive
remote CFIDE.adminapi._servermanager.archivewrapper createArchive ( required string archivename
)

Creates a ColdFusion archive, given the archivename.

Output:
Parameters:
archivename: string, required, archivename

createDSNFromMap*
private CFIDE.adminapi._servermanager.dswrapper createDSNFromMap ( required struct dsobj, required string dsname
)

Returns a dswrapper object populated with datasource attributes

Output:
Parameters:
dsobj: struct, required, dsobj
dsname: string, required, dsname

deleteArchive
remote void deleteArchive ( required string archivename
)

Deletes an archive

Output:
Parameters:
archivename: string, required, archivename

deleteDatasources
remote void deleteDatasources ( required array dsnarr
)

Deletes the datasources. This function takes an array of dsn names as input parameter.

Output:
Parameters:
dsnarr: array, required, dsnarr

deleteLogFile
remote void deleteLogFile ( required string logfilename
)

Deletes a log file, given the logfile name.

Output:
Parameters:
logfilename: string, required, logfilename

deleteMappings
remote void deleteMappings ( required array mappingnames
)

Deletes a mapping

Output:
Parameters:
mappingnames: array, required, mappingnames

deletescheduledtasks
remote void deletescheduledtasks ( required array tasks
)

Deletes an array of scheduled tasks, given the array of scheduled task names.

Output:
Parameters:
tasks: array, required, tasks

deployLocalArchive
remote void deployLocalArchive ( required string filename
)

Deploys the archive that is present in the same server

Output:
Parameters:
filename: string, required, filename

deployRemoteArchive
remote void deployRemoteArchive ( required string fileData
)

Deploys the archive that is present in a remote server

Output:
Parameters:
fileData: string, required, fileData

editArchive
remote void editArchive ( required CFIDE.adminapi._servermanager.archivewrapper awrapper
)

Edits a ColdFusion archive. This method takes in an archivewrapper object which contains information about collections, datasources, etc that has to be included in the archive.

Output:
Parameters:
awrapper: CFIDE.adminapi._servermanager.archivewrapper, required, awrapper

getAdminVariant
public string getAdminVariant (

)

Output:

getapplets
remote array getapplets (

)

Returns all the applets.

Output:

getArchive
remote CFIDE.adminapi._servermanager.archivewrapper getArchive ( required string archivename
)

Returns archive information.

Output:
Parameters:
archivename: string, required, archivename

getArchiveContent
remote string getArchiveContent ( required string archivename
)

Given the archive name, this function builds the archive in a temp directory and returns the encoded binary data in the form of a string

Output:
Parameters:
archivename: string, required, archivename

getArchives
remote getArchives (

)

Returns all archives in the form of archivewrapper objects.

Output:

getBuildNumber
remote string getBuildNumber (

)

Returns the build number

Output:

getcfxtags
remote array getcfxtags (

)

Returns available cfx tags.

Output:

getChartingSettings
remote CFIDE.adminapi._servermanager.chartingsettingswrapper getChartingSettings (

)

Returns the charting settings

Output:

getcollections
remote struct getcollections (

)

Returns a struct containing the name of the collection and path

Output:

getConfigFeatures
remote struct getConfigFeatures (

)

Returns a map containing all the related wrapper classes as keys and the feature names as values, a subset of which has to be provided as input for buildConfigXML

Output:

getDatasources
remote CFIDE.adminapi._servermanager.dswrapper[] getDatasources (

)

Returns the list of available datasources in the form dswrapper objects.

Output:

getDebugParams
public CFIDE.adminapi._servermanager.debugparamswrapper getDebugParams (

)

Returns the debug parameters, in the form of debugparamswrapper.

Output:

getDrivers
remote array getDrivers (

)

Returns an array containing all registered drivers

Output:

getEdition*
private string getEdition (

)

Returns the edition:

  • Developer
  • Evaluation
  • Standard

  • Enterprise
  • Professional

Output: suppressed

getGateways
remote CFIDE.adminapi._servermanager.gatewaywrapper[] getGateways (

)

Returns the gateway instances

Output:

getJVMSettings
remote CFIDE.adminapi._servermanager.jvmsettingswrapper getJVMSettings (

)

Returns the jvm settings

Output:

getLogFiles
remote array getLogFiles (

)

Returns the list of available logfiles.

Output:

getLoggingSettings
remote CFIDE.adminapi._servermanager.loggingparamswrapper getLoggingSettings (

)

Returns the logging settings

Output:

getMailSettings
remote CFIDE.adminapi._servermanager.mailsettingswrapper getMailSettings (

)

Returns the mail settings

Output:

getMappings
remote CFIDE.adminapi._servermanager.mappingswrapper[] getMappings (

)

Returns the mappings

Output:

getMemoryVarSettings
remote CFIDE.adminapi._servermanager.memoryvarswrapper getMemoryVarSettings (

)

Returns the memory variables settings, in the form of memoryvarswrapper objects.

Output:

getODBCDSNs
remote Array getODBCDSNs (

)

Output:

getRequestTuningParams
remote CFIDE.adminapi._servermanager.tuningparamswrapper getRequestTuningParams (

)

Returns the request tuning parameters, in the form of tuningparamswrapper objects.

Output:

getscheduledtask
remote CFIDE.adminapi._servermanager.schedulerwrapper getscheduledtask ( required string taskname
)

Returns the information about a particular scheduled task, given the task name

Output:
Parameters:
taskname: string, required, taskname

getScheduledTasks
remote CFIDE.adminapi._servermanager.schedulerwrapper[] getScheduledTasks (

)

Returns scheduled tasks

Output:

getServerRestartFeatures
remote array getServerRestartFeatures (

)

Returns an array of features that requires server restart

Output:

getServerSettings
remote CFIDE.adminapi._servermanager.serversettingswrapper getServerSettings (

)

Returns the server settings in the form of serversettingswrapper objects.

Output:

getwebservices
remote array getwebservices (

)

Returns all the configured webservices.

Output:

init
servermanager init (

)

Constructor

Output:

isJ2EEInstall
remote boolean isJ2EEInstall (

)

Returns true if the current installation is J2EE

Output:

isJRunInstall
remote boolean isJRunInstall (

)

Returns true if the current installation is JRun Multi Server

Output:

isJVMSettingsAvailable
remote boolean isJVMSettingsAvailable (

)

Output:

monitorGatewayInstances
remote void monitorGatewayInstances ( required string emailid
)

Monitors all the gateway instances. This function checks the status of all the gateway instances configured in a server and sends mail using the configured mail settings in administrator

Output:
Parameters:
emailid: string, required, emailid

pauseAllScheduledTasks
remote void pauseAllScheduledTasks (

)

Pauses all scheduled tasks.

Output:

pauseScheduledTasks
remote void pauseScheduledTasks ( required array tasks
)

Pauses an array of scheduled tasks, given the array of scheduled task names.

Output:
Parameters:
tasks: array, required, tasks

populateArchiveWrapper*
private CFIDE.adminapi._servermanager.archivewrapper populateArchiveWrapper ( required any archive
)

Output:
Parameters:
archive: any, required, archive

populateGatewayWrapper*
private CFIDE.adminapi._servermanager.gatewaywrapper populateGatewayWrapper ( required any gwinfo
)

Output:
Parameters:
gwinfo: any, required, gwinfo

populateScheduledTask*
private array populateScheduledTask ( required CFIDE.adminapi._servermanager.schedulerwrapper swrapper
)

Populates a scheduled task and returns an array of errors, if any

Output:
Parameters:
swrapper: CFIDE.adminapi._servermanager.schedulerwrapper, required, swrapper

populateSchedulerWrapper*
private CFIDE.adminapi._servermanager.schedulerwrapper populateSchedulerWrapper ( required struct task
)

Output:
Parameters:
task: struct, required, task

removeHotfix
remote void removeHotfix ( required string hfname
)

Removes the hotfix, given the name of the hotfix

Output:
Parameters:
hfname: string, required, hfname

resumeallscheduledtasks
remote void resumeallscheduledtasks (

)

Resumes all scheduled tasks

Output:

resumescheduledtasks
remote void resumescheduledtasks ( required array tasks
)

Resumes an array of scheduled tasks, given the array of scheduled task names.

Output:
Parameters:
tasks: array, required, tasks

runAllscheduledtasks
remote struct runAllscheduledtasks (

)

Runs all scheduled tasks. Returns an array containing the task name as the key and error string as value, incase of any errors, or an empty string incase of no errors

Output:

runscheduledtasks
remote struct runscheduledtasks ( required array tasks
)

Runs an array of scheduled tasks. Returns an array containing the task name as the key and error string as value, incase of any errors, or an empty string incase of no errors

Output:
Parameters:
tasks: array, required, tasks

setChartingSettings
remote array setChartingSettings ( required CFIDE.adminapi._servermanager.chartingsettingswrapper chartingsettings
)

Sets the charting settings.This API returns an array of error messages, incase of any errors.

Output:
Parameters:
chartingsettings: CFIDE.adminapi._servermanager.chartingsettingswrapper, required, chartingsettings

setDatasources
remote struct setDatasources ( required CFIDE.adminapi._servermanager.dswrapper[] dsWrapperobjs
)

Creates/ edits datasources. This function takes in an array of dswrapper objects using which new datasources are created. It takes an array of dswrapper objects, and returns a struct containing errors, if any

Output:
Parameters:
dsWrapperobjs: CFIDE.adminapi._servermanager.dswrapper[], required, dsWrapperobjs

setDebugParams
public void setDebugParams ( required CFIDE.adminapi._servermanager.debugparamswrapper debugparams
)

Sets the debug parameters

Output:
Parameters:
debugparams: CFIDE.adminapi._servermanager.debugparamswrapper, required, debugparams

setDSN
public string setDSN ( required CFIDE.adminapi._servermanager.dswrapper ds
)

Creates/edits a datasource based on the driver type

Output:
Parameters:
ds: CFIDE.adminapi._servermanager.dswrapper, required, ds

setJVMSettings
remote void setJVMSettings ( required CFIDE.adminapi._servermanager.jvmsettingswrapper jvmsettings
)

Sets the jvm settings

Output:
Parameters:
jvmsettings: CFIDE.adminapi._servermanager.jvmsettingswrapper, required, jvmsettings

setLoggingSettings
remote array setLoggingSettings ( required CFIDE.adminapi._servermanager.loggingparamswrapper lwrapper
)

Sets the logging settings, and returns an array of errors, if any

Output:
Parameters:
lwrapper: CFIDE.adminapi._servermanager.loggingparamswrapper, required, lwrapper

setMailSettings
remote array setMailSettings ( required CFIDE.adminapi._servermanager.mailsettingswrapper mailsettings
)

Sets the mail settings. Returns an array of errors if any.

Output:
Parameters:
mailsettings: CFIDE.adminapi._servermanager.mailsettingswrapper, required, mailsettings

setMappings
remote struct setMappings ( required CFIDE.adminapi._servermanager.mappingswrapper[] mappings
)

Sets the mappings. Creates/edit mappings. Returns an error struct, which contains the logical path as key and an array of errors, incase of any errors.

Output:
Parameters:
mappings: CFIDE.adminapi._servermanager.mappingswrapper[], required, mappings

setMemoryVarSettings
remote array setMemoryVarSettings ( required CFIDE.adminapi._servermanager.memoryvarswrapper memoryvarparams
)

Sets the memory variable settings.This API returns an array of error messages, incase of any errors.

Output:
Parameters:
memoryvarparams: CFIDE.adminapi._servermanager.memoryvarswrapper, required, memoryvarparams

setRequestTuningParams
remote array setRequestTuningParams ( required CFIDE.adminapi._servermanager.tuningparamswrapper tuningparams
)

Sets the request tuning parameters.This API returns an array of error messages, incase of any errors.

Output:
Parameters:
tuningparams: CFIDE.adminapi._servermanager.tuningparamswrapper, required, tuningparams

setScheduledTasks
remote struct setScheduledTasks ( required CFIDE.adminapi._servermanager.schedulerwrapper[] scheduledtasks
)

Sets scheduled tasks.Returns a struct containing the task name as the key and an array of errors if any.

Output:
Parameters:
scheduledtasks: CFIDE.adminapi._servermanager.schedulerwrapper[], required, scheduledtasks

setServerSettings
remote array setServerSettings ( required CFIDE.adminapi._servermanager.serversettingswrapper swrapper
)

Sets the server settings. This API returns an array of error messages, incase of any errors.

Output:
Parameters:
swrapper: CFIDE.adminapi._servermanager.serversettingswrapper, required, swrapper

setupAccessDatasource
setupAccessDatasource ( required thisdsn
)

Output:
Parameters:
thisdsn: any, required, thisdsn

setupODBCSocketDatasource
setupODBCSocketDatasource ( required ds
)

Output:
Parameters:
ds: any, required, ds

startAllGatewayInstances
remote struct startAllGatewayInstances (

)

Starts all the available gateway instances.Returns a struct containing the gwid as the key and either empty string/ encountered error message as value.

Output:

startGatewayInstance
remote string startGatewayInstance ( required string gwid
)

Starts the gateway instance. Returns an empty string if started successfully, else an error message when there is an exception.

Output:
Parameters:
gwid: string, required, gwid

stopAllGatewayInstances
remote struct stopAllGatewayInstances (

)

Stops all the available gateway instances.Returns a struct containing the gwid as the key and either empty string/ encountered error message as value.

Output:

stopGatewayInstance
remote string stopGatewayInstance ( required string gwid
)

Stops the gateway instance.Returns an empty string if stopped successfully, else an error message when there is an exception

Output:
Parameters:
gwid: string, required, gwid

verifyAdminRoles*
private void verifyAdminRoles (

)

Output:

verifyChartingSettings*
private array verifyChartingSettings ( required CFIDE.adminapi._servermanager.chartingsettingswrapper cparams
)

Verifies the charting settings

Output:
Parameters:
cparams: CFIDE.adminapi._servermanager.chartingsettingswrapper, required, cparams

verifyDatasources
remote struct verifyDatasources ( required array dsnarr
)

Verifies the datasources

Output:
Parameters:
dsnarr: array, required, dsnarr

verifyMailSettings*
private array verifyMailSettings ( required CFIDE.adminapi._servermanager.mailsettingswrapper mparams
)

Verifies the mail server settings and returns an array of errors, if any

Output:
Parameters:
mparams: CFIDE.adminapi._servermanager.mailsettingswrapper, required, mparams

verifyMappings*
private array verifyMappings ( required CFIDE.adminapi._servermanager.mappingswrapper mapping
)

Verifies the mappings and returns an array of errors, if any

Output:
Parameters:
mapping: CFIDE.adminapi._servermanager.mappingswrapper, required, mapping

verifyMemoryVarParams*
private array verifyMemoryVarParams ( CFIDE.adminapi._servermanager.memoryvarswrapper memoryvarparams
)

Verifies the params required to set memory variables settings. This API returns an array of errors, incase there are errors with the parameters

Output:
Parameters:
memoryvarparams: CFIDE.adminapi._servermanager.memoryvarswrapper, optional, memoryvarparams

verifySchedulerWrapper*
private array verifySchedulerWrapper ( required CFIDE.adminapi._servermanager.schedulerwrapper swrapper
)

Verifies the schedulerwrapper object and returns an array of errors, if any

Output:
Parameters:
swrapper: CFIDE.adminapi._servermanager.schedulerwrapper, required, swrapper

viewLogFile
remote binary viewLogFile ( required string logfilename
)

Returns the log file content in the form of binary data.

Output:
Parameters:
logfilename: string, required, logfilename