ifs.fnd.connect.readers

Class FtpConnectReader

java.lang.Object

ifs.fnd.connect.readers.ConnectReader<FtpConnectorReadersConfig>

ifs.fnd.connect.readers.FtpConnectReader

All Implemented Interfaces:

java.lang.AutoCloseable

public class FtpConnectReader
extends ConnectReader<FtpConnectorReadersConfig>

Author:

japase

Nested Class Summary

Nested classes/interfaces inherited from class ifs.fnd.connect.readers.ConnectReader

ConnectReader.DeleteFailureTest, ConnectReader.Message, ConnectReader.PermanentFailureException, ConnectReader.ReaderFailureException, ConnectReader.ReadFailureTest, ConnectReader.TemporaryFailureException

Field Summary

Fields inherited from class ifs.fnd.connect.readers.ConnectReader

config, log, readerContext, readerProcessor

Constructor Summary

Constructors

Constructor and Description
FtpConnectReader()

Method Summary

Modifier and Type	Method and Description
void	nativeClose() All resources opened/initialized in nativeInitReader() should be closed/released here.
void	nativeDelete() Deletes message with ID specified in call to nativeInitMessage().
void	nativeInitMessage(java.lang.String messageId) Initialization of resources used per message basis.
void	nativeInitReader() Initialization of resources used by the reader.
java.util.List<java.lang.String>	nativeList() Create a light ware list of all messages available at the source.
ConnectReader.Message	nativeRead() Reads message with ID specified in call to nativeInitMessage().

Methods inherited from class ifs.fnd.connect.readers.ConnectReader

canList, close, closeMessage, createResponse, deleteMessage, getExecutionMode, getLocation, getMaxRetries, getName, getOrigin, getReader, getTimeout, initMessage, initReader, listMessages, nativeCloseMessage, performLoggerThreadCheck, readMessage, selectMessage, setOrigin

Methods inherited from class java.lang.Object

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

Constructor Detail

FtpConnectReader

public FtpConnectReader()

Method Detail

nativeInitReader

public void nativeInitReader()
                      throws ConnectReader.ReaderFailureException

Description copied from class: ConnectReader

Initialization of resources used by the reader. The reader implements the AutoCloseable interface, so all resources initiated/open here have to be released/closed in the nativeClose() method.

Specified by:

nativeInitReader in class ConnectReader<FtpConnectorReadersConfig>

Throws:

ConnectReader.ReaderFailureException

See Also:

ConnectReader.nativeClose()

nativeInitMessage

public void nativeInitMessage(java.lang.String messageId)
                       throws ConnectReader.ReaderFailureException

Description copied from class: ConnectReader

Initialization of resources used per message basis. Resources initiated/open here have to be released/closed in the nativeCloseMessage() method.

Specified by:

nativeInitMessage in class ConnectReader<FtpConnectorReadersConfig>

Parameters:

messageId - ID of the message that has to be read, processed and deleted

Throws:

ConnectReader.ReaderFailureException

See Also:

ConnectReader.nativeCloseMessage()

nativeList

public java.util.List<java.lang.String> nativeList()
                                            throws ConnectReader.ReaderFailureException

Description copied from class: ConnectReader

Create a light ware list of all messages available at the source.

Specified by:

nativeList in class ConnectReader<FtpConnectorReadersConfig>

Returns:

list of messages

Throws:

ConnectReader.ReaderFailureException

nativeRead

public ConnectReader.Message nativeRead()
                                 throws ConnectReader.ReaderFailureException

Description copied from class: ConnectReader

Reads message with ID specified in call to nativeInitMessage().

Specified by:

nativeRead in class ConnectReader<FtpConnectorReadersConfig>

Returns:

instance of Message that encapsulates the read message

Throws:

ConnectReader.ReaderFailureException

See Also:

ConnectReader.nativeInitMessage(String)

nativeDelete

public void nativeDelete()
                  throws ConnectReader.ReaderFailureException

Description copied from class: ConnectReader

Deletes message with ID specified in call to nativeInitMessage(). This method is called after the message has been successfully read and processed.

Specified by:

nativeDelete in class ConnectReader<FtpConnectorReadersConfig>

Throws:

ConnectReader.ReaderFailureException

See Also:

ConnectReader.nativeInitMessage(String), ConnectReader.nativeRead()

nativeClose

public void nativeClose()

Description copied from class: ConnectReader

All resources opened/initialized in nativeInitReader() should be closed/released here.

Specified by:

nativeClose in class ConnectReader<FtpConnectorReadersConfig>

See Also:

ConnectReader.nativeInitReader()