@Deprecated public class SambaSenderOld extends SenderWithParametersBase
Parameters:
The upload
action requires the file parameter to be set which should contain the fileContent to upload in either Stream, Bytes or String format
The rename
action requires the destination parameter to be set which should contain the full path relative to the share + filename
AuthAlias: (WebSphere based application servers)
If you do not want to specify the username/password used to authenticate with the Samba Share, you can use the authalias property.
NOTES:
Folders must always end with a slash.
It is possible to move files with the rename
action. When doing so, make sure that the target folder exists!
It is possible to create multiple directories at once, when the force
argument is set to true
.
The download
action returns a base64 encoded string containing the file content.
parameterNamesMustBeUnique, paramList
log
Constructor and Description |
---|
SambaSenderOld()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
configure()
Deprecated.
configure() is called once at startup of the framework in the configure method of the owner of this sender. |
String |
getAction()
Deprecated.
|
String |
getAuthAlias()
Deprecated.
|
String |
getAuthDomain()
Deprecated.
|
String |
getPassword()
Deprecated.
|
String |
getShare()
Deprecated.
|
String |
getUsername()
Deprecated.
|
boolean |
isForced()
Deprecated.
|
SenderResult |
sendMessage(Message message,
PipeLineSession session)
Deprecated.
Send a message to some destination (as configured in the Sender object).
|
void |
setAction(String action)
Deprecated.
possible values: delete, download, list, mkdir, rename, rmdir, upload
|
void |
setAuthAlias(String authAlias)
Deprecated.
alias used to obtain credentials for the smb share
|
void |
setAuthDomain(String domain)
Deprecated.
in case the user account is bound to a domain
|
void |
setForce(boolean force)
Deprecated.
used when creating folders or overwriting existing files (when renaming or moving)
|
void |
setPassword(String password)
Deprecated.
the smb share password
|
void |
setShare(String share)
Deprecated.
the destination, aka smb://xxx/yyy share
|
void |
setUsername(String username)
Deprecated.
the smb share username
|
addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList
close, createBean, getLogPrefix, getName, isSynchronous, open, setApplicationContext, setName
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
close, isSynchronous, 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 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 setShare(String share)
public String getShare()
public void setAction(String action)
public String getAction()
public void setForce(boolean force)
public boolean isForced()
public void setAuthDomain(String domain)
public String getAuthDomain()
public void setUsername(String username)
public String getUsername()
public void setPassword(String password)
public String getPassword()
public void setAuthAlias(String authAlias)
public String getAuthAlias()
Copyright © 2023 Frank!Framework. All rights reserved.