Package com.adaptris.filesystem.smbj

Class SMBProducer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageProducerImp

com.adaptris.core.ProduceOnlyProducerImp

com.adaptris.filesystem.smbj.SMBProducer

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageProducer, AdaptrisMessageSender, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator

@ComponentProfile(summary="Write to an SMB location",
                  tag="samba,smb",
                  recommended=SMBConnection.class,
                  since="3.10.1")
public class SMBProducer
extends ProduceOnlyProducerImp

Produce to a SMB share.

In the adapter configuration file this class is aliased as smb-producer which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Constructor Summary

Constructors

Constructor	Description
SMBProducer()

Method Summary

Modifier and Type	Method	Description
protected void	doProduce(AdaptrisMessage msg, String uncPath)
String	endpoint(AdaptrisMessage msg)
FileNameCreator	getFilenameCreator()
WriteMode	getMode()	Specify the mode in which the write of the file happens.
String	getPath()	The SMB Path to write files to in the form \\server-name\shareName\path\to\dir.
void	prepare()
void	setFilenameCreator(FileNameCreator filenameCreator)
void	setMode(WriteMode mode)	Specify the mode in which the write of the file happens.
void	setPath(String path)	The SMB Path to write files to in the form \\server-name\shareName\path\to\dir.
SMBProducer	withFilenameCreator(FileNameCreator f)
SMBProducer	withMode(WriteMode m)
SMBProducer	withPath(String s)

Methods inherited from class com.adaptris.core.ProduceOnlyProducerImp

produce, request, request

Methods inherited from class com.adaptris.core.AdaptrisMessageProducerImp

createName

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

createQualifier, decode, encode, getEncoder, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory, withUniqueID

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker

decode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactory

Methods inherited from interface com.adaptris.core.ComponentLifecycle

close, init, start, stop

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createQualifier, isTrackingEndpoint

Constructor Details

SMBProducer

public SMBProducer()

Method Details

prepare

public void prepare()
             throws CoreException

Throws:

CoreException

doProduce

protected void doProduce(AdaptrisMessage msg,
 String uncPath)
                  throws ProduceException

Specified by:

doProduce in class ProduceOnlyProducerImp

Throws:

ProduceException

withFilenameCreator

public SMBProducer withFilenameCreator(FileNameCreator f)

withMode

public SMBProducer withMode(WriteMode m)

withPath

public SMBProducer withPath(String s)

endpoint

public String endpoint(AdaptrisMessage msg)
                throws ProduceException

Specified by:

endpoint in class AdaptrisMessageProducerImp

Throws:

ProduceException

getFilenameCreator

public FileNameCreator getFilenameCreator()

setFilenameCreator

public void setFilenameCreator(FileNameCreator filenameCreator)

getMode

public WriteMode getMode()

Specify the mode in which the write of the file happens.

If not specified then the default is CreateMode which means the produce will fail if the file already exists. We consider this the safest mode since we aren't using intermediate staging files to ensure atomic operations.

setMode

public void setMode(WriteMode mode)

Specify the mode in which the write of the file happens.

If not specified then the default is CreateMode which means the produce will fail if the file already exists. We consider this the safest mode since we aren't using intermediate staging files to ensure atomic operations.

getPath

public String getPath()

The SMB Path to write files to in the form \\server-name\shareName\path\to\dir.

setPath

public void setPath(String path)

The SMB Path to write files to in the form \\server-name\shareName\path\to\dir.