Component debugging

CFIDE.adminapi.debugging
Component debugging (debugging)

Manages debug settings.

hierarchy:	WEB-INF.cftags.component CFIDE.adminapi.base CFIDE.adminapi.debugging
path:	/opt/coldfusion/cfusion/wwwroot/CFIDE/adminapi/debugging.cfc
serializable:	Yes
properties:
final:	false
abstract:	false
methods:	addDebugEvent, deleteIP, disableLogging, disableRemoteInspection, disableWeinreAdvanceSettings, enableLogging, enableWeinreAdvanceSettings, getCurrentIP, getDebugProperty, getDebugRecordset, getIPList, getLineDebuggerPort, getLocalInspectionURL, getLocalIpAddressesList, getLocalWeinreIPAddress, getLocalWeinreServerDeathTimeOut, getLocalWeinreServerPort, getLocalWeinreServerReadTimeOut, getLogProperty, getMaxDebuggingSessions, getWeinreServerType, getWeinreServerUrl, isAdvanceSettingsEnabled, isDeveloperProfileEnabled, isLineDebuggerEnabled, isLineDebuggerRunning, isLocalWeinreServerAvailable, isRemoteInspectionEnabled, isWeinreServerRunning, restartLineDebugger, restartLocalWeinreServer, restartLocalWeinreServerOnFreePort, setDebugProperty, setDeveloperProfileEnabled, setIP, setLineDebuggerEnabled, setLineDebuggerPort, setLocalWeinreIpAddress, setLocalWeinreServerDeathTimeOut, setLocalWeinreServerPort, setLocalWeinreServerReadTimeOut, setLogProperty, setMaxDebuggingSessions, setRemoteInspectionEnabled, setWeinreServerlocation, setWeinreServerType, startLineDebugger, startLocalWeinreServer, startLocalWeinreServerOnFreePort, stopLineDebugger, stopLocalWeinreServer, store, storeRemoteInspectionUI, validateIP*
inherited methods:	dump, getEdition, getInstallType, isAdminUser, logaudit

* - private method

