public void configure( )

Configures the adapter. Override to provide custom functionality.

Parameters:

Code:

	<cffunction name="configure" access="public" returntype="void" output="false"
		hint="Configures the adapter. Override to provide custom functionality.">
		
	</cffunction> 

public void debug( string channel, string message, [any additionalInformation] )

Logs a message with debug log level.

Parameters:

string channel

string message

[any additionalInformation]

Code:

	<cffunction name="debug" access="public" returntype="void" output="false"
		hint="Logs a message with debug log level.">
		<cfargument name="channel" type="string" required="true" />
		<cfargument name="message" type="string" required="true" />
		<cfargument name="additionalInformation" type="any" required="false" />
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction> 

public void error( string channel, string message, [any additionalInformation] )

Logs a message with error log level.

Parameters:

string channel

string message

[any additionalInformation]

Code:

	<cffunction name="error" access="public" returntype="void" output="false"
		hint="Logs a message with error log level.">
		<cfargument name="channel" type="string" required="true" />
		<cfargument name="message" type="string" required="true" />
		<cfargument name="additionalInformation" type="any" required="false" />
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction> 

public void fatal( string channel, string message, [any additionalInformation] )

Logs a message with fatal log level.

Parameters:

string channel

string message

[any additionalInformation]

Code:

	<cffunction name="fatal" access="public" returntype="void" output="false"
		hint="Logs a message with fatal log level.">
		<cfargument name="channel" type="string" required="true" />
		<cfargument name="message" type="string" required="true" />
		<cfargument name="additionalInformation" type="any" required="false" />
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction> 

public struct getConfigurationData( )

Gets the configuration data for this logging adapter.

Parameters:

Code:

	<cffunction name="getConfigurationData" access="public" returntype="struct" output="false"
		hint="Gets the configuration data for this logging adapter.">
				
		<cfreturn variables.instance />
	</cffunction> 

public AbstractFilter getFilter( )

Gets the filter.

Parameters:

Code:

	<cffunction name="getFilter" access="public" returntype="MachII.logging.filters.AbstractFilter" output="false"
		hint="Gets the filter.">
		<cfreturn variables.filter />
	</cffunction> 

public boolean getLoggingEnabled( )

Gets the logging enabled.

Parameters:

Code:

	<cffunction name="getLoggingEnabled" access="public" returntype="boolean" output="false"
		hint="Gets the logging enabled.">
		<cfreturn variables.instance.loggingEnabled />
	</cffunction> 

public string getLoggingLevel( )

Returns the logging level by name. Required for Dashboard integration.

Parameters:

Code:

	<cffunction name="getLoggingLevel" access="public" returntype="string" output="false"
		hint="Returns the logging level by name. Required for Dashboard integration.">
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction> 

public any getParameter( string name, [any defaultValue=""] )

Gets a configuration parameter value, or a default value if not defined.

Parameters:

string name

[any defaultValue=""]

Code:

	<cffunction name="getParameter" access="public" returntype="any" output="false"
		hint="Gets a configuration parameter value, or a default value if not defined.">
		<cfargument name="name" type="string" required="true"
			hint="The parameter name." />
		<cfargument name="defaultValue" type="any" required="false" default=""
			hint="The default value to return if the parameter is not defined. Defaults to a blank string." />
		<cfif isParameterDefined(arguments.name)>
			<cfreturn variables.parameters[arguments.name] />
		<cfelse>
			<cfreturn arguments.defaultValue />
		</cfif>
	</cffunction> 

public struct getParameters( )

Gets the full set of configuration parameters for the component.

Parameters:

Code:

	<cffunction name="getParameters" access="public" returntype="struct" output="false"
		hint="Gets the full set of configuration parameters for the component.">
		<cfreturn variables.parameters />
	</cffunction> 

public void info( string channel, string message, [any additionalInformation] )

Logs a message with info log level.

Parameters:

string channel

string message

[any additionalInformation]

Code:

	<cffunction name="info" access="public" returntype="void" output="false"
		hint="Logs a message with info log level.">
		<cfargument name="channel" type="string" required="true" />
		<cfargument name="message" type="string" required="true" />
		<cfargument name="additionalInformation" type="any" required="false" />
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction> 

public AbstractLogAdapter init( struct parameters )

Initializes the logging adapter. Do not override.

Parameters:

struct parameters

Code:

	<cffunction name="init" access="public" returntype="AbstractLogAdapter" output="false"
		hint="Initializes the logging adapter. Do not override.">
		<cfargument name="parameters" type="struct" required="true" />
		
		<cfset setParameters(arguments.parameters) />
		
		<cfreturn this />
	</cffunction> 

public boolean isDebugEnabled( )

Checks if debug level logging is enabled.

Parameters:

Code:

	<cffunction name="isDebugEnabled" access="public" returntype="boolean" output="false"
		hint="Checks if debug level logging is enabled.">
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction> 

public boolean isErrorEnabled( )

Checks if error level logging is enabled.

Parameters:

Code:

	<cffunction name="isErrorEnabled" access="public" returntype="boolean" output="false"
		hint="Checks if error level logging is enabled.">
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction> 

