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

Class SftpLineWriter

java.lang.Object

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

All Implemented Interfaces:

Closeable, AutoCloseable, LineWriter, ConnectedTestable

public class SftpLineWriter
extends Object
implements LineWriter, ConnectedTestable

This class implements a SFTP line writer.

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	isConnected() Answer whether this object is currently connected.
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.
ResultData	writeLines(Supplier<String> lineSupplier) Write line by line until the line supplier provides a null value.
ResultData	writeLines(Supplier<String> lineSupplier, boolean autoConnect, long timeoutInSeconds, long tryIntervalInSeconds) Write line by line until the line supplier provides a null value.

Methods inherited from class java.lang.Object

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

Constructor Detail

SftpLineWriter

public SftpLineWriter(SftpChannel channel,
                      boolean autoCloseChannel)

Create a new SFTP line writer.

Parameters:

channel - The SFTP channel

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

Throws:

IllegalArgumentException - if the SFTP channel is null

SftpLineWriter

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

Create a new SFTP line writer.

Parameters:

channel - The SFTP channel

autoCloseChannel - Flag whether to close the SFTP channel automatically when this writer 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.

Specified by:

setPath in interface LineWriter

Parameters:

path - The file path

Throws:

IllegalStateException - if this writer 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 LineWriter

Throws:

IllegalStateException - if this writer is already closed

writeLines

public final ResultData writeLines(Supplier<String> lineSupplier)

Write line by line until the line supplier provides a null value. Make a one-time try to connect if not already connected.

Each call to this methods tries to continue writing after the last exported byte from the previous call.

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

The auto-connect flag is set to true.

Specified by:

writeLines in interface LineWriter

Parameters:

lineSupplier - The supplier which provides line by line. A null value indicates the end.

Returns:

A result data transfer object

Throws:

IllegalStateException - if this writer is already closed

IllegalArgumentException - if the line supplier is null

IllegalArgumentException - if the path is null or empty

writeLines

public final ResultData writeLines(Supplier<String> lineSupplier,
                                   boolean autoConnect,
                                   long timeoutInSeconds,
                                   long tryIntervalInSeconds)

Write line by line until the line supplier provides a null value.

Each call to this methods tries to continue writing after the last exported byte from the previous call.

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

Parameters:

lineSupplier - The supplier which provides line by line. A null value indicates the end.

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 writer is already closed

IllegalArgumentException - if the line supplier is null

IllegalArgumentException - if the path is null or empty

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 LineWriter