Class SSLEngineResult
- java.lang.Object
-
- javax.net.ssl.SSLEngineResult
-
public class SSLEngineResult extends Object
An encapsulation of the result state produced bySSLEngineI/O calls.A
SSLEngineprovides a means for establishing secure communication sessions between two peers.SSLEngineoperations typically consume bytes from an input buffer and produce bytes in an output buffer. This class provides operational result values describing the state of theSSLEngine, including indications of what operations are needed to finish an ongoing handshake. Lastly, it reports the number of bytes consumed and produced as a result of this operation.- Since:
- 1.5
- See Also:
-
SSLEngine,SSLEngine.wrap(ByteBuffer, ByteBuffer),SSLEngine.unwrap(ByteBuffer, ByteBuffer)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classSSLEngineResult.HandshakeStatusAnSSLEngineResultenum describing the current handshaking state of thisSSLEngine.static classSSLEngineResult.StatusAnSSLEngineResultenum describing the overall result of theSSLEngineoperation.
-
Constructor Summary
Constructors Constructor and Description SSLEngineResult(SSLEngineResult.Status status, SSLEngineResult.HandshakeStatus handshakeStatus, int bytesConsumed, int bytesProduced)Initializes a new instance of this class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description intbytesConsumed()Returns the number of bytes consumed from the input buffer.intbytesProduced()Returns the number of bytes written to the output buffer.SSLEngineResult.HandshakeStatusgetHandshakeStatus()Gets the handshake status of thisSSLEngineoperation.SSLEngineResult.StatusgetStatus()Gets the return value of thisSSLEngineoperation.StringtoString()Returns a String representation of this object.
-
-
-
Constructor Detail
SSLEngineResult
public SSLEngineResult(SSLEngineResult.Status status, SSLEngineResult.HandshakeStatus handshakeStatus, int bytesConsumed, int bytesProduced)
Initializes a new instance of this class.- Parameters:
-
status- the return value of the operation. -
handshakeStatus- the current handshaking status. -
bytesConsumed- the number of bytes consumed from the source ByteBuffer -
bytesProduced- the number of bytes placed into the destination ByteBuffer - Throws:
-
IllegalArgumentException- if thestatusorhandshakeStatusarguments are null, or ifbytesConsumedorbytesProducedis negative.
-
Method Detail
getStatus
public final SSLEngineResult.Status getStatus()
Gets the return value of thisSSLEngineoperation.- Returns:
- the return value
getHandshakeStatus
public final SSLEngineResult.HandshakeStatus getHandshakeStatus()
Gets the handshake status of thisSSLEngineoperation.- Returns:
- the handshake status
bytesConsumed
public final int bytesConsumed()
Returns the number of bytes consumed from the input buffer.- Returns:
- the number of bytes consumed.
bytesProduced
public final int bytesProduced()
Returns the number of bytes written to the output buffer.- Returns:
- the number of bytes produced
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
