W3cubDocs

/OpenJDK 21

Enum Class SSLEngineResult.Status

java.lang.Object
java.lang.Enum<SSLEngineResult.Status>
javax.net.ssl.SSLEngineResult.Status
All Implemented Interfaces:
Serializable, Comparable<SSLEngineResult.Status>, Constable
Enclosing class:
SSLEngineResult
public static 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.
Since:
1.5

Nested Class Summary

Nested classes/interfaces declared in class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constant Description
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.
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.
CLOSED
The operation just closed this side of the SSLEngine, or the operation could not be completed because it was already closed.
OK
The SSLEngine completed the operation, and is available to process similar calls.

Method Summary

Modifier and Type Method Description
static SSLEngineResult.Status valueOf(String name)
Returns the enum constant of this class with the specified name.
static SSLEngineResult.Status[] values()
Returns an array containing the constants of this enum class, in the order they are declared.

Methods declared in class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods declared in class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BUFFER_UNDERFLOW

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.

BUFFER_OVERFLOW

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:

OK

public static final SSLEngineResult.Status OK
The SSLEngine completed the operation, and is available to process similar calls.

CLOSED

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.

Method Details

values

public static SSLEngineResult.Status[] values()
Returns an array containing the constants of this enum class, in the order they are declared.
Returns:
an array containing the constants of this enum class, in the order they are declared

valueOf

public static SSLEngineResult.Status valueOf(String name)
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum class has no constant with the specified name
NullPointerException - if the argument is null

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/javax/net/ssl/SSLEngineResult.Status.html