SSLEngineResult.HandshakeStatus

AI-generated Key Takeaways

• SSLEngineResult.HandshakeStatus is an enum that describes the current handshaking state of an SSLEngine.

• It includes values like FINISHED, NEED_TASK, NEED_UNWRAP, NEED_WRAP, and NOT_HANDSHAKING to represent different stages of the handshake process.

• These values indicate whether the handshake is complete, requires delegated tasks, needs data exchange, or is not currently in progress.

• SSLEngineResult.HandshakeStatus helps in managing and understanding the SSL/TLS handshake process within an application.

public static final enum SSLEngineResult.HandshakeStatus extends Enum<SSLEngineResult.HandshakeStatus>

An SSLEngineResult enum describing the current handshaking state of this SSLEngine.

Inherited Method Summary

From class java.lang.Enum

final Object	clone() Throws CloneNotSupportedException.
final int	compareTo(SSLEngineResult.HandshakeStatus o) Compares this enum with the specified object for order.
final boolean	equals(Object other) Returns true if the specified object is equal to this enum constant.
final void	finalize() enum classes cannot have finalize methods.
final Class<SSLEngineResult.HandshakeStatus>	getDeclaringClass() Returns the Class object corresponding to this enum constant's enum type.
final int	hashCode() Returns a hash code for this enum constant.
final String	name() Returns the name of this enum constant, exactly as declared in its enum declaration.
final int	ordinal() Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
String	toString() Returns the name of this enum constant, as contained in the declaration.
static <T extends Enum<T>> T	valueOf(Class<T> enumType, String name) Returns the enum constant of the specified enum type with the specified name.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.lang.Comparable

abstract int

compareTo(SSLEngineResult.HandshakeStatus o) Compares this object with the specified object for order.

Enum Values

public static final SSLEngineResult.HandshakeStatus FINISHED

The SSLEngine has just finished handshaking.

This value is only generated by a call to SSLEngine.wrap()/unwrap() when that call finishes a handshake. It is never generated by SSLEngine.getHandshakeStatus().

See Also

• SSLEngine.wrap(ByteBuffer, ByteBuffer)
• SSLEngine.unwrap(ByteBuffer, ByteBuffer)
• SSLEngine.getHandshakeStatus()

public static final SSLEngineResult.HandshakeStatus NEED_TASK

The SSLEngine needs the results of one (or more) delegated tasks before handshaking can continue.

See Also

• SSLEngine.getDelegatedTask()

public static final SSLEngineResult.HandshakeStatus NEED_UNWRAP

The SSLEngine needs to receive data from the remote side before handshaking can continue.

public static final SSLEngineResult.HandshakeStatus NEED_WRAP

The SSLEngine must send data to the remote side before handshaking can continue, so SSLEngine.wrap() should be called.

See Also

• SSLEngine.wrap(ByteBuffer, ByteBuffer)

public static final SSLEngineResult.HandshakeStatus NOT_HANDSHAKING

The SSLEngine is not currently handshaking.