SSLEngineResult

public class SSLEngineResult extends Object

An encapsulation of the result state produced by SSLEngine I/O calls.

A SSLEngine provides a means for establishing secure communication sessions between two peers. SSLEngine operations typically consume bytes from an input buffer and produce bytes in an output buffer. This class provides operational result values describing the state of the SSLEngine, 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.

See Also

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

Nested Class Summary

enum	SSLEngineResult.HandshakeStatus		An SSLEngineResult enum describing the current handshaking state of this SSLEngine.
enum	SSLEngineResult.Status		An SSLEngineResult enum describing the overall result of the SSLEngine operation.

Public Constructor Summary

SSLEngineResult(SSLEngineResult.Status status, SSLEngineResult.HandshakeStatus handshakeStatus, int bytesConsumed, int bytesProduced) Initializes a new instance of this class.

Public Method Summary

final int	bytesConsumed() Returns the number of bytes consumed from the input buffer.
final int	bytesProduced() Returns the number of bytes written to the output buffer.
final SSLEngineResult.HandshakeStatus	getHandshakeStatus() Gets the handshake status of this SSLEngine operation.
final SSLEngineResult.Status	getStatus() Gets the return value of this SSLEngine operation.
String	toString() Returns a String representation of this object.

Inherited Method Summary

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.

Public Constructors

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 the status or handshakeStatus arguments are null, or if bytesConsumed or bytesProduced is negative.

Public Methods

public final int bytesConsumed ()

Returns the number of bytes consumed from the input buffer.

Returns

• the number of bytes consumed.

public final int bytesProduced ()

Returns the number of bytes written to the output buffer.

Returns

• the number of bytes produced

public final SSLEngineResult.HandshakeStatus getHandshakeStatus ()

Gets the handshake status of this SSLEngine operation.

Returns

• the handshake status

public final SSLEngineResult.Status getStatus ()

Gets the return value of this SSLEngine operation.

Returns

• the return value

public String toString ()

Returns a String representation of this object.

Returns

• a printable representation of this object.