public void addMessageHandler( string messageName, MessageHandler messageHandler, [boolean overrideCheck="false"] )

Registers a Message Handler with the specified name.

Parameters:

string messageName

MessageHandler messageHandler

[boolean overrideCheck="false"]

Code:

	<cffunction name="addMessageHandler" access="public" returntype="void" output="false"
		hint="Registers a Message Handler with the specified name.">
		<cfargument name="messageName" type="string" required="true" />
		<cfargument name="messageHandler" type="MachII.framework.MessageHandler" required="true" />
		<cfargument name="overrideCheck" type="boolean" required="false" default="false" />
		
		<cfif NOT arguments.overrideCheck AND isMessageHandlerDefined(arguments.messageName)>
			<cfthrow type="MachII.framework.MessageHandlerAlreadyDefined"
				message="A message-subscriber with name '#arguments.messageName#' is already registered." />
		<cfelse>
			<cfset variables.messageHandlers[arguments.messageName] = arguments.messageHandler />
		</cfif>
	</cffunction> 

public void configure( )

Configures each of the registered message handlers.

Parameters:

Code:

	<cffunction name="configure" access="public" returntype="void" output="false"
		hint="Configures each of the registered message handlers.">

		<cfset var logFactory = getAppManager().getLogFactory() />
		<cfset var aMessageHandler = 0 />
		<cfset var i = 0 />

		<cfloop collection="#variables.messageHandlers#" item="i">
			<cfset aMessageHandler = variables.messageHandlers[i] />
			<cfset aMessageHandler.setLog(logFactory) />
		</cfloop>
	</cffunction> 

public AppManager getAppManager( )

Returns the AppManager instance this MessageManager belongs to.

Parameters:

Code:

	<cffunction name="getAppManager" access="public" returntype="MachII.framework.AppManager" output="false"
		hint="Returns the AppManager instance this MessageManager belongs to.">
		<cfreturn variables.appManager />
	</cffunction> 

public MessageHandler getMessageHandler( string messageName )

Gets a message handler with the specified name.

Parameters:

string messageName

Code:

	<cffunction name="getMessageHandler" access="public" returntype="MachII.framework.MessageHandler" output="false"
		hint="Gets a message handler with the specified name.">
		<cfargument name="messageName" type="string" required="true" />
		
		<cfif isMessageHandlerDefined(arguments.messageName)>
			<cfreturn variables.messageHandlers[arguments.messageName] />
		<cfelseif IsObject(getParent()) AND getParent().isMessageHandlerDefined(arguments.messageName)>
			<cfreturn getParent().getMessageHandler(arguments.messageName) />
		<cfelse>
			<cfthrow type="MachII.framework.MessageHandlerNotDefined" 
				message="A message-subscriber with name '#arguments.messageName#' is not defined."
				detail="Available Messages: '#ArrayToList(getMessageHandlerNames())#'" />
		</cfif>
	</cffunction> 

public array getMessageHandlerNames( )

Returns an array of message handler names.

Parameters:

Code:

	<cffunction name="getMessageHandlerNames" access="public" returntype="array" output="false"
		hint="Returns an array of message handler names.">
		<cfreturn StructKeyArray(variables.messageHandlers) />
	</cffunction> 

public any getParent( )

Returns the parent MessageManager instance this MessageManager belongs to. It will return empty string if no parent is defined.

Parameters:

Code:

	<cffunction name="getParent" access="public" returntype="any" output="false"
		hint="Returns the parent MessageManager instance this MessageManager belongs to. It will return empty string if no parent is defined.">
		<cfreturn variables.parentMessageManager />
	</cffunction> 

public ThreadingAdapter getThreadingAdapter( )

Gets a threading adapter.

Parameters:

Code:

	<cffunction name="getThreadingAdapter" access="public" returntype="MachII.util.threading.ThreadingAdapter" output="false"
		hint="Gets a threading adapter.">
		<cfreturn variables.threadingAdapter />
	</cffunction> 

public MessageManager init( AppManager appManager, [any parentMessageManager=""] )

Initialization function called by the framework.

Parameters:

AppManager appManager

[any parentMessageManager=""]

