debugging.cfc | <cfexecute>

CFIDE.adminapi.debugging
Component debugging (debugging)

Manages debug settings.

hierarchy:	WEB-INF.cftags.component CFIDE.adminapi.base CFIDE.adminapi.debugging
path:	{web-root}\CFIDE\adminapi\debugging.cfc
serializable:	Yes
properties:
methods:	addDebugEvent, deleteIP, getCurrentIP, getDebugProperty, getDebugRecordset, getIPList, getLineDebuggerPort, getLogProperty, getMaxDebuggingSessions, isLineDebuggerEnabled, isLineDebuggerRunning, restartLineDebugger, setDebugProperty, setIP, setLineDebuggerEnabled, setLineDebuggerPort, setLogProperty, setMaxDebuggingSessions, startLineDebugger, stopLineDebugger, validateIP*
inherited methods:	dump, getEdition, getInstallType, getJRunRootDir, isAdminUser, RDSInvoker, setJrunSN

* – 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.
getCurrentIP
`public getCurrentIP (` `)` Returns the IP address of the ColdFusion server. 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: 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
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: LogDirectory MaxFileSize MaxArchives LogScheduledTask LogCorbaCalls LogRequestTimeLimit logMailSeverity logMailSentMessages
getMaxDebuggingSessions
`numeric getMaxDebuggingSessions (` `)` Returns maximum simultaneous debugging sessions 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
restartLineDebugger
`void restartLineDebugger (` `)` Restarts CF line debugger 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: 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.
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
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: 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
startLineDebugger
`void startLineDebugger (` `)` Starts CF line debugger Output: suppressed
stopLineDebugger
`void stopLineDebugger (` `)` Stops CF line debugger 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.

Leave a Reply Cancel reply