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 SSLEngine
* @see SSLEngine#wrap(ByteBuffer, ByteBuffer)
* @see SSLEngine#unwrap(ByteBuffer, ByteBuffer)
*
* @author Brad R. Wetmore
* @since 1.5
*/
public class SSLEngineResult {
/**
* 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.
*
* @author Brad R. Wetmore
* @since 1.5
*/
public static enum Status {
/**
* 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_UNDERFLOW,
/**
* 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 SSLSession#getPacketBufferSize()
* @see SSLSession#getApplicationBufferSize()
*/
BUFFER_OVERFLOW,
/**
* The SSLEngine completed the operation, and
* is available to process similar calls.
*/
OK,
/**
* The operation just closed this side of the
* SSLEngine, or the operation
* could not be completed because it was already closed.
*/
CLOSED;
}
/**
* An SSLEngineResult enum describing the current
* handshaking state of this SSLEngine.
*
* @author Brad R. Wetmore
* @since 1.5
*/
public static enum HandshakeStatus {
/**
* The SSLEngine is not currently handshaking.
*/
NOT_HANDSHAKING,
/**
* The SSLEngine has just finished handshaking.
*
* This value is only generated by a call to
* SSLEngine.wrap()/unwrap() when that call
* finishes a handshake. It is never generated by
* SSLEngine.getHandshakeStatus().
*
* @see SSLEngine#wrap(ByteBuffer, ByteBuffer)
* @see SSLEngine#unwrap(ByteBuffer, ByteBuffer)
* @see SSLEngine#getHandshakeStatus()
*/
FINISHED,
/**
* The SSLEngine needs the results of one (or more)
* delegated tasks before handshaking can continue.
*
* @see SSLEngine#getDelegatedTask()
*/
NEED_TASK,
/**
* The SSLEngine must send data to the remote side
* before handshaking can continue, so SSLEngine.wrap()
* should be called.
*
* @see SSLEngine#wrap(ByteBuffer, ByteBuffer)
*/
NEED_WRAP,
/**
* The SSLEngine needs to receive data from the
* remote side before handshaking can continue.
*/
NEED_UNWRAP;
}
private final Status status;
private final HandshakeStatus handshakeStatus;
private final int bytesConsumed;
private final int bytesProduced;
/**
* Initializes a new instance of this class.
*
* @param status
* the return value of the operation.
*
* @param handshakeStatus
* the current handshaking status.
*
* @param bytesConsumed
* the number of bytes consumed from the source ByteBuffer
*
* @param 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 SSLEngineResult(Status status, HandshakeStatus handshakeStatus,
int bytesConsumed, int bytesProduced) {
if ((status == null) || (handshakeStatus == null) ||
(bytesConsumed < 0) || (bytesProduced < 0)) {
throw new IllegalArgumentException("Invalid Parameter(s)");
}
this.status = status;
this.handshakeStatus = handshakeStatus;
this.bytesConsumed = bytesConsumed;
this.bytesProduced = bytesProduced;
}
/**
* Gets the return value of this SSLEngine operation.
*
* @return the return value
*/
final public Status getStatus() {
return status;
}
/**
* Gets the handshake status of this SSLEngine
* operation.
*
* @return the handshake status
*/
final public HandshakeStatus getHandshakeStatus() {
return handshakeStatus;
}
/**
* Returns the number of bytes consumed from the input buffer.
*
* @return the number of bytes consumed.
*/
final public int bytesConsumed() {
return bytesConsumed;
}
/**
* Returns the number of bytes written to the output buffer.
*
* @return the number of bytes produced
*/
final public int bytesProduced() {
return bytesProduced;
}
/**
* Returns a String representation of this object.
*/
public String toString() {
return ("Status = " + status +
" HandshakeStatus = " + handshakeStatus +
"\nbytesConsumed = " + bytesConsumed +
" bytesProduced = " + bytesProduced);
}
}