SSLEngineResult.Status

AI-generated Key Takeaways

• SSLEngineResult.Status is an enum that describes the overall result of an SSLEngine operation, like BUFFER_OVERFLOW or OK.

• It does not reflect the handshake state; consult SSLEngineResult's HandshakeStatus for that information.

• BUFFER_OVERFLOW and BUFFER_UNDERFLOW indicate insufficient buffer space and require repeating the call with more bytes.

• CLOSED signals that the SSLEngine was closed during or prior to the operation.

• OK signifies successful completion, and the SSLEngine is ready for further calls.

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

An SSLEngineResult enum describing the overall result of the SSLEngine operation. The Status value does not reflect the state of a SSLEngine handshake currently in progress. The SSLEngineResult's HandshakeStatus should be consulted for that information.

Inherited Method Summary

From class java.lang.Enum

final Object	clone() Throws CloneNotSupportedException.
final int	compareTo(SSLEngineResult.Status 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.Status>	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.Status o) Compares this object with the specified object for order.

Enum Values

public static final SSLEngineResult.Status BUFFER_OVERFLOW

The SSLEngine was not able to process the operation because there are not enough bytes available in the destination buffer to hold the result.

Repeat the call once more bytes are available.

See Also

• SSLSession.getPacketBufferSize()
• SSLSession.getApplicationBufferSize()

public static final SSLEngineResult.Status BUFFER_UNDERFLOW

The SSLEngine was not able to unwrap the incoming data because there were not enough source bytes available to make a complete packet.

Repeat the call once more bytes are available.

public static final SSLEngineResult.Status CLOSED

The operation just closed this side of the SSLEngine, or the operation could not be completed because it was already closed.

public static final SSLEngineResult.Status OK

The SSLEngine completed the operation, and is available to process similar calls.