public string getAppKey( )

Returns a clean AppKey.

Parameters:

Code:

	<cffunction name="getAppKey" access="public" returntype="string" output="false"
		hint="Returns a clean AppKey.">
		<cfreturn REReplace(MACHII_APP_KEY, "[[:punct:]|[:cntrl:]]", "", "all") />
	</cffunction> 

public AppManager getAppManager( )

Get the Mach-II AppManager. Not available until loadFramework has been called.

Parameters:

Code:

	<cffunction name="getAppManager" access="public" returntype="MachII.framework.AppManager" output="false"
		hint="Get the Mach-II AppManager. Not available until loadFramework has been called.">
		<cfreturn application[getAppKey()].appLoader.getAppManager() />
	</cffunction> 

public any getProperty( string propertyName, [any defaultValue=""] )

Returns the property value by name. If the property is not defined, and a default value is passed, it will be returned. If the property and a default value are both not defined then an exception is thrown. Not available until loadFramework() has been called.

Parameters:

string propertyName

[any defaultValue=""]

Code:

	<cffunction name="getProperty" access="public" returntype="any" output="false"
		hint="Returns the property value by name. If the property is not defined, and a default value is passed, it will be returned. If the property and a default value are both not defined then an exception is thrown. Not available until loadFramework() has been called.">
		<cfargument name="propertyName" type="string" required="true" />
		<cfargument name="defaultValue" type="any" required="false" default="" />
		<cfreturn getAppManager().getPropertyManager().getProperty(arguments.propertyName, arguments.defaultValue) />
	</cffunction> 

public void handleRequest( )

Handles a Mach-II request. Recommend to call in onRequestStart() event.

Parameters:

Code:

	<cffunction name="handleRequest" access="public" returntype="void" output="true"
		hint="Handles a Mach-II request. Recommend to call in onRequestStart() event.">

		<cfset var appKey = getAppKey() />
		
		
		<cfif StructKeyExists(request,"MachIIConfigMode")>
			<cfset MACHII_CONFIG_MODE = request.MachIIConfigMode />
		</cfif>
		
		
		<cfif NOT IsDefined("application.#appKey#.appLoader") OR NOT IsObject(application[appKey].appLoader)>
			<cflock name="application_#appKey#_reload" type="exclusive" timeout="#MACHII_ONLOAD_REQUEST_TIMEOUT#">
				<cfif NOT IsDefined("application.#appKey#.appLoader") OR NOT IsObject(application[appKey].appLoader)>
					<cfset loadFramework() />
				</cfif>
			</cflock>
		</cfif>

		
		<cfif MACHII_CONFIG_MODE EQ -1>
			
		<cfelseif MACHII_CONFIG_MODE EQ 1 AND NOT StructKeyExists(request, "MachIIReload")>
			<cflock name="application_#appKey#_reload" type="exclusive" timeout="#MACHII_ONLOAD_REQUEST_TIMEOUT#">
				<cfsetting requestTimeout="#MACHII_ONLOAD_REQUEST_TIMEOUT#" />
				<cfset application[appKey].appLoader.reloadConfig(MACHII_VALIDATE_XML) />
			</cflock>
		<cfelseif MACHII_CONFIG_MODE EQ 0 AND application[appKey].appLoader.shouldReloadBaseConfig()>
			<cflock name="application_#appKey#_reload" type="exclusive" timeout="#MACHII_ONLOAD_REQUEST_TIMEOUT#">
				<cfsetting requestTimeout="#MACHII_ONLOAD_REQUEST_TIMEOUT#" />
				<cfset application[appKey].appLoader.reloadConfig(MACHII_VALIDATE_XML) />
			</cflock>
		<cfelseif MACHII_CONFIG_MODE EQ 0 AND application[appKey].appLoader.shouldReloadModuleConfig()>
			<cflock name="application_#appKey#_reload" type="exclusive" timeout="#MACHII_ONLOAD_REQUEST_TIMEOUT#">
				<cfsetting requestTimeout="#MACHII_ONLOAD_REQUEST_TIMEOUT#" />
				<cfset application[appKey].appLoader.reloadModuleConfig(MACHII_VALIDATE_XML) />
			</cflock>
		</cfif>

		
		<cfset 	getAppManager().getRequestHandler().handleRequest() />
	</cffunction> 

