Package com.adaptris.core.fs

Class AggregatingFsConsumeService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.aggregator.AggregatingConsumeServiceImpl<NullConnection>

com.adaptris.core.fs.AggregatingFsConsumeService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, Service, AggregatingConsumeService<NullConnection>, StateManagedComponent

@ComponentProfile(summary="Allows you to aggregate messages from the filesystem",
                  tag="service,aggregation")
public class AggregatingFsConsumeService
extends AggregatingConsumeServiceImpl<NullConnection>

Implentation of AggregatingConsumeService that allows you to consume a related message from a directory based on some criteria.

In the adapter configuration file this class is aliased as aggregating-fs-consume-service which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Constructor Summary

Constructors

Constructor	Description
AggregatingFsConsumeService()

Method Summary

Modifier and Type	Method	Description
void	doService(AdaptrisMessage msg)	Apply the service to the message.
AggregatingFsConsumer	getFsConsumer()
protected void	initService()
void	prepare()	Prepare for initialisation.
void	setFsConsumer(AggregatingFsConsumer fsConsumer)

Methods inherited from class com.adaptris.core.services.aggregator.AggregatingConsumeServiceImpl

closeService, start, start, stop, stop

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, setUniqueId

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

close, init

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Methods inherited from interface com.adaptris.core.Service

continueOnFailure, isBranching, setUniqueId

Methods inherited from interface com.adaptris.core.StateManagedComponent

changeState, requestClose, requestInit, requestStart, requestStop, retrieveComponentState

Constructor Detail

AggregatingFsConsumeService

public AggregatingFsConsumeService()

Method Detail

initService

protected void initService()
                    throws CoreException

Overrides:

initService in class AggregatingConsumeServiceImpl<NullConnection>

Throws:

CoreException

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Description copied from interface: Service

Apply the service to the message.

Parameters:

msg - the AdaptrisMessage to process

Throws:

ServiceException - wrapping any underlying Exceptions

getFsConsumer

public AggregatingFsConsumer getFsConsumer()

Returns:

the fsConsumer

setFsConsumer

public void setFsConsumer(AggregatingFsConsumer fsConsumer)

Parameters:

fsConsumer - the fsConsumer to set

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException