public class XComSender extends SenderWithParametersBase
Modifier and Type | Class and Description |
---|---|
static class |
XComSender.CarriageFlagType |
static class |
XComSender.CodeType |
static class |
XComSender.CompressType |
static class |
XComSender.FileOptionType |
parameterNamesMustBeUnique, paramList
log
Constructor and Description |
---|
XComSender() |
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
|
addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList
close, createBean, getLogPrefix, getName, open, setApplicationContext, setName
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
close, open, sendMessageOrThrow
getName, setName
getApplicationContext, getName
getConfigurationClassLoader
public void configure() throws ConfigurationException
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.configure
in interface IConfigurable
configure
in interface ISender
configure
in class SenderWithParametersBase
ConfigurationException
public boolean isSynchronous()
ISender
true
, the result of sendMessage is the reply of the request.public SenderResult sendMessage(Message message, PipeLineSession session) throws SenderException, TimeoutException
ISender
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
.
SenderException
TimeoutException
public void setFileOption(XComSender.FileOptionType newVal)
public void setRemoteDirectory(String string)
public void setCarriageflag(XComSender.CarriageFlagType value)
public void setCodeflag(XComSender.CodeType value)
public void setCompress(XComSender.CompressType value)
public void setLogfile(String string)
public void setPassword(String string)
public void setPort(String string)
public void setQueue(Boolean b)
public void setRemoteSystem(String string)
public void setTracelevel(Integer i)
public void setTruncation(Boolean b)
public void setUserid(String string)
public void setRemoteFilePattern(String string)
@Mandatory public void setWorkingDirName(String string)
public void setXcomtcp(String string)
public void setConfigFile(String string)
public void setAuthAlias(String string)
Copyright © 2023 Frank!Framework. All rights reserved.