public boolean isPropertyDefined( string propertyName )

Checks if property name is defined in the properties. Not available until loadFramework() has been called.

Parameters:

string propertyName

Code:

	<cffunction name="isPropertyDefined" access="public" returntype="boolean" output="false"
		hint="Checks if property name is defined in the properties. Not available until loadFramework() has been called.">
		<cfargument name="propertyName" type="string" required="true"/>
		<cfreturn getAppManager().getPropertyManager().isPropertyDefined(arguments.propertyName) />
	</cffunction> 

public void loadFramework( )

Loads the framework. Only call in onApplicationStart() event.

Parameters:

Code:

	<cffunction name="loadFramework" access="public" returntype="void" output="false"
		hint="Loads the framework. Only call in onApplicationStart() event.">
		
		<cfset var appKey = getAppKey() />
		
		
		<cfsetting requestTimeout="#MACHII_ONLOAD_REQUEST_TIMEOUT#" />
		
		
		<cfset application[appKey] = StructNew() />
		<cfset application[appKey].appLoader = CreateObject("component", "MachII.framework.AppLoader").init(MACHII_CONFIG_PATH, MACHII_DTD_PATH, AppKey, MACHII_VALIDATE_XML) />
		<cfset request.MachIIReload = FALSE />
	</cffunction> 

public boolean onApplicationStart( )

Run on the application start event. Override to provide customize functionality.

Parameters:

Code:

	<cffunction name="onApplicationStart" access="public" returntype="boolean" output="false"
		hint="Run on the application start event. Override to provide customize functionality.">
		
		<cfset LoadFramework() />
		
		<cfreturn TRUE />
	</cffunction> 

public void onRequestStart( string targetPage )

Handles Mach-II requests. Output must be set to true. Override to provide custom functionality.

Parameters:

string targetPage

Code:

	<cffunction name="onRequestStart" access="public" returntype="void" output="true"
		hint="Handles Mach-II requests. Output must be set to true. Override to provide custom functionality.">
		<cfargument name="targetPage" type="string" required="true" />

		
		<cfif FindNoCase("index.cfm", arguments.targetPage)>
			<cfset handleRequest() />
		</cfif>
	</cffunction> 

public void onSessionEnd( struct sessionScope, struct applicationScope )

Handles on session end event if sessions are enabled for this application.

Parameters:

struct sessionScope

struct applicationScope

Code:

	<cffunction name="onSessionEnd" access="public" returntype="void" output="false"
		hint="Handles on session end event if sessions are enabled for this application.">
		<cfargument name="sessionScope" type="struct" required="true" />
		<cfargument name="applicationScope" type="struct" required="true" />
			
		<cfset arguments.applicationScope[getAppKey()].appLoader.getAppManager().onSessionEnd(arguments.sessionScope) />
	</cffunction> 

public void onSessionStart( )

Handles on session start event if sessions are enabled for this application.

Parameters:

Code:

	<cffunction name="onSessionStart" access="public" returntype="void" output="false"
		hint="Handles on session start event if sessions are enabled for this application.">
		<cfset getAppManager().onSessionStart() />
	</cffunction> 

public void setProperty( string propertyName, any propertyValue )

Sets the property value by name. Not available until loadFramework() has been called.

Parameters:

string propertyName

any propertyValue

Code:

	<cffunction name="setProperty" access="public" returntype="void" output="false"
		hint="Sets the property value by name. Not available until loadFramework() has been called.">
		<cfargument name="propertyName" type="string" required="true" />
		<cfargument name="propertyValue" type="any" required="true" />
		<cfset getAppManager().getPropertyManager().setProperty(arguments.propertyName, arguments.propertyValue) />
	</cffunction> 

public boolean shouldReloadConfig( )

Returns if the config should be dynamically reloaded.

Parameters:

Code:

	<cffunction name="shouldReloadConfig" access="public" returntype="boolean" output="false"
		hint="Returns if the config should be dynamically reloaded.">
		<cfreturn application[getAppKey()].appLoader.shouldReloadConfig() />
	</cffunction>