org.apache.directory.ldap.client.api.future

Class HandshakeFuture

java.lang.Object

org.apache.directory.ldap.client.api.future.HandshakeFuture

All Implemented Interfaces:

Future<Boolean>

public class HandshakeFuture
extends Object
implements Future<Boolean>

A Future to manage StartTLS handshake

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cancelled flag to determine if this future is cancelled
private boolean	done A flag set to TRUE when the handshake has been completed

Constructor Summary

Constructors

Constructor and Description
HandshakeFuture() Creates a new instance of HandshakeFuture.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel the Future
boolean	cancel(boolean mayInterruptIfRunning)
Boolean	get()
Boolean	get(long timeout, TimeUnit unit)
boolean	isCancelled()
boolean	isDone()
void	secured() Set the Future to done when the TLS handshake has completed
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

done

private volatile boolean done

A flag set to TRUE when the handshake has been completed

cancelled

protected boolean cancelled

flag to determine if this future is cancelled

Constructor Detail

HandshakeFuture

public HandshakeFuture()

Creates a new instance of HandshakeFuture.

Method Detail

cancel

public void cancel()

Cancel the Future

secured

public void secured()

Set the Future to done when the TLS handshake has completed

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<Boolean>

get

public Boolean get()
            throws InterruptedException,
                   ExecutionException

Specified by:

get in interface Future<Boolean>

Throws:

InterruptedException

ExecutionException

get

public Boolean get(long timeout,
                   TimeUnit unit)
            throws InterruptedException,
                   ExecutionException,
                   TimeoutException

Specified by:

get in interface Future<Boolean>

Throws:

InterruptedException

ExecutionException

TimeoutException

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<Boolean>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<Boolean>

toString

public String toString()

Overrides:

toString in class Object