org.mule.transport.sftp
Class SftpMessageReceiver

java.lang.Object
  org.mule.transport.AbstractTransportMessageHandler
      org.mule.transport.AbstractMessageReceiver
          org.mule.transport.AbstractPollingMessageReceiver
              org.mule.transport.sftp.SftpMessageReceiver

All Implemented Interfaces:

Disposable, Initialisable, Lifecycle, LifecycleStateEnabled, Startable, Stoppable, MessageSource, Connectable, MessageReceiver

public class SftpMessageReceiver
extends AbstractPollingMessageReceiver

SftpMessageReceiver polls and receives files from an sftp service using jsch. This receiver produces an InputStream payload, which can be materialized in a MessageDispatcher or Component.

Field Summary

Fields inherited from class org.mule.transport.AbstractPollingMessageReceiver

DEFAULT_POLL_FREQUENCY, DEFAULT_POLL_TIMEUNIT, DEFAULT_STARTUP_DELAY, schedules

Fields inherited from class org.mule.transport.AbstractMessageReceiver

defaultInboundTransformers, defaultResponseTransformers, flowConstruct, listener, receiverKey, replyToHandler

Fields inherited from class org.mule.transport.AbstractTransportMessageHandler

connected, connector, endpoint, lifecycleManager, logger, muleMessageFactory, retryTemplate

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

SftpMessageReceiver(SftpConnector connector, FlowConstruct flow, InboundEndpoint endpoint)

SftpMessageReceiver(SftpConnector connector, FlowConstruct flow, InboundEndpoint endpoint, long frequency)

Method Summary

void	doConnect()
void	doDisconnect()
protected void	doDispose()
protected MuleMessage	handleUnacceptedFilter(MuleMessage message) SFTP-35
void	poll()
protected boolean	pollOnPrimaryInstanceOnly() If this returns true for a transport, polling for that transport takes place only on the primary instance.
protected void	routeFile(String path)

Methods inherited from class org.mule.transport.AbstractPollingMessageReceiver

createWork, disableNativeScheduling, doStart, doStop, getBatchSize, getFrequency, getTimeUnit, performPoll, schedule, setFrequency, setTimeUnit, unschedule

Methods inherited from class org.mule.transport.AbstractMessageReceiver

applyInboundTransformers, applyResponseTransformers, createExecutionTemplate, createLifecycleManager, createMuleEvent, getConnectEventId, getConnectionDescription, getEndpoint, getEndpointURI, getFlowConstruct, getReceiverKey, getReplyToHandler, getWorkManager, initialise, propagateRootMessageIdProperty, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, setEndpoint, setListener, setReceiverKey, toString, warnIfMuleClientSendUsed

Methods inherited from class org.mule.transport.AbstractTransportMessageHandler

activate, connect, createMuleMessage, createMuleMessage, createMuleMessage, createMuleMessageFactory, createNullMuleMessage, disconnect, dispose, disposeAndLogException, doInitialise, getConnectEventId, getConnector, getLifecycleState, initializeMessageFactory, initializeRetryPolicy, isConnected, isDoThreading, isStarted, isStarting, isStopping, passivate, setEndpoint, start, stop, validate, validateConnection

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.transport.MessageReceiver

createMuleMessage, createMuleMessage

Methods inherited from interface org.mule.api.transport.Connectable

connect, disconnect, isConnected, validateConnection

Methods inherited from interface org.mule.api.lifecycle.Startable

start

Methods inherited from interface org.mule.api.lifecycle.Stoppable

stop

Methods inherited from interface org.mule.api.lifecycle.Disposable

dispose

Constructor Detail

SftpMessageReceiver

public SftpMessageReceiver(SftpConnector connector,
                           FlowConstruct flow,
                           InboundEndpoint endpoint,
                           long frequency)
                    throws CreateException

Throws:

CreateException

SftpMessageReceiver

public SftpMessageReceiver(SftpConnector connector,
                           FlowConstruct flow,
                           InboundEndpoint endpoint)
                    throws CreateException

Throws:

CreateException

Method Detail

poll

public void poll()
          throws Exception

Specified by:

poll in class AbstractPollingMessageReceiver

Throws:

Exception

pollOnPrimaryInstanceOnly

protected boolean pollOnPrimaryInstanceOnly()

Description copied from class: AbstractPollingMessageReceiver

If this returns true for a transport, polling for that transport takes place only on the primary instance.

Overrides:

pollOnPrimaryInstanceOnly in class AbstractPollingMessageReceiver

routeFile

protected void routeFile(String path)
                  throws Exception

Throws:

Exception

handleUnacceptedFilter

protected MuleMessage handleUnacceptedFilter(MuleMessage message)

SFTP-35

Overrides:

handleUnacceptedFilter in class AbstractMessageReceiver

doConnect

public void doConnect()
               throws Exception

Overrides:

doConnect in class AbstractTransportMessageHandler

Throws:

Exception

doDisconnect

public void doDisconnect()
                  throws Exception

Overrides:

doDisconnect in class AbstractTransportMessageHandler

Throws:

Exception

doDispose

protected void doDispose()

Overrides:

doDispose in class AbstractMessageReceiver