nl.nn.adapterframework.extensions.xfb

Class XfbSender

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.extensions.xfb.XfbSender

All Implemented Interfaces:

IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class XfbSender
extends SenderWithParametersBase

Sender for transferring files using the XFB protocol. Assumes sender input is local filename.
Some comments from Richard Maddox (FTO) about UNIX File permissions:

In case of AIX or SUN systems we advise the following user and directory permissions:

SENDING CFT:
- App_user must have secondary group: xfbgw
- Folder should have ownership: app_user:xfbgw (owner:group)
- Folder should have access rights: 770 (rwx.rwx.---) so nobody other then app_user and group xfbgw can do something in this folder
- Folder should have SGID bit set so that all files what is copied to this folder get group ownership xfbgw
- send file must have rights 660 after putting the file in the send directory.

RECEIVING CFT:
- App_user (the application user of customer) should have secondary group: xfbgw
- Folder should have ownership: app_user:xfbgw (owner:group)
- Folder should have access rights: 770 (rwx.rwx.---) so nobody other then app_user and group xfbgw can do something in this folder
- Folder should have SGID bit set, so that all files what is copied to this folder get group ownership xfbgw

There are of course more solutions to get the job done, but this is the solution we can guarantee.

Since:

4.11

Author:

Jaco de Groot

Field Summary

Fields inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

parameterNamesMustBeUnique, paramList

Fields inherited from class nl.nn.adapterframework.senders.SenderBase

log

Constructor Summary

Constructors

Constructor and Description
XfbSender()

Method Summary

Modifier and Type	Method and Description
void	configure() configure() is called once at startup of the framework in the configure method of the owner of this sender.
String	getAppli()
boolean	getCopy()
String	getCopyPrefix()
String	getFlow()
String	getFt()
String	getNoname()
String	getScript()
SenderResult	sendMessage(Message message, PipeLineSession session) Send a message to some destination (as configured in the Sender object).
void	setAppli(String appli)
void	setCopy(boolean copy) When set to true, the file is copied before calling the XFB script.
void	setCopyPrefix(String copyPrefix) Prefix for the name of the copied or original filename.
void	setFlow(String flow)
void	setFt(String ft)
void	setNoname(String noname)
void	setScript(String script) Full pathname to the XFB script to be executed to transfer the file

Methods inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList

Methods inherited from class nl.nn.adapterframework.senders.SenderBase

close, createBean, getLogPrefix, getName, open, setApplicationContext, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nl.nn.adapterframework.core.ISender

close, isSynchronous, open, sendMessageOrThrow

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName, setName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Constructor Detail

XfbSender

public XfbSender()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from interface: ISender

configure() is called once at startup of the framework in the configure method of the owner of this sender. Purpose of this method is to check whether the static configuration of the sender is correct. As much as possible class-instantiating should take place in the configure() or open() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Overrides:

configure in class SenderWithParametersBase

Throws:

ConfigurationException

sendMessage

public SenderResult sendMessage(Message message,
                                PipeLineSession session)
                         throws SenderException,
                                TimeoutException

Description copied from interface: ISender

Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

The following table shows the difference between synchronous and a-synchronous senders:

	synchronous	a-synchronous
ISender.isSynchronous() returns	true	false
return value of sendMessage() is	the reply-message	the messageId of the message sent
the correlationID specified with sendMessage()	may be ignored	is sent with the message
a {link TimeOutException}	may be thrown if a timeout occurs waiting for a reply	should not be expected

Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Throws:

SenderException

TimeoutException

setScript

public void setScript(String script)

Full pathname to the XFB script to be executed to transfer the file

getScript

public String getScript()

setFt

public void setFt(String ft)

getFt

public String getFt()

setFlow

public void setFlow(String flow)

getFlow

public String getFlow()

setAppli

public void setAppli(String appli)

getAppli

public String getAppli()

setNoname

public void setNoname(String noname)

getNoname

public String getNoname()

setCopy

public void setCopy(boolean copy)

When set to true, the file is copied before calling the XFB script. Reasons to copy the file: - XFB will rename the file (prefix it with FXB_) and delete it. - On Linux the sticky bit (drwxrws--- wasadmin xfbgw) isn't honoured with a move (only with a copy) (on AIX the sticky bit works for both move and copy).

getCopy

public boolean getCopy()

setCopyPrefix

public void setCopyPrefix(String copyPrefix)

Prefix for the name of the copied or original filename. When the name of the original file starts with this prefix, it is removed. Otherwise this prefix is added to the filename of the copied file.

getCopyPrefix

public String getCopyPrefix()