Original file name as message property for File/FTP gateways

[derek.adams]

I have some code that adds the originating filename as a property on messages coming from file or FTP gateways. In our business case, we needed to be able to take the original filename, modify it with a timestamp and use that as the filename on an outgoing FTP. Our solution was an action that executes a chain of strategies on the incoming filename, passing the end result to a NotifyFTP action. The config looks like this...

<jbossesb parameterReloadSecs="5" xmlns="http://anonsvn.labs.jboss.com/labs/jbossesb/trunk/product/etc/schemas/xml/jbossesb-1.0.1.xsd">
 <providers>
 <jms-provider name="JBossMQ" connection-factory="ConnectionFactory" jndi-URL="localhost">
 <jms-bus busid="MyESBChannel">
 <jms-message-filter dest-name="queue/A" dest-type="QUEUE"/>
 </jms-bus>
 </jms-provider>
 <fs-provider name="MyFileProvider">
 <fs-bus busid="MyFileBus">
 <fs-message-filter directory="/temp" input-suffix=".esbdat" work-suffix=".esbInProcess" post-delete="true"
 post-directory="processed" post-suffix=".esbDone" error-delete="true" error-directory="processed" error-suffix=".esbERROR"/>
 </fs-bus>
 </fs-provider>
 <ftp-provider name="MyFtpProvider" hostname="localhost">
 <ftp-bus busid="MyFtpBus">
 <ftp-message-filter directory="/" username="anonymous" password="none" input-suffix=".esbdat" work-suffix=".esbInProcess"
 post-delete="true" post-directory="processed" post-suffix=".esbDone" error-delete="true" error-directory="processed"
 error-suffix=".esbERROR" passive="false" protocol="ftp"/>
 </ftp-bus>
 </ftp-provider>
 </providers>
 <services>
 <service category="FirstServiceESB" name="SimpleListener" description="Hello World">
 <listeners>
 <fs-listener name="InFromFile" busidref="MyFileBus" maxThreads="1" is-gateway="true" poll-frequency-seconds="3"/>
 <ftp-listener name="InFromFTP" busidref="MyFtpBus" maxThreads="1" is-gateway="true" poll-frequency-seconds="8"/>
 <jms-listener name="EsbListener" busidref="MyESBChannel" maxThreads="1" is-gateway="false"/>
 </listeners>
 <actions>
 <action name="BuildFilename" class="org.jboss.soa.esb.actions.naming.FileNameGeneratorAction">
 <property name="strategies" value="">
 <strategies>
 <strategy class="org.jboss.soa.esb.actions.naming.strategy.ChangeSuffixNamingStrategy" newSuffix="proc"/>
 <strategy class="org.jboss.soa.esb.actions.naming.strategy.AddTimestampNamingStrategy"/>
 </strategies>
 </property>
 </action>
 <action name="SendToFTP" class="org.jboss.soa.esb.actions.Notifier">
 <property name="okMethod" value="notifyOK"/>
 <property name="notification-details" value="">
 <NotificationList type="OK">
 <target class="NotifyFTP">
 <ftp URL="ftp://user:[e-mail]/home/user" filename="{org.jboss.soa.esb.naming.result}"/>
 </target>
 </NotificationList>
 </property>
 </action>
 </actions>
 </service>
 </services>
</jbossesb>

The FileNameGeneratorAction uses the message property for originating filename set in the gateway by default (can be changed via action props) and writes the result to a well-known message prop name. The NotifyFTP action picks up the result value and uses that as the filename it writes.

I figure that this may be helpful to other people with similar requirements, so I was wondering if I should check the code in. Alternatively, I can add a JIRA and attach the updates so people can take a look before it goes in the trunk.

Thanks,
Derek

[marklittle]

Have you looked at the filters approach we added the other week?

[marklittle]

BTW, add a JIRA task so we can track this (and it'll appear in the next release notes).

[derek.adams]

I checked out the filters code and I think it's a great idea. The only problem I had was that I couldn't get back to the actual file name that came off the file system or FTP server. It looked like the EPR reflected in the getFrom() method on Call was always the ESB-aware JMS one rather than the gateway itself, so the message props injected by the MetaDataFilter reflected that. I ended up adding code into AbstractFileGateway in the loop where messages are created from the file list since that is used by both file and FTP gateways. Was that the right place to put it?

I'll go ahead and create the JIRA task and wait up on checking in the code until I hear back.

[marklittle]

Have connectivity problems at JavaOne, so I'll have to double check the filter code and get back to you. But thanks for creating the issue so we don't lose it.

[derek.adams]

Here is the JIRA issue http://jira.jboss.com/jira/browse/JBESB-560

[mp_valle77]

Properties p= message.getProperties();

String fileName= p.getProperty("org.jboss.soa.esb.gateway.original.file.name").toString();