nl.nn.adapterframework.senders

Class SambaSenderOld

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.senders.SambaSenderOld

All Implemented Interfaces:

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

Deprecated.

@Deprecated
public class SambaSenderOld
extends SenderWithParametersBase

Samba Sender: The standard Windows interoperability suite for Linux and Unix.

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.

Since:

7.1-B4

Author:

Niels Meijer

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
SambaSenderOld() Deprecated.

Method Summary

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

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

SambaSenderOld

public SambaSenderOld()

Deprecated.

Method Detail

configure

public void configure()
               throws ConfigurationException

Deprecated.

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

Deprecated.

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

setShare

public void setShare(String share)

Deprecated.

the destination, aka smb://xxx/yyy share

getShare

public String getShare()

Deprecated.

setAction

public void setAction(String action)

Deprecated.

possible values: delete, download, list, mkdir, rename, rmdir, upload

getAction

public String getAction()

Deprecated.

setForce

public void setForce(boolean force)

Deprecated.

used when creating folders or overwriting existing files (when renaming or moving)

Default value

false

isForced

public boolean isForced()

Deprecated.

setAuthDomain

public void setAuthDomain(String domain)

Deprecated.

in case the user account is bound to a domain

getAuthDomain

public String getAuthDomain()

Deprecated.

setUsername

public void setUsername(String username)

Deprecated.

the smb share username

getUsername

public String getUsername()

Deprecated.

setPassword

public void setPassword(String password)

Deprecated.

the smb share password

getPassword

public String getPassword()

Deprecated.

setAuthAlias

public void setAuthAlias(String authAlias)

Deprecated.

alias used to obtain credentials for the smb share

getAuthAlias

public String getAuthAlias()

Deprecated.