net.scharlie.lj4l.core.io.remote

Interface Connectable

All Superinterfaces:

ConnectedTestable

All Known Implementing Classes:

SftpChannel, SftpSession

public interface Connectable
extends ConnectedTestable

Method Summary

Modifier and Type	Method and Description
boolean	connect() Try to connect this object.
default boolean	connect(long timeoutInSeconds, long tryIntervalInSeconds) Try to connect this object.
default void	ensureConnected(long timeoutInSeconds, long tryIntervalInSeconds) Ensure that this object is connected.

Methods inherited from interface net.scharlie.lj4l.core.io.remote.ConnectedTestable

isConnected

Method Detail

connect

boolean connect()
         throws NotConnectedException

Try to connect this object. Return immediately if already connected or after a one-time try.

Returns:

whether this object is connected

Throws:

NotConnectedException - in case of error

connect

default boolean connect(long timeoutInSeconds,
                        long tryIntervalInSeconds)
                 throws NotConnectedException

Try to connect this object. Return immediately if already connected. Block until the connection is established or the timeout is elapsed.

Parameters:

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

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

Returns:

whether this object is connected

Throws:

NotConnectedException - in case of error

ensureConnected

default void ensureConnected(long timeoutInSeconds,
                             long tryIntervalInSeconds)
                      throws NotConnectedException

Ensure that this object is connected. Return immediately if already connected. Block until the connection is established or throw an exception if the timeout is elapsed.

Parameters:

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

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

Throws:

NotConnectedException - if the timeout is elapsed and still not connected or in case of error