net.scharlie.lj4l.core.io.remote.sftp

Class SftpLineReader

java.lang.Object

net.scharlie.lj4l.core.io.remote.sftp.SftpLineReader

All Implemented Interfaces:

Closeable, AutoCloseable, LineReader, ConnectedTestable

public class SftpLineReader
extends Object
implements LineReader, ConnectedTestable

This class implements a SFTP line reader.

Instances of this class are not safe for use by multiple threads.

Nested Class Summary

Nested classes/interfaces inherited from interface net.scharlie.lj4l.core.io.LineReader

LineReader.LineConsumer

Constructor Summary

Constructors

Constructor and Description
SftpLineReader(SftpChannel channel, boolean autoCloseChannel) Create a new SFTP line reader.
SftpLineReader(SftpChannel channel, boolean autoCloseChannel, String path) Create a new SFTP line reader.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	exists(String pathToTest) Test whether the given file path exists.
boolean	isConnected() Answer whether this object is currently connected.
ResultData	readLines(LineReader.LineConsumer lineConsumer) Read line by line until the current end.
ResultData	readLines(LineReader.LineConsumer lineConsumer, boolean autoConnect, long timeoutInSeconds, long tryIntervalInSeconds) Read line by line until the current end.
void	removePath() Remove the current file path.
void	setPath(String path) Set the file path or null if you want to remove the current file path.

Methods inherited from class java.lang.Object

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

Constructor Detail

SftpLineReader

public SftpLineReader(SftpChannel channel,
                      boolean autoCloseChannel)

Create a new SFTP line reader.

Parameters:

channel - The SFTP channel

autoCloseChannel - Flag whether to close the SFTP channel automatically when this reader will be closed

Throws:

IllegalArgumentException - if the SFTP channel is null

SftpLineReader

public SftpLineReader(SftpChannel channel,
                      boolean autoCloseChannel,
                      String path)

Create a new SFTP line reader.

Parameters:

channel - The SFTP channel

autoCloseChannel - Flag whether to close the SFTP channel automatically when this reader will be closed

path - The file path

Throws:

IllegalArgumentException - if the SFTP channel is null

Method Detail

setPath

public final void setPath(String path)

Set the file path or null if you want to remove the current file path.

Resets the internal pointer to the last imported byte.

Specified by:

setPath in interface LineReader

Parameters:

path - The file path

Throws:

IllegalStateException - if this reader is already closed

IllegalArgumentException - if the path is not null but blank

removePath

public final void removePath()

Remove the current file path.

Specified by:

removePath in interface LineReader

Throws:

IllegalStateException - if this reader is already closed

readLines

public final ResultData readLines(LineReader.LineConsumer lineConsumer)

Read line by line until the current end. Make a one-time try to connect if not already connected.

Each call to this methods tries to continue reading after the last imported byte from the previous call.

The internal pointer to the last imported byte can and will be reseted by setting or removing the path.

The auto-connect flag is set to true.

Specified by:

readLines in interface LineReader

Parameters:

lineConsumer - The consumer which takes line by line

Returns:

A result data transfer object

Throws:

IllegalStateException - if this reader is already closed

IllegalArgumentException - if the line consumer is null

IllegalArgumentException - if the path is null or empty

readLines

public final ResultData readLines(LineReader.LineConsumer lineConsumer,
                                  boolean autoConnect,
                                  long timeoutInSeconds,
                                  long tryIntervalInSeconds)

Read line by line until the current end.

Each call to this methods tries to continue reading after the last imported byte from the previous call.

The internal pointer to the last imported byte can and will be reseted by setting or removing the path.

Parameters:

lineConsumer - The consumer which takes line by line

autoConnect - Flag whether to try to connect if not already connected

timeoutInSeconds - The duration until timeout in seconds if autoConnect is true. A negative or zero value means a one-time try

tryIntervalInSeconds - The time interval between two subsequent tries in seconds if autoConnect is true. Only relevant if the value of timeoutInSeconds is positive.

Returns:

A result data transfer object

Throws:

IllegalStateException - if this reader is already closed

IllegalArgumentException - if the line consumer is null

IllegalArgumentException - if the path is null or empty

exists

public final boolean exists(String pathToTest)

Test whether the given file path exists. The answer will be false if the file path does not exist or in case of any problem, e.g. no connection.

Specified by:

exists in interface LineReader

Parameters:

pathToTest - The file path

Returns:

answer whether the given file path exists

Throws:

IllegalStateException - if this reader is already closed

IllegalArgumentException - if the path is null or blank

isConnected

public final boolean isConnected()

Description copied from interface: ConnectedTestable

Answer whether this object is currently connected.

Specified by:

isConnected in interface ConnectedTestable

Returns:

answer

close

public final void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface LineReader