Create your own Event Gateway type - getrailo/railo GitHub Wiki
|
|
You should read the page about Event Gateways in Railo first.
Here you will find a short introduction into writing your own Event Gateway type. Since you can write these in pure cfml (and java when you want it), it is really simple to do.
There are 2 to 3 files you need to create:
- the Gateway cfc
- the Gateway Driver cfc
- A listener cfc
This is the file which contains the action you want your gateway to do. Also, it is the file which is instantiated by Railo when the gateway starts.
You can take the following files as an example:
- {Railo-install}/lib/railo-server/context/gateway/railo/extension/gateway/DirectoryWatcher.cfc
- {Railo-install}/lib/railo-server/context/gateway/railo/extension/gateway/MailWatcher.cfc
The example code shown underneath is a modified version of the DirectoryWatcher.cfc, which, at time of writing, is in line for reviewing at the Railo team.
By default, you need to have the following functions:
- An init function, which receives the necessary config data.
- A start function, which continues to run while variables.state="running".
- A stop and restart function
- A getState function, which returns the current state of the gateway instance (running,stopping,stopped)
- A sendMessage function, which will be called when the CFML sendGatewayMessage function is used.
The following is all the code you need:
<cfcomponent output="no"><strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> variables.logFileName = <span style="color:#2A00FF; ">"DirectoryWatcher"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> variables.state=<span style="color:#2A00FF; ">"stopped"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"init"</span> access=<span style="color:#2A00FF; ">"public"</span> output=<span style="color:#2A00FF; ">"no"</span> returntype=<span style="color:#2A00FF; ">"void"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfargument</span></strong> name=<span style="color:#2A00FF; ">"id"</span> required=<span style="color:#2A00FF; ">"true"</span> type=<span style="color:#2A00FF; ">"string"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfargument</span></strong> name=<span style="color:#2A00FF; ">"config"</span> required=<span style="color:#2A00FF; ">"true"</span> type=<span style="color:#2A00FF; ">"struct"</span> <span style="color:#7F0055; font-weight: bold; ">default</span>=<span style="color:#2A00FF; ">"#structNew()#"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfargument</span></strong> name=<span style="color:#2A00FF; ">"listener"</span> required=<span style="color:#2A00FF; ">"true"</span> type=<span style="color:#2A00FF; ">"component"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> <span style="color:#7F0055; font-weight: bold; ">var</span> cfcatch = <span style="color:#2A00FF; ">""</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cftry></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> variables.id=id <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> variables.config=config <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> variables.listener=listener <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cflog</span></strong> text=<span style="color:#2A00FF; ">"init"</span> type=<span style="color:#2A00FF; ">"information"</span> file=<span style="color:#2A00FF; ">"#variables.logFileName#"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfcatch></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> _handleError(cfcatch, <span style="color:#2A00FF; ">"init"</span>) <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cfcatch></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "></cftry></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"start"</span> access=<span style="color:#2A00FF; ">"public"</span> output=<span style="color:#2A00FF; ">"no"</span> returntype=<span style="color:#2A00FF; ">"void"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> <span style="color:#7F0055; font-weight: bold; ">var</span> sleepStep = iif(variables.config.interval <span style="color:#7F0055; font-weight: bold; ">lt</span> 500, <span style="color:#2A00FF; ">'variables.config.interval'</span>, de(500)) <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> <span style="color:#7F0055; font-weight: bold; ">var</span> i=-1 <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> <span style="color:#7F0055; font-weight: bold; ">var</span> cfcatch = <span style="color:#2A00FF; ">""</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <span style="color:#3F7F5F; "><--- when restart() is called, we enter this loop untill the previous execution has ended. ---></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfwhile</span></strong> variables.state EQ <span style="color:#2A00FF; ">"stopping"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> sleep(10)<span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "></cfwhile></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> variables.state = <span style="color:#2A00FF; ">"running"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cflog</span></strong> text=<span style="color:#2A00FF; ">"start"</span> type=<span style="color:#2A00FF; ">"information"</span> file=<span style="color:#2A00FF; ">"#variables.logFileName#"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfwhile</span></strong> variables.state EQ <span style="color:#2A00FF; ">"running"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cftry></span></strong> <span style="color:#3F7F5F; "><--- YOUR GATEWAY ACTIONS HERE ---></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfcatch></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> _handleError(cfcatch, <span style="color:#2A00FF; ">"start"</span>) <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cfcatch></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "></cftry></span></strong> <span style="color:#3F7F5F; "><--- sleep untill the next run, but cut it into half seconds, so we can stop the gateway easily ---></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfloop</span></strong> from=<span style="color:#2A00FF; ">"#sleepStep#"</span> to=<span style="color:#2A00FF; ">"#variables.config.interval#"</span> step=<span style="color:#2A00FF; ">"#sleepStep#"</span> index=<span style="color:#2A00FF; ">"i"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> sleep(sleepStep) <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfif</span></strong> variables.state <span style="color:#7F0055; font-weight: bold; ">neq</span> <span style="color:#2A00FF; ">"running"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfbreak</span></strong> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cfif></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "></cfloop></span></strong> <span style="color:#3F7F5F; "><--- some extra sleeping if the requested timeout is not yet completely done ---></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfif</span></strong> variables.config.interval mod sleepStep and variables.state <span style="color:#7F0055; font-weight: bold; ">eq</span> <span style="color:#2A00FF; ">"running"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> sleep((variables.config.interval mod sleepStep)) <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cfif></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "></cfwhile></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> variables.state=<span style="color:#2A00FF; ">"stopped"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"stop"</span> access=<span style="color:#2A00FF; ">"public"</span> output=<span style="color:#2A00FF; ">"no"</span> returntype=<span style="color:#2A00FF; ">"void"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cflog</span></strong> text=<span style="color:#2A00FF; ">"stop"</span> type=<span style="color:#2A00FF; ">"information"</span> file=<span style="color:#2A00FF; ">"#variables.logFileName#"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> variables.state=<span style="color:#2A00FF; ">"stopping"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"restart"</span> access=<span style="color:#2A00FF; ">"public"</span> output=<span style="color:#2A00FF; ">"no"</span> returntype=<span style="color:#2A00FF; ">"void"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfif</span></strong> variables.state EQ <span style="color:#2A00FF; ">"running"</span><span style="color:#7F0055; font-weight: bold; ">></span><strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> stop()<span style="color:#7F0055; font-weight: bold; ">></span><strong><span style="color:#7F0055; font-weight: bold; "></cfif></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> start()<span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"getState"</span> access=<span style="color:#2A00FF; ">"public"</span> output=<span style="color:#2A00FF; ">"no"</span> returntype=<span style="color:#2A00FF; ">"string"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfreturn</span></strong> variables.state <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"sendMessage"</span> access=<span style="color:#2A00FF; ">"public"</span> output=<span style="color:#2A00FF; ">"no"</span> returntype=<span style="color:#2A00FF; ">"string"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfargument</span></strong> name=<span style="color:#2A00FF; ">"data"</span> required=<span style="color:#2A00FF; ">"false"</span> type=<span style="color:#2A00FF; ">"struct"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfreturn</span></strong> <span style="color:#2A00FF; ">"ERROR: sendMessage not supported"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"_handleError"</span> returntype=<span style="color:#2A00FF; ">"void"</span> access=<span style="color:#2A00FF; ">"private"</span> output=<span style="color:#2A00FF; ">"no"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfargument</span></strong> name=<span style="color:#2A00FF; ">"catchData"</span> required=<span style="color:#2A00FF; ">"yes"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfargument</span></strong> name=<span style="color:#2A00FF; ">"functionName"</span> type=<span style="color:#2A00FF; ">"string"</span> required=<span style="color:#2A00FF; ">"no"</span> <span style="color:#7F0055; font-weight: bold; ">default</span>=<span style="color:#2A00FF; ">"unknown"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cflog</span></strong> text=<span style="color:#2A00FF; ">"Function #arguments.functionName#: #arguments.catchData.message# #arguments.catchData.detail#"</span> type=<span style="color:#2A00FF; ">"error"</span> file=<span style="color:#2A00FF; ">"#variables.logFileName#"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong></cfcomponent>
I guess you noticed the comment "YOUR GATEWAY ACTIONS HERE"? That's where you add the real functionality.
The driver is used to configure and define your Gateway. With it, you define the form fields in the Railo admin settings page for your gateway, and it makes sure that your gateway is listed as an available Gateway.
The Gateway Driver is a CFC file, which must be added into the directory {Railo-install}/lib/railo-server/context/admin/gdriver/
- getClass():string. Returns the java class name. If the gateway is Java based, then the java class has to implement the interface "org.opencfml.eventgateway.Gateway". If it is not java based, then this method must return an empty string or void.
- getCFCPath():string. Returns the cfc path, when the gateway is cfc based, If it is not cfc based, then this method must return an empty string or void.
- getLabel():string. The label (friendly name) of the gateway
- getDescription():string. The description of the gateway
- onBeforeUpdate(string cfcPath, string startupMode, struct custom):void. This method is invoked before the settings entered in the form are saved. This method can be used to validate the entered data.
- onBeforeError(cfcatch):void. Invoked before an error is thrown. Can be used to throw your own error, and/or do logging.
-
getListenerCfcMode():string. Can be one of the following:
- "none": no listener gets defined
- "required": defining a listener is required
- getListenerPath():string. The default location of a listener cfc. (only used when the listenerCfcMode is not "none")
<cfcomponent extends="Gateway" output="no"><span style="color:#3F7F5F; "><--- The form fields which will be shown when adding a gateway instance via the Railo admin ---></span> <span style="color:#3F7F5F; "><--- argument names (see file Gateway.cfc): displayName, name, defaultValue, required, description, type, values ---></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> variables.fields = array( field(<span style="color:#2A00FF; ">"Path to file"</span>, <span style="color:#2A00FF; ">"filepath"</span>, <span style="color:#2A00FF; ">""</span>, <span style="color:#7F0055; font-weight: bold; ">true</span>, <span style="color:#2A00FF; ">"The file you want to check the size for"</span>, <span style="color:#2A00FF; ">"text"</span>) , field(<span style="color:#2A00FF; ">"Minimum file size"</span>, <span style="color:#2A00FF; ">"minimalsize"</span>, <span style="color:#2A00FF; ">""</span>, <span style="color:#7F0055; font-weight: bold; ">true</span>, <span style="color:#2A00FF; ">"The minimum size of the file, in Bytes, before the Listener CFC is called"</span>, <span style="color:#2A00FF; ">"text"</span>) , field(<span style="color:#2A00FF; ">"Interval (ms)"</span>, <span style="color:#2A00FF; ">"interval"</span>, <span style="color:#2A00FF; ">"60000"</span>, <span style="color:#7F0055; font-weight: bold; ">true</span>, <span style="color:#2A00FF; ">"The interval between checks, in miliseconds"</span>, <span style="color:#2A00FF; ">"text"</span>) , field(<span style="color:#2A00FF; ">"CFC Listener Function name"</span>, <span style="color:#2A00FF; ">"listenerFunction"</span>, <span style="color:#2A00FF; ">"onChange"</span>, <span style="color:#7F0055; font-weight: bold; ">true</span>, <span style="color:#2A00FF; ">"Called when the file reaches the minimum file size"</span>, <span style="color:#2A00FF; ">"text"</span>) ) <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"getClass"</span> returntype=<span style="color:#2A00FF; ">"string"</span> output=<span style="color:#2A00FF; ">"no"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfreturn</span></strong> <span style="color:#2A00FF; ">""</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"getCFCPath"</span> returntype=<span style="color:#2A00FF; ">"string"</span> output=<span style="color:#2A00FF; ">"no"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfreturn</span></strong> <span style="color:#2A00FF; ">"filesizechecker.FileSizeWatcher"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"getLabel"</span> returntype=<span style="color:#2A00FF; ">"string"</span> output=<span style="color:#2A00FF; ">"no"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfreturn</span></strong> <span style="color:#2A00FF; ">"Filesize Watcher"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"getDescription"</span> returntype=<span style="color:#2A00FF; ">"string"</span> output=<span style="color:#2A00FF; ">"no"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfreturn</span></strong> <span style="color:#2A00FF; ">"Watches the filesize of a certain file"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"onBeforeUpdate"</span> returntype=<span style="color:#2A00FF; ">"void"</span> output=<span style="color:#2A00FF; ">"false"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfargument</span></strong> name=<span style="color:#2A00FF; ">"cfcPath"</span> required=<span style="color:#2A00FF; ">"true"</span> type=<span style="color:#2A00FF; ">"string"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfargument</span></strong> name=<span style="color:#2A00FF; ">"startupMode"</span> required=<span style="color:#2A00FF; ">"true"</span> type=<span style="color:#2A00FF; ">"string"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfargument</span></strong> name=<span style="color:#2A00FF; ">"custom"</span> required=<span style="color:#2A00FF; ">"true"</span> type=<span style="color:#2A00FF; ">"struct"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> <span style="color:#7F0055; font-weight: bold; ">var</span> errors = [] <span style="color:#7F0055; font-weight: bold; ">/></span> <span style="color:#3F7F5F; "><--- does gven file exist? ---></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfif</span></strong> <span style="color:#7F0055; font-weight: bold; ">not</span> fileExists(arguments.custom.filepath)<span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> arrayAppend(errors, <span style="color:#2A00FF; ">"The file [#arguments.custom.filepath#] does not exist"</span>) <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cfif></span></strong> <span style="color:#3F7F5F; "><--- interval ---></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfif</span></strong> <span style="color:#7F0055; font-weight: bold; ">not</span> IsNumeric(custom.interval) or custom.interval LT 1 or int(custom.interval) <span style="color:#7F0055; font-weight: bold; ">neq</span> custom.interval<span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> arrayAppend(errors, <span style="color:#2A00FF; ">"The interval [#custom.interval#] must be a numeric value greater than 0"</span>) <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cfif></span></strong> <span style="color:#3F7F5F; "><--- minimalsize ---></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfif</span></strong> <span style="color:#7F0055; font-weight: bold; ">not</span> IsNumeric(custom.minimalsize) or custom.minimalsize LT 1 or int(custom.minimalsize) <span style="color:#7F0055; font-weight: bold; ">neq</span> custom.minimalsize<span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> arrayAppend(errors, <span style="color:#2A00FF; ">"The Minimum file size [#custom.minimalsize#] must be a numeric value greater than 0"</span>) <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cfif></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cfif</span></strong> arrayLen(errors)<span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfthrow</span></strong> message=<span style="color:#2A00FF; ">"The following error(s) occured while validating your input: <ul><li>#arrayToList(errors, '</li><li>')#</li></ul>"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cfif></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"getListenerCfcMode"</span> returntype=<span style="color:#2A00FF; ">"string"</span> output=<span style="color:#2A00FF; ">"no"</span> hint=<span style="color:#2A00FF; ">"Returns either 'none' or 'required'"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfreturn</span></strong> <span style="color:#2A00FF; ">"required"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"getListenerPath"</span> returntype=<span style="color:#2A00FF; ">"string"</span> output=<span style="color:#2A00FF; ">"no"</span> hint=<span style="color:#2A00FF; ">"Returns the path to the default Listener cfc"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfreturn</span></strong> <span style="color:#2A00FF; ">"filesizechecker.FileBackuper"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong></cfcomponent>
Also see the file Gateway.cfc, which extends the functionality of this example (<cfcomponent extends="Gateway">)
Most gateways need a Listener CFC to respond to events occuring in the Gateway instance. For example, if the Mail watcher finds new email in the mailbox, then it needs to do something with that event; it calls a method (function) of the Listener CFC. The path to your listener CFC must be given as an argument when you create or update a gateway instance. The contents of the CFC is completely up to you, as long as it has a public function that can be called by the Gateway.
Let's say our Gateway type to create is a "filesize checker", which checks a file for a minimum filesize. If the file's size has the minimum filesize, then we will call the listener CFC. First, we'll create the listener CFC:
<cfcomponent output="no"> <cfset variables.logFileName = "BigFileBackup" /><strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"onBigFilesize"</span> access=<span style="color:#2A00FF; ">"public"</span> output=<span style="color:#2A00FF; ">"no"</span> returntype=<span style="color:#2A00FF; ">"void"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfargument</span></strong> name=<span style="color:#2A00FF; ">"filepath"</span> required=<span style="color:#2A00FF; ">"true"</span> type=<span style="color:#2A00FF; ">"string"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfargument</span></strong> name=<span style="color:#2A00FF; ">"size"</span> required=<span style="color:#2A00FF; ">"true"</span> type=<span style="color:#2A00FF; ">"numeric"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <span style="color:#3F7F5F; "><--- create a non-existing zipfile path---></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> <span style="color:#7F0055; font-weight: bold; ">var</span> zipFileName = arguments.filepath & <span style="color:#2A00FF; ">".zip"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> <span style="color:#7F0055; font-weight: bold; ">var</span> nr=1 <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfwhile</span></strong> fileExists(zipFileName)<span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> zipFileName = arguments.filepath & <span style="color:#2A00FF; ">".#nr#.zip"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> ++nr <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cfwhile></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cftry></span></strong> <span style="color:#3F7F5F; "><--- zip the file ---></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfzip</span></strong> action=<span style="color:#2A00FF; ">"zip"</span> source=<span style="color:#2A00FF; ">"#arguments.filepath#"</span> file=<span style="color:#2A00FF; ">"#zipFileName#"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <span style="color:#3F7F5F; "><--- log the zip action ---></span> <strong><span style="color:#7F0055; font-weight: bold; "><cflog</span></strong> text=<span style="color:#2A00FF; ">"Backed up #arguments.filepath# to #zipFileName#"</span> type=<span style="color:#2A00FF; ">"information"</span> file=<span style="color:#2A00FF; ">"#variables.logFileName#"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <span style="color:#3F7F5F; "><--- now delete the file ---></span> <strong><span style="color:#7F0055; font-weight: bold; "><cffile</span></strong> action=<span style="color:#2A00FF; ">"delete"</span> file=<span style="color:#2A00FF; ">"#arguments.filepath#"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfcatch></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cfset</span></strong> _handleError(cfcatch, <span style="color:#2A00FF; ">"onBigFilesize"</span>) <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cfcatch></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "></cftry></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong> <strong><span style="color:#7F0055; font-weight: bold; "><cffunction</span></strong> name=<span style="color:#2A00FF; ">"_handleError"</span> returntype=<span style="color:#2A00FF; ">"void"</span> access=<span style="color:#2A00FF; ">"private"</span> output=<span style="color:#2A00FF; ">"no"</span><span style="color:#7F0055; font-weight: bold; ">></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfargument</span></strong> name=<span style="color:#2A00FF; ">"catchData"</span> required=<span style="color:#2A00FF; ">"yes"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cfargument</span></strong> name=<span style="color:#2A00FF; ">"functionName"</span> type=<span style="color:#2A00FF; ">"string"</span> required=<span style="color:#2A00FF; ">"no"</span> <span style="color:#7F0055; font-weight: bold; ">default</span>=<span style="color:#2A00FF; ">"unknown"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "><cflog</span></strong> text=<span style="color:#2A00FF; ">"Function #arguments.functionName#: #arguments.catchData.message# #arguments.catchData.detail#"</span> type=<span style="color:#2A00FF; ">"error"</span> file=<span style="color:#2A00FF; ">"#variables.logFileName#"</span> <span style="color:#7F0055; font-weight: bold; ">/></span> <strong><span style="color:#7F0055; font-weight: bold; "></cffunction></span></strong></cfcomponent>
We will save the file as {Railo-install}/lib/railo-server/context/gateway/filesizechecker/FileBackuper.cfc
Now we will add the "file size check" functionality into our gateway cfc. We'll replace "YOUR GATEWAY ACTIONS HERE" with the following:
<cfset var qFile = "" /> <--- get the file's size by using cfdirectory ---> <cfdirectory action="list" directory="#getDirectoryFromPath(variables.config.filepath)#" filter="#getFileFromPath(variables.config.filepath)#" name="qFile" /><--- call the listener CFC if the file size meets the minimum requirement ---> <cfif qFile.recordcount and qFile.size gte variables.config.minimalsize> <cfset variables.listener[variables.config.listenerFunction]( qFile.directory & server.separator.file & qFile.name , qFile.size ) /> </cfif>
We will save the file as {Railo-install}/lib/railo-server/context/gateway/filesizechecker/FileSizeWatcher.cfc
Btw: the variables.listener and variables.config variables did not just come falling from the sky; instead, it was saved to the variables scope in the init() function.
Lastly, we need to create the Gateway driver. We can use the Gateway driver code which was shown before, and then save it as {Railo-install}/lib/railo-server/context/admin/gdriver/FileSizeWatcher.cfc
Now we are almost good to go! We do need to restart Railo to have it pick up the new Gateway driver. So just go to the server admin, click on the menu-item "Restart", and then hit the "Restart Railo" button.
We can add an instance of our new Gateway type now! You can do it by using cfadmin like this:
<cfadmin action="updateGatewayEntry" type="server" password="server-admin-password" startupMode="automatic" id="zipLargeLogFiles" class="" cfcpath="filesizechecker.FileSizeWatcher" listenerCfcPath="filesizechecker.FileBackuper" custom='#{ filepath = "C:/mysite/logs/failedlogins.log" , listenerFunction = "onBigFilesize" , minimalsize = 100000 , interval = 60000 }#' readOnly=false />
Interval: time in milliseconds to wait between each check Minimalsize: the minimum filesize in bytes
But you can also go to the web or server Railo admin, and add it by going to the "Event gateways" menu item:
You will get the following settings screen, which we defined ourselves in the Gateway Driver cfc file:
After executing the cfadmin code, or going through the admin screens, you should now have an instance of your own Event Gateway type running!
When creating a Socket gateway or an Instant messaging gateway, you will need to do a bit more coding, but hopefully this instruction helped you out!