com.adaptris.core.fs

Class FsProducer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageProducerImp

com.adaptris.core.ProduceOnlyProducerImp

com.adaptris.core.fs.FsProducer

All Implemented Interfaces:

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

Direct Known Subclasses:

LargeFsProducer

@ComponentProfile(summary="Write the current message to the filesystem",
                  tag="producer,fs,filesystem",
                  recommended=NullConnection.class,
                  metadata={"producedname","fsProduceDir"})
public class FsProducer
extends ProduceOnlyProducerImp

AdaptrisMessageProducer implementation that writes to the file system.

In the adapter configuration file this class is aliased as fs-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

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
FsProducer()
FsProducer(ProduceDestination d)

Method Summary

Modifier and Type	Method and Description
protected void	addProducerMetadata(AdaptrisMessage msg, java.io.File destFile)
void	close() Closes the component.
protected java.io.File	createTempFile(AdaptrisMessage msg)
protected void	doProduce(AdaptrisMessage msg, java.lang.String baseUrl)
java.lang.Boolean	getCreateDirs() Get the flag specifying creation of directories as required..
FileNameCreator	getFilenameCreator()
FsWorker	getFsWorker() Get the FsWorker implementation.
java.lang.String	getTempDirectory()
void	init() Initialises the component.
void	prepare() Prepare for initialisation.
void	produce(AdaptrisMessage msg, ProduceDestination overload) Produce the AdaptrisMessage to the supplied ProduceDestination , over-riding any configured destinations.
void	setCreateDirs(java.lang.Boolean b) Specify whether to create directories that do not exist.
void	setFilenameCreator(FileNameCreator creator) Sets the FileNameCreator to use.
void	setFsWorker(FsWorker fw) Set the FsWorker implementation to use when performing write operations.
void	setTempDirectory(java.lang.String s) Set the temporary directory for initially writing files to.
boolean	shouldCreateDirs()
void	start() Starts the component.
void	stop() Stop the component
protected void	validateDir(java.net.URL url)
protected void	write(AdaptrisMessage msg, java.io.File destFile)

Methods inherited from class com.adaptris.core.ProduceOnlyProducerImp

produce, request, request, request, request

Methods inherited from class com.adaptris.core.AdaptrisMessageProducerImp

getDestination, setDestination

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

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

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.AdaptrisMessageWorker

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

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Constructor Detail

FsProducer

public FsProducer()

FsProducer

public FsProducer(ProduceDestination d)

Method Detail

init

public void init()
          throws CoreException

Description copied from interface: ComponentLifecycle

Initialises the component.

Component initialisation includes config verification, creation of connections etc.

Throws:

CoreException - wrapping any underlying Exceptions

See Also:

ComponentLifecycle.init()

start

public void start()
           throws CoreException

Description copied from interface: ComponentLifecycle

Starts the component.

Once a component is started it should be ready to process messages. In the case of AdaptrisMessageConsumer, calling start will begin message delivery.

Throws:

CoreException - wrapping any underlying Exceptions

See Also:

ComponentLifecycle.start()

stop

public void stop()

Description copied from interface: ComponentLifecycle

Stop the component

A stopped component is not expected to be ready to process messages. In the case of AdaptrisMessageConsumer, calling stop will pause message delivery. Throwing a RuntimeException may cause unintended consequences

See Also:

ComponentLifecycle.stop()

close

public void close()

Description copied from interface: ComponentLifecycle

Closes the component.

A closed component should release any connections it uses, etc. and clean up completely. Throwing a RuntimeException may cause unintended consequences

See Also:

ComponentLifecycle.close()

produce

public void produce(AdaptrisMessage msg,
                    ProduceDestination overload)
             throws ProduceException

Description copied from interface: AdaptrisMessageSender

Produce the AdaptrisMessage to the supplied ProduceDestination , over-riding any configured destinations.

Parameters:

msg - the AdaptrisMessage to produce

overload - the ProduceDestination to produce to

Throws:

ProduceException - wrapping any underlying Exceptions

See Also:

#produce(AdaptrisMessage, ProduceDestination)

doProduce

protected void doProduce(AdaptrisMessage msg,
                         java.lang.String baseUrl)
                  throws ProduceException

Throws:

ProduceException

addProducerMetadata

protected void addProducerMetadata(AdaptrisMessage msg,
                                   java.io.File destFile)
                            throws java.io.IOException

Throws:

java.io.IOException

write

protected void write(AdaptrisMessage msg,
                     java.io.File destFile)
              throws java.lang.Exception

Throws:

java.lang.Exception

createTempFile

protected java.io.File createTempFile(AdaptrisMessage msg)
                               throws java.lang.Exception

Throws:

java.lang.Exception

validateDir

protected void validateDir(java.net.URL url)
                    throws java.io.IOException

Throws:

java.io.IOException

setCreateDirs

public void setCreateDirs(java.lang.Boolean b)

Specify whether to create directories that do not exist.

When the ProduceDestination returns a destination, if this flag has been set, then an attempt to create the directory is made, if the directory does not exist.

Parameters:

b - true to enable directory creation, default false

getCreateDirs

public java.lang.Boolean getCreateDirs()

Get the flag specifying creation of directories as required..

Returns:

true or false, default null which means false

See Also:

shouldCreateDirs()

shouldCreateDirs

public boolean shouldCreateDirs()

getTempDirectory

public java.lang.String getTempDirectory()

Returns:

the tempDirectory

setTempDirectory

public void setTempDirectory(java.lang.String s)

Set the temporary directory for initially writing files to.

In some instances, for instance, writing to network shares, it may be preferable to initial write to a temporary directory and then move the resulting file to the final location. Setting this to a non-null value will cause a temporary file to be created in this directory; this is then renamed to the correct location using File.renameTo(File).

Parameters:

s - the tempDirectory to set

getFsWorker

public FsWorker getFsWorker()

Get the FsWorker implementation.

Returns:

the FsWorker implementation.

setFsWorker

public void setFsWorker(FsWorker fw)

Set the FsWorker implementation to use when performing write operations.

Parameters:

fw - the fsWorker implementation, default NioWorker

getFilenameCreator

public FileNameCreator getFilenameCreator()

setFilenameCreator

public void setFilenameCreator(FileNameCreator creator)

Sets the FileNameCreator to use. May not be null.

Parameters:

creator - the FileNameCreator to use, default is FormattedFilenameCreator

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException