nl.nn.adapterframework.xcom

Class XComSender

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.xcom.XComSender

All Implemented Interfaces:

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

public class XComSender
extends SenderWithParametersBase

XCom client voor het versturen van files via XCom.

Author:

John Dekker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XComSender.CarriageFlagType
static class	XComSender.CodeType
static class	XComSender.CompressType
static class	XComSender.FileOptionType

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
XComSender()

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.
boolean	isSynchronous() When true, the result of sendMessage is the reply of the request.
SenderResult	sendMessage(Message message, PipeLineSession session) Send a message to some destination (as configured in the Sender object).
void	setAuthAlias(String string) name of the alias to obtain credentials to authenticatie on remote server
void	setCarriageflag(XComSender.CarriageFlagType value)
void	setCodeflag(XComSender.CodeType value) characterset conversion
void	setCompress(XComSender.CompressType value)
void	setConfigFile(String string)
void	setFileOption(XComSender.FileOptionType newVal) one of create, append or replace
void	setLogfile(String string) name of logfile for xcomtcp to be used
void	setPassword(String string) password of user on remote system
void	setPort(String string) port of remote host
void	setQueue(Boolean b) set queue off or on
void	setRemoteDirectory(String string) remote directory is prefixed witht the remote file
void	setRemoteFilePattern(String string) remote file to create.
void	setRemoteSystem(String string) hostname or tcpip adres of remote host
void	setTracelevel(Integer i) set between 0 (no trace) and 10
void	setTruncation(Boolean b) set truncation off or on
void	setUserid(String string) loginname of user on remote system
void	setWorkingDirName(String string) directory in which to run the xcomtcp command
void	setXcomtcp(String string) path to xcomtcp command

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, 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

XComSender

public XComSender()

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

isSynchronous

public boolean isSynchronous()

Description copied from interface: ISender

When true, the result of sendMessage is the reply of the request.

Specified by:

isSynchronous in interface ISender

Overrides:

isSynchronous in class SenderBase

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

setFileOption

public void setFileOption(XComSender.FileOptionType newVal)

one of create, append or replace

setRemoteDirectory

public void setRemoteDirectory(String string)

remote directory is prefixed witht the remote file

setCarriageflag

public void setCarriageflag(XComSender.CarriageFlagType value)

setCodeflag

public void setCodeflag(XComSender.CodeType value)

characterset conversion

setCompress

public void setCompress(XComSender.CompressType value)

setLogfile

public void setLogfile(String string)

name of logfile for xcomtcp to be used

setPassword

public void setPassword(String string)

password of user on remote system

setPort

public void setPort(String string)

port of remote host

setQueue

public void setQueue(Boolean b)

set queue off or on

setRemoteSystem

public void setRemoteSystem(String string)

hostname or tcpip adres of remote host

setTracelevel

public void setTracelevel(Integer i)

set between 0 (no trace) and 10

setTruncation

public void setTruncation(Boolean b)

set truncation off or on

setUserid

public void setUserid(String string)

loginname of user on remote system

setRemoteFilePattern

public void setRemoteFilePattern(String string)

remote file to create. if empty, the name is equal to the local file

setWorkingDirName

@Mandatory
public void setWorkingDirName(String string)

directory in which to run the xcomtcp command

setXcomtcp

public void setXcomtcp(String string)

path to xcomtcp command

setConfigFile

public void setConfigFile(String string)

setAuthAlias

public void setAuthAlias(String string)

name of the alias to obtain credentials to authenticatie on remote server