Package javax.net.ssl

Class SSLEngineResult

java.lang.Object

javax.net.ssl.SSLEngineResult

public class SSLEngineResult
extends Object

The result object describing the state of the SSLEngine produced by the wrap() and unwrap() operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SSLEngineResult.HandshakeStatus	The enum describing the state of the current handshake.
static class	SSLEngineResult.Status	The enum describing the result of the SSLEngine operation.

Constructor Summary

Constructors

Constructor	Description
SSLEngineResult(SSLEngineResult.Status status, SSLEngineResult.HandshakeStatus handshakeStatus, int bytesConsumed, int bytesProduced)	Creates a new SSLEngineResult instance with the specified state values.

Method Summary

Modifier and Type	Method	Description
int	bytesConsumed()	Returns the number of bytes retrieved from the source buffer(s).
int	bytesProduced()	Returns the number of bytes transferred to the destination buffer(s).
SSLEngineResult.HandshakeStatus	getHandshakeStatus()	Returns the status of the current handshake.
SSLEngineResult.Status	getStatus()	Returns the return value of the SSLEngine operation.
String	toString()	Returns a string containing a concise, human-readable description of this object.

Methods inherited from class java.lang.Object

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

Constructor Details

SSLEngineResult

public SSLEngineResult(SSLEngineResult.Status status,
SSLEngineResult.HandshakeStatus handshakeStatus,
int bytesConsumed,
int bytesProduced)

Creates a new SSLEngineResult instance with the specified state values.

Parameters:

status - the return value of the SSLEngine operation.

handshakeStatus - the status of the current handshake

bytesConsumed - the number of bytes retrieved from the source buffer(s).

bytesProduced - the number of bytes transferred to the destination buffer(s).

Throws:

IllegalArgumentException - if status or handshakeStatus is null, or if bytesConsumed or bytesProduces are negative.

Method Details

getStatus

public final SSLEngineResult.Status getStatus()

Returns the return value of the SSLEngine operation.

Returns:

the return value of the SSLEngine operation.

getHandshakeStatus

public final SSLEngineResult.HandshakeStatus getHandshakeStatus()

Returns the status of the current handshake.

Returns:

the status of the current handshake.

bytesConsumed

public final int bytesConsumed()

Returns the number of bytes retrieved from the source buffer(s).

Returns:

the number of bytes retrieved from the source buffer(s).

bytesProduced

public final int bytesProduced()

Returns the number of bytes transferred to the destination buffer(s).

Returns:

the number of bytes transferred to the destination buffer(s).

toString

public String toString()

Description copied from class: Object

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Overrides:

toString in class Object

Returns:

a printable representation of this object.