Code:

	<cffunction name="init" access="public" returntype="MessageManager" output="false"
		hint="Initialization function called by the framework.">
		<cfargument name="appManager" type="MachII.framework.AppManager" required="true" />
		<cfargument name="parentMessageManager" type="any" required="false" default=""
			hint="Optional argument for a parent message manager. If there isn't one, defaults to empty string." />	
		
		<cfset setAppManager(arguments.appManager) />
		<cfset setThreadingAdapter(getAppManager().getUtils().createThreadingAdapter()) />
		
		<cfif IsObject(arguments.parentMessageManager)>
			<cfset setParent(arguments.parentMessageManager) />
		</cfif>
		
		<cfreturn this />
	</cffunction> 

public boolean isMessageHandlerDefined( string messageName )

Returns true if a Message Handler is registered with the specified name. Does NOT check parent.

Parameters:

string messageName

Code:

	<cffunction name="isMessageHandlerDefined" access="public" returntype="boolean" output="false"
		hint="Returns true if a Message Handler is registered with the specified name. Does NOT check parent.">
		<cfargument name="messageName" type="string" required="true" />
		<cfreturn StructKeyExists(variables.messageHandlers, arguments.messageName) />
	</cffunction> 

public void loadXml( string configXML, [boolean override="false"] )

Loads message-subscriber xml into the manager.

Parameters:

string configXML

[boolean override="false"]

Code:

	<cffunction name="loadXml" access="public" returntype="void" output="false"
		hint="Loads message-subscriber xml into the manager.">
		<cfargument name="configXML" type="string" required="true" />
		<cfargument name="override" type="boolean" required="false" default="false" />

		<cfset var messageSubscribersNodes = ArrayNew(1) />
		<cfset var messageParams = "" />
		<cfset var messageName = "" />
		<cfset var messageMultithreaded = "" />
		<cfset var messageWaitForThreads = "" />
		<cfset var messageTimeout = "" />
		
		<cfset var subscriberNodes = ArrayNew(1) />
		<cfset var subscriberListenerName = "" />
		<cfset var subscriberListener = "" />
		<cfset var subscriberMethod = "" />
		<cfset var subscriberResultArg = "" />
		
		<cfset var messageHandler = "" />
		<cfset var messageSubscriber = "" />
		
		<cfset var hasParent = IsObject(getParent()) />
		<cfset var mapping = "" />
		<cfset var i = 0 />
		<cfset var j = 0 />

		
		<cfif NOT arguments.override>
			<cfset messageSubscribersNodes = XMLSearch(arguments.configXML, "mach-ii/message-subscribers/message") />
		<cfelse>
			<cfset messageSubscribersNodes = XMLSearch(arguments.configXML, ".//message-subscribers/message") />
		</cfif>
		
		
		<cfloop from="1" to="#ArrayLen(messageSubscribersNodes)#" index="i">
			<cfset messageName = messageSubscribersNodes[i].xmlAttributes["name"] />
			
			
			<cfif hasParent AND arguments.override AND StructKeyExists(messageSubscribersNodes[i].xmlAttributes, "overrideAction")>
				<cfif messageSubscribersNodes[i].xmlAttributes["overrideAction"] EQ "useParent">
					<cfset removeMessageHandler(messageName) />
				<cfelseif messageSubscribersNodes[i].xmlAttributes["overrideAction"] EQ "addFromParent">
					
					<cfif StructKeyExists(messageSubscribersNodes[i].xmlAttributes, "mapping")>
						<cfset mapping = messageSubscribersNodes[i].xmlAttributes["mapping"] />
					<cfelse>
						<cfset mapping = messageName />
					</cfif>
					
					
					<cfif NOT getParent().isMessageHandlerDefined(mapping)>
						<cfthrow type="MachII.framework.overrideMessageHandlerNotDefined"
							message="An message-subscriber named '#mapping#' cannot be found in the parent listener manager for the override named '#messageName#' in module '#getAppManager().getModuleName()#'." />
					</cfif>
					
					<cfset addMessageHandler(messageName, getParent().getMessageHandler(mapping), arguments.override) />
				</cfif>
			
			<cfelse>
				<cfif StructKeyExists(messageSubscribersNodes[i].xmlAttributes, "multithreaded")>
					<cfset messageMultithreaded = messageSubscribersNodes[i].xmlAttributes["multithreaded"] />
				<cfelse>
					<cfset messageMultithreaded = true />
				</cfif>
				
				<cfif StructKeyExists(messageSubscribersNodes[i].xmlAttributes, "waitForThreads")>
					<cfset messageWaitForThreads = messageSubscribersNodes[i].xmlAttributes["waitForThreads"] />
				<cfelse>
					<cfset messageWaitForThreads = true />
				</cfif>
				
				<cfif StructKeyExists(messageSubscribersNodes[i].xmlAttributes, "timeout")>
					<cfset messageTimeout = messageSubscribersNodes[i].xmlAttributes["timeout"] />
				<cfelse>
					<cfset messageTimeout = 0 />
				</cfif>
				
				
				<cfset messageHandler = CreateObject("component", "MachII.framework.MessageHandler").init(messageName, messageMultithreaded, messageWaitForThreads, messageTimeout, getThreadingAdapter()) />
								
				
				<cfif StructKeyExists(messageSubscribersNodes[i], "subscribe")>
					<cfset subscriberNodes = messageSubscribersNodes[i].xmlChildren />
					
					<cfloop from="1" to="#ArrayLen(subscriberNodes)#" index="j">
						<cfset subscriberListenerName = subscriberNodes[j].xmlAttributes["listener"] />
						<cfset subscriberMethod = subscriberNodes[j].xmlAttributes["method"] />

						<cfif StructKeyExists(subscriberNodes[j].xmlAttributes, "resultArg")>
							<cfset subscriberResultArg = subscriberNodes[j].xmlAttributes["resultArg"] />
						<cfelse>
							<cfset subscriberResultArg = "" />
						</cfif>
						
						<cfset subscriberListener = getAppManager().getListenerManager().getListener(subscriberListenerName) />
						
						<cfset messageSubscriber = CreateObject("component", "MachII.framework.MessageSubscriber").init(subscriberListenerName, subscriberListener, subscriberMethod, subscriberResultArg) />
						
						<cfset messageHandler.addMessageSubscriber(messageSubscriber) />
					</cfloop>
				</cfif>

				
				<cfset addMessageHandler(messageName, messageHandler, arguments.override) />
			</cfif>
		</cfloop>
	</cffunction> 

