org.apache.sshd.common.future

Class AbstractSshFuture<T extends SshFuture>

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.future.AbstractSshFuture<T>

Type Parameters:

T - Type of future

All Implemented Interfaces:

SshFuture<T>, WaitableFuture

Direct Known Subclasses:

DefaultSshFuture

public abstract class AbstractSshFuture<T extends SshFuture>
extends AbstractLoggingBean
implements SshFuture<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.Object	CANCELED A default value to indicate the future has been canceled
protected boolean	debugEnabled
private java.lang.Object	id
protected boolean	traceEnabled

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSshFuture(java.lang.Object id)

Method Summary

Modifier and Type	Method and Description
protected SshFutureListener<T>	asListener(java.lang.Object o)
protected T	asT()
boolean	await(long timeoutMillis) Wait for the asynchronous operation to complete with the specified timeout.
protected abstract java.lang.Object	await0(long timeoutMillis, boolean interruptable) Wait for the Future to be ready.
boolean	awaitUninterruptibly(long timeoutMillis) Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
protected <E extends java.lang.Throwable> E	formatExceptionMessage(java.util.function.Function<? super java.lang.String,? extends E> exceptionCreator, java.lang.String format, java.lang.Object... args) Generates an exception whose message is prefixed by the future simple class name + identifier as a hint to the context of the failure.
java.lang.Object	getId()
protected void	notifyListener(SshFutureListener<T> l)
java.lang.String	toString()
protected <R> R	verifyResult(java.lang.Class<? extends R> expectedType, long timeout) Waits (interruptible) for the specified timeout (msec.) and then checks the result:

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

getSimplifiedLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.future.SshFuture

addListener, removeListener

Methods inherited from interface org.apache.sshd.common.future.WaitableFuture

await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, isDone

Field Detail

CANCELED

protected static final java.lang.Object CANCELED

A default value to indicate the future has been canceled

debugEnabled

protected final boolean debugEnabled

traceEnabled

protected final boolean traceEnabled

id

private final java.lang.Object id

Constructor Detail

AbstractSshFuture

protected AbstractSshFuture(java.lang.Object id)

Parameters:

id - Some identifier useful as toString() value

Method Detail

getId

public java.lang.Object getId()

Specified by:

getId in interface WaitableFuture

Returns:

Some identifier useful as toString() value

await

public boolean await(long timeoutMillis)
              throws java.io.IOException

Description copied from interface: WaitableFuture

Wait for the asynchronous operation to complete with the specified timeout.

Specified by:

await in interface WaitableFuture

Parameters:

timeoutMillis - Wait time in milliseconds

Returns:

true if the operation is completed.

Throws:

java.io.IOException - if failed - specifically InterruptedIOException if waiting was interrupted

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeoutMillis)

Description copied from interface: WaitableFuture

Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.

Specified by:

awaitUninterruptibly in interface WaitableFuture

Parameters:

timeoutMillis - Wait time in milliseconds

Returns:

true if the operation is finished.

verifyResult

protected <R> R verifyResult(java.lang.Class<? extends R> expectedType,
                             long timeout)
                      throws java.io.IOException

Waits (interruptible) for the specified timeout (msec.) and then checks the result:

• If result is null then timeout is assumed to have expired - throw an appropriate IOException

• If the result is of the expected type, then cast and return it

• If the result is an IOException then re-throw it

• If the result is a Throwable then throw an IOException whose cause is the original exception

• Otherwise (should never happen), throw a StreamCorruptedException with the name of the result type

Type Parameters:

R - The generic result type

Parameters:

expectedType - The expected result type

timeout - The timeout (millis) to wait for a result

Returns:

The (never null) result

Throws:

java.io.IOException - If failed to retrieve the expected result on time

await0

protected abstract java.lang.Object await0(long timeoutMillis,
                                           boolean interruptable)
                                    throws java.io.InterruptedIOException

Wait for the Future to be ready. If the requested delay is 0 or negative, this method returns immediately.

Parameters:

timeoutMillis - The delay we will wait for the Future to be ready

interruptable - Tells if the wait can be interrupted or not. If true and the thread is interrupted then an InterruptedIOException is thrown.

Returns:

The non-null result object if the Future is ready, null if the timeout expired and no result was received

Throws:

java.io.InterruptedIOException - If the thread has been interrupted when it's not allowed.

asListener

protected SshFutureListener<T> asListener(java.lang.Object o)

notifyListener

protected void notifyListener(SshFutureListener<T> l)

asT

protected T asT()

formatExceptionMessage

protected <E extends java.lang.Throwable> E formatExceptionMessage(java.util.function.Function<? super java.lang.String,? extends E> exceptionCreator,
                                                                   java.lang.String format,
                                                                   java.lang.Object... args)

Generates an exception whose message is prefixed by the future simple class name + identifier as a hint to the context of the failure.

Type Parameters:

E - Type of Throwable being generated

Parameters:

exceptionCreator - The exception creator from the formatted message

format - The extra payload format as per String.format(String, Object...)

args - The formatting arguments

Returns:

The generated exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object