org.apache.sshd.common.future

Class GlobalRequestFuture

java.lang.Object

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

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

org.apache.sshd.common.future.DefaultSshFuture<GlobalRequestFuture>

org.apache.sshd.common.future.GlobalRequestFuture

All Implemented Interfaces:

EventListener, HasException, SshFuture<GlobalRequestFuture>, SshFutureListener<IoWriteFuture>, WaitableFuture, SshdEventListener

public class GlobalRequestFuture
extends DefaultSshFuture<GlobalRequestFuture>
implements HasException, SshFutureListener<IoWriteFuture>

A DefaultSshFuture that can be used to wait for the reply of an SSH_MSG_GLOBAL_REQUEST sent with want-reply = true.

See Also:

org.apache.sshd.common.session.Session#request(Buffer, String, ReplyHandler)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GlobalRequestFuture.ReplyHandler A ReplyHandler is invoked asynchronously when the reply for a request with want-reply = true is received.

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
GlobalRequestFuture(String request) Creates a new GlobalRequestFuture for a global request.
GlobalRequestFuture(String request, GlobalRequestFuture.ReplyHandler handler) Creates a new GlobalRequestFuture for a global request.

Method Summary

Modifier and Type	Method and Description
Buffer	getBuffer() Obtains the reply Buffer if the request was successful.
Throwable	getException() Retrieves an exception if the request failed.
GlobalRequestFuture.ReplyHandler	getHandler() Retrieves the GlobalRequestFuture.ReplyHandler of this future, if any.
String	getId()
long	getSequenceNumber() Retrieves this future's packet sequence number.
void	operationComplete(IoWriteFuture future)
void	setSequenceNumber(long number) Sets the packet sequence number of the global request represented by this future.
String	toString()

Methods inherited from class org.apache.sshd.common.future.DefaultSshFuture

addListener, await0, createCancellation, getNumRegisteredListeners, getValue, isDone, notifyListeners, onValueSet, removeListener, setValue

Methods inherited from class org.apache.sshd.common.future.AbstractSshFuture

asListener, asT, await, awaitUninterruptibly, formatExceptionMessage, notifyListener, verifyResult

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

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

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.util.SshdEventListener

validateListener

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

await, await, await, await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly

Constructor Detail

GlobalRequestFuture

public GlobalRequestFuture(String request)

Creates a new GlobalRequestFuture for a global request. Synchronization occurs on the future itself. The future will be fulfilled once the reply has been received or an error occurred.

Parameters:

request - the request identifier

GlobalRequestFuture

public GlobalRequestFuture(String request,
                           GlobalRequestFuture.ReplyHandler handler)

Creates a new GlobalRequestFuture for a global request. Synchronization occurs on the future itself. The future will be fulfilled once the request has been sent, or an error occurred during sending. The framework will invoke the handler once the reply has been received. For global requests with want-reply = false, the handler will be invoked with an empty buffer if the request was successfully sent.

Parameters:

request - the request identifier

handler - the GlobalRequestFuture.ReplyHandler, or null

Method Detail

getId

public String getId()

Specified by:

getId in interface WaitableFuture

Overrides:

getId in class AbstractSshFuture<GlobalRequestFuture>

getSequenceNumber

public long getSequenceNumber()

Retrieves this future's packet sequence number.

Returns:

the sequence number

setSequenceNumber

public void setSequenceNumber(long number)

Sets the packet sequence number of the global request represented by this future.

Parameters:

number - the packet sequence number

Throws:

IllegalArgumentException - if the number given is not an unsigned 32bit value

getHandler

public GlobalRequestFuture.ReplyHandler getHandler()

Retrieves the GlobalRequestFuture.ReplyHandler of this future, if any.

Returns:

the handler, or null if none was set

getBuffer

public Buffer getBuffer()

Obtains the reply Buffer if the request was successful. If called after DefaultSshFuture.isDone() is true, a non-null result means the request was successful.

Returns:

the Buffer, or null if the request was not successful or the reply was not received yet

getException

public Throwable getException()

Retrieves an exception if the request failed. If called after DefaultSshFuture.isDone() is true, a null result means the request did not fail.

Specified by:

getException in interface HasException

Returns:

a failure reason, or null if there isn't one or if the request did not fail

operationComplete

public void operationComplete(IoWriteFuture future)

Specified by:

operationComplete in interface SshFutureListener<IoWriteFuture>

toString

public String toString()

Overrides:

toString in class DefaultSshFuture<GlobalRequestFuture>