public void removeMessageHandler( string messageName )

Removes a Message Handler. Does NOT remove from a parent.

Parameters:

string messageName

Code:

	<cffunction name="removeMessageHandler" access="public" returntype="void" output="false"
		hint="Removes a Message Handler. Does NOT remove from a parent.">
		<cfargument name="messageName" type="string" required="true" />
		<cfset StructDelete(variables.messageHandlers, arguments.messageName, false) />
	</cffunction> 

public void setAppManager( AppManager appManager )

Sets the AppManager instance this MessageManager belongs to.

Parameters:

AppManager appManager

Code:

	<cffunction name="setAppManager" access="public" returntype="void" output="false"
		hint="Sets the AppManager instance this MessageManager belongs to.">
		<cfargument name="appManager" type="MachII.framework.AppManager" required="true" />
		<cfset variables.appManager = arguments.appManager />
	</cffunction> 

public void setParent( MessageManager parentMessageManager )

Sets the parent MessageManager instance this MessageManager belongs to.

Parameters:

MessageManager parentMessageManager

Code:

	<cffunction name="setParent" access="public" returntype="void" output="false"
		hint="Sets the parent MessageManager instance this MessageManager belongs to.">
		<cfargument name="parentMessageManager" type="MachII.framework.MessageManager" required="true" />
		<cfset variables.parentMessageManager = arguments.parentMessageManager />
	</cffunction> 

private void setThreadingAdapter( ThreadingAdapter threadingAdapter )

Sets a threading adapter.

Parameters:

ThreadingAdapter threadingAdapter

Code:

	<cffunction name="setThreadingAdapter" access="private" returntype="void" output="false"
		hint="Sets a threading adapter.">
		<cfargument name="threadingAdapter" type="MachII.util.threading.ThreadingAdapter" required="true" />
		<cfset variables.threadingAdapter = arguments.threadingAdapter />
	</cffunction>