public boolean isFatalEnabled( )

Checks if fatal level logging is enabled.

Parameters:

Code:

	<cffunction name="isFatalEnabled" access="public" returntype="boolean" output="false"
		hint="Checks if fatal level logging is enabled.">
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction> 

public boolean isFilterDefined( )

Checks if a filter has been defined for this adapter.

Parameters:

Code:

	<cffunction name="isFilterDefined" access="public" returntype="boolean" output="false"
		hint="Checks if a filter has been defined for this adapter.">
		<cfreturn IsObject(variables.filter) />
	</cffunction> 

public boolean isInfoEnabled( )

Checks if info level logging is enabled.

Parameters:

Code:

	<cffunction name="isInfoEnabled" access="public" returntype="boolean" output="false"
		hint="Checks if info level logging is enabled.">
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction> 

public boolean isParameterDefined( string name )

Checks to see whether or not a configuration parameter is defined.

Parameters:

string name

Code:

	<cffunction name="isParameterDefined" access="public" returntype="boolean" output="false"
		hint="Checks to see whether or not a configuration parameter is defined.">
		<cfargument name="name" type="string" required="true"
			hint="The parameter name." />
		<cfreturn StructKeyExists(variables.parameters, arguments.name) />
	</cffunction> 

public boolean isTraceEnabled( )

Checks if trace level logging is enabled.

Parameters:

Code:

	<cffunction name="isTraceEnabled" access="public" returntype="boolean" output="false"
		hint="Checks if trace level logging is enabled.">
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction> 

public boolean isWarnEnabled( )

Checks if warn level logging is enabled.

Parameters:

Code:

	<cffunction name="isWarnEnabled" access="public" returntype="boolean" output="false"
		hint="Checks if warn level logging is enabled.">
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction> 

public void setFilter( AbstractFilter filter )

Sets the filter.

Parameters:

AbstractFilter filter

Code:

	<cffunction name="setFilter" access="public" returntype="void" output="false"
		hint="Sets the filter.">
		<cfargument name="filter" type="MachII.logging.filters.AbstractFilter" required="true" />
		<cfset variables.filter = arguments.filter />
	</cffunction> 

public void setLoggingEnabled( boolean loggingEnabled )

Sets the logging enabled.

Parameters:

boolean loggingEnabled

Code:

	<cffunction name="setLoggingEnabled" access="public" returntype="void" output="false"
		hint="Sets the logging enabled.">
		<cfargument name="loggingEnabled" type="boolean" required="true" />
		<cfset variables.instance.loggingEnabled = arguments.loggingEnabled />
	</cffunction> 

public string setLoggingLevel( string loggingLevelName )

Returns the logging level by name. Required for Dashboard integration.

Parameters:

string loggingLevelName

Code:

	<cffunction name="setLoggingLevel" access="public" returntype="string" output="false"
		hint="Returns the logging level by name. Required for Dashboard integration.">
		<cfargument name="loggingLevelName" type="string" required="true"
			hint="Accepts 'trace', 'debug', 'info', 'warn', 'error', 'fatal', 'all' or 'off'." />
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction> 

public void setParameter( string name, any value )

Sets a configuration parameter.

Parameters:

string name

any value

Code:

	<cffunction name="setParameter" access="public" returntype="void" output="false"
		hint="Sets a configuration parameter.">
		<cfargument name="name" type="string" required="true"
			hint="The parameter name." />
		<cfargument name="value" type="any" required="true"
			hint="The parameter value." />
		<cfset variables.parameters[arguments.name] = arguments.value />
	</cffunction> 

public void setParameters( struct parameters )

Sets the full set of configuration parameters for the component.

Parameters:

struct parameters

Code:

	<cffunction name="setParameters" access="public" returntype="void" output="false"
		hint="Sets the full set of configuration parameters for the component.">
		<cfargument name="parameters" type="struct" required="true" />
		
		<cfset var key = "" />
		
		<cfloop collection="#arguments.parameters#" item="key">
			<cfset setParameter(key, arguments.parameters[key]) />
		</cfloop>
	</cffunction> 

public void trace( string channel, string message, [any additionalInformation] )

Logs a message with trace log level.

Parameters:

string channel

string message

[any additionalInformation]

Code:

	<cffunction name="trace" access="public" returntype="void" output="false"
		hint="Logs a message with trace log level.">
		<cfargument name="channel" type="string" required="true" />
		<cfargument name="message" type="string" required="true" />
		<cfargument name="additionalInformation" type="any" required="false" />
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction> 

public void warn( string channel, string message, [any additionalInformation] )

Logs a message with warn log level.

Parameters:

string channel

string message

[any additionalInformation]

Code:

	<cffunction name="warn" access="public" returntype="void" output="false"
		hint="Logs a message with warn log level.">
		<cfargument name="channel" type="string" required="true" />
		<cfargument name="message" type="string" required="true" />
		<cfargument name="additionalInformation" type="any" required="false" />
		<cfabort showerror="This method is abstract and must be overrided." />
	</cffunction>