addDebugEvent
`public void addDebugEvent ( required string type, required string message, string priority="information", numeric startTime, numeric endTime, numeric total )` Adds a debug event to the debugging output. For an example of debugging events, refer to WEB-INF/debug/classic.cfm. Output: suppressed Parameters: type: string, required, type - Debugging event to add: SqlQuery ObjectQuery StoredProcedure Trace CFTimer LockWarning Exception message: string, required, message - Text to display along with the debug event. priority: string, optional, priority - Info, Warning, or Error. startTime: numeric, optional, startTime - Start time, if appropriate for your debug event (Tip: now().getTime() returns the numeric calue of the date time). endTime: numeric, optional, endTime - End time, if appropriate for your debug event (Tip: now().getTime() returns the numeric calue of the date time). total: numeric, optional, total - Number of milliseconds, if appropriate for your debug event.
deleteIP
`public void deleteIP ( required string debugip )` Removes an IP address from the debugging list. Output: suppressed Parameters: debugip: string, required, debugip - IP address to remove.
disableLogging
`void disableLogging ( required string logFileName )` Enable specific logging Output: suppressed Parameters: logFileName: string, required, logFileName
disableRemoteInspection
`void disableRemoteInspection ( )` Disables Remote inspection flag Output: suppressed
disableWeinreAdvanceSettings
`void disableWeinreAdvanceSettings ( )` Returns if remote inspection is running Output: suppressed
enableLogging
`void enableLogging ( required string logFileName )` Enable specific logging Output: suppressed Parameters: logFileName: string, required, logFileName
enableWeinreAdvanceSettings
`void enableWeinreAdvanceSettings ( )` Returns if remote inspection is running Output: suppressed
getCurrentIP
`public getCurrentIP ( )` Returns the IP address of the client. Output: suppressed
getDebugProperty
`public any getDebugProperty ( required propertyName )` Returns a specified debug property. To use this method, pass the desired property in the propertyName attribute. Output: suppressed Parameters: propertyName: any, required, propertyName - Retrieves a debug property. Valid Properties are: MAX_DEBUG_SESSIONS REMOTE_INSPECTION_ENABLED enableDebug enableRobustExceptions enableAJAXDebugging enablePerfMon enableCFStat debugTemplate templateExecutionTime templateHighlightMinimum templateModel showExecutionTime showGeneralInfo showDatabaseInfo showExceptionInfo showTrace showTimer showVariables showApplicationVariables showCGIVariables showClientVariables showCookieVariables showFlashFormCompileErrors showFormVariables showRequestVariables showSessionVariables showServerVariables showURLVariables
getDebugRecordset
`public query getDebugRecordset ( )` Returns debugger record set. Output: suppressed
getIPList
`public getIPList ( adminPassword="", adminPassword2="" )` Returns a list of IP addresses for which debugging is enabled. Output: suppressed Parameters: adminPassword: any, optional, adminPassword adminPassword2: any, optional, adminPassword2
getLineDebuggerPort
`numeric getLineDebuggerPort ( )` Returns JVM debug port Output: suppressed
getLocalInspectionURL
`string getLocalInspectionURL ( )` Returns the inspection url of weinre server Output: suppressed
getLocalIpAddressesList
`getLocalIpAddressesList ( )` Returns all the ip addresses of this machine Output: suppressed
getLocalWeinreIPAddress
`string getLocalWeinreIPAddress ( )` Returns the ipaddress on which the weinre server is running Output: suppressed
getLocalWeinreServerDeathTimeOut
`string getLocalWeinreServerDeathTimeOut ( )` Returns the Local Weinre Server Death Timeout Output: suppressed
getLocalWeinreServerPort
`string getLocalWeinreServerPort ( )` Returns the port on which the weinre server is running Output: suppressed
getLocalWeinreServerReadTimeOut
`string getLocalWeinreServerReadTimeOut ( )` Returns the Local Weinre Server Read Timeout Output: suppressed
getLogProperty
`public any getLogProperty ( required propertyName )` Returns a specified logging property. To use this method, pass the desired property in the propertyName attribute. Output: suppressed Parameters: propertyName: any, required, propertyName - Retrieves a logging property. Valid Properties are: pattern LogDirectory MaxFileSize MaxArchives LogScheduledTask LogCorbaCalls LogRequestTimeLimit logMailSeverity logMailSentMessages
getMaxDebuggingSessions
`numeric getMaxDebuggingSessions ( )` Returns maximum simultaneous debugging sessions Output: suppressed
getWeinreServerType
`string getWeinreServerType ( )` Gets the inspection type local or remote Output: suppressed
getWeinreServerUrl
`string getWeinreServerUrl ( )` Returns the inspection url of weinre server Output: suppressed
isAdvanceSettingsEnabled
`boolean isAdvanceSettingsEnabled ( )` Returns if remote inspection is running Output: suppressed
isDeveloperProfileEnabled
`boolean isDeveloperProfileEnabled ( )` Returns if developer profile is enabled in the server Output: suppressed
isLineDebuggerEnabled
`boolean isLineDebuggerEnabled ( )` Returns if line debugger is enabled in the server Output: suppressed
isLineDebuggerRunning
`boolean isLineDebuggerRunning ( )` Returns if line debugger running Output: suppressed
isLocalWeinreServerAvailable
`boolean isLocalWeinreServerAvailable ( )` Output: suppressed
isRemoteInspectionEnabled
`boolean isRemoteInspectionEnabled ( )` Returns if remote inspection is running Output: suppressed
isWeinreServerRunning
`boolean isWeinreServerRunning ( )` Output: suppressed
restartLineDebugger
`void restartLineDebugger ( )` Restarts CF line debugger Output: suppressed
restartLocalWeinreServer
`void restartLocalWeinreServer ( )` restarts the local weinre server Output: suppressed
restartLocalWeinreServerOnFreePort
`void restartLocalWeinreServerOnFreePort ( )` restarts the local weinre server Output: suppressed
setDebugProperty
`public void setDebugProperty ( required propertyName, required propertyValue )` Sets a specified debug property. To use this method, pass the property in the propertyName attribute and the associated value in the propertyValue attribute. Output: suppressed Parameters: propertyName: any, required, propertyName - Property to set. Valid Properties are: cfMetrics cfMetrics.pullFreq MAX_DEBUG_SESSIONS REMOTE_INSPECTION_ENABLED enableDebug enableRobustExceptions enableAJAXDebugging enablePerfMon enableCFStat debugTemplate templateExecutionTime templateHighlightMinimum templateModel showExecutionTime showGeneralInfo showDatabaseInfo showExceptionInfo showTrace showTimer showVariables showApplicationVariables showCGIVariables showClientVariables showCookieVariables showFlashFormCompileErrors showFormVariables showRequestVariables showSessionVariables showServerVariables showURLVariables propertyValue: any, required, propertyValue - Value for propertyName.
setDeveloperProfileEnabled
`void setDeveloperProfileEnabled ( boolean enabled="true" )` Enables or disables developer profile Output: suppressed Parameters: enabled: boolean, optional, enabled
setIP
`public void setIP ( required string debugip )` Sets a list of one or more IP addresses for which debugging is enabled. Output: suppressed Parameters: debugip: string, required, debugip - List of IP addresses.
setLineDebuggerEnabled
`void setLineDebuggerEnabled ( boolean enabled="true" )` Enables or disables line debugger Output: suppressed Parameters: enabled: boolean, optional, enabled
setLineDebuggerPort
`void setLineDebuggerPort ( required numeric portNumber )` Sets JVM debug port Output: suppressed Parameters: portNumber: numeric, required, portNumber
setLocalWeinreIpAddress
`void setLocalWeinreIpAddress ( required string ipAddress )` sets the local weinre ip address Output: suppressed Parameters: ipAddress: string, required, ipAddress
setLocalWeinreServerDeathTimeOut
`void setLocalWeinreServerDeathTimeOut ( required string deathTimeout )` sets the local weinre death timeout Output: suppressed Parameters: deathTimeout: string, required, deathTimeout
setLocalWeinreServerPort
`void setLocalWeinreServerPort ( required string port )` sets the local weinre port address Output: suppressed Parameters: port: string, required, port
setLocalWeinreServerReadTimeOut
`void setLocalWeinreServerReadTimeOut ( required string readTimeOut )` sets the local weinre read timeout Output: suppressed Parameters: readTimeOut: string, required, readTimeOut
setLogProperty
`public void setLogProperty ( required propertyName, required propertyValue )` Sets a specified logging property. To use this method, pass the property in the propertyName attribute and the associated value in the propertyValue attribute. Output: suppressed Parameters: propertyName: any, required, propertyName - Property to set. Valid Properties are: pattern LogDirectory MaxFileSize MaxArchives LogScheduledTask LogCorbaCalls LogRequestTimeLimit logMailSeverity logMailSentMessages propertyValue: any, required, propertyValue - Value for propertyName.
setMaxDebuggingSessions
`void setMaxDebuggingSessions ( required numeric maxSessions )` Sets maximum simultaneous debugging sessions Output: suppressed Parameters: maxSessions: numeric, required, maxSessions
setRemoteInspectionEnabled
`void setRemoteInspectionEnabled ( )` Enables remote inspection flag Output: suppressed
setWeinreServerlocation
`void setWeinreServerlocation ( required string weinreUrl )` Sets the weinre server url used in case of remote inspection Output: suppressed Parameters: weinreUrl: string, required, weinreUrl
setWeinreServerType
`void setWeinreServerType ( required string inspectionType )` Sets the inspection type to local or remote Output: suppressed Parameters: inspectionType: string, required, inspectionType
startLineDebugger
`void startLineDebugger ( )` Starts CF line debugger Output: suppressed
startLocalWeinreServer
`void startLocalWeinreServer ( )` starts the local weinre server if installed by coldfusion Output: suppressed
startLocalWeinreServerOnFreePort
`void startLocalWeinreServerOnFreePort ( )` starts the local weinre server if installed by coldfusion Output: suppressed
stopLineDebugger
`void stopLineDebugger ( )` Stops CF line debugger Output: suppressed
stopLocalWeinreServer
`void stopLocalWeinreServer ( )` stops the local weinre server if running Output: suppressed
store
`void store ( )` Output: suppressed
storeRemoteInspectionUI
`void storeRemoteInspectionUI ( )` Output: suppressed
validateIP*
`private boolean validateIP ( required debugip )` Ensures that a string contains a valid IP address. Output: suppressed Parameters: debugip: any, required, debugip - String to test.