SSLEngineResult.HandshakeStatus (Java 2 Platform SE 5.0) (original) (raw)

javax.net.ssl

Enum SSLEngineResult.HandshakeStatus

java.lang.Object extended by java.lang.Enum<SSLEngineResult.HandshakeStatus> javax.net.ssl.SSLEngineResult.HandshakeStatus

All Implemented Interfaces:

Serializable, Comparable<SSLEngineResult.HandshakeStatus>

Enclosing class:

SSLEngineResult

public static enum SSLEngineResult.HandshakeStatus

extends Enum<SSLEngineResult.HandshakeStatus>

An SSLEngineResult enum describing the current handshaking state of this SSLEngine.

Since:

1.5

Enum Constant Summary
FINISHED The SSLEngine has just finished handshaking.
NEED_TASK The SSLEngine needs the results of one (or more) delegated tasks before handshaking can continue.
NEED_UNWRAP The SSLEngine needs to receive data from the remote side before handshaking can continue.
NEED_WRAP The SSLEngine must send data to the remote side before handshaking can continue, so SSLEngine.wrap() should be called.
NOT_HANDSHAKING The SSLEngine is not currently handshaking.

Method Summary
static SSLEngineResult.HandshakeStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static SSLEngineResult.HandshakeStatus[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, [valueOf](../../../java/lang/Enum.html#valueOf%28java.lang.Class, java.lang.String%29)

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29)

Enum Constant Detail

NOT_HANDSHAKING

public static final SSLEngineResult.HandshakeStatus NOT_HANDSHAKING

The SSLEngine is not currently handshaking.

FINISHED

public static final SSLEngineResult.HandshakeStatus FINISHED

The SSLEngine has just finished handshaking.

This value is only generated by a call toSSLEngine.wrap()/unwrap() when that call finishes a handshake. It is never generated bySSLEngine.getHandshakeStatus().

See Also:

[SSLEngine.wrap(ByteBuffer, ByteBuffer)](../../../javax/net/ssl/SSLEngine.html#wrap%28java.nio.ByteBuffer, java.nio.ByteBuffer%29), [SSLEngine.unwrap(ByteBuffer, ByteBuffer)](../../../javax/net/ssl/SSLEngine.html#unwrap%28java.nio.ByteBuffer, java.nio.ByteBuffer%29), SSLEngine.getHandshakeStatus()

NEED_TASK

public static final SSLEngineResult.HandshakeStatus NEED_TASK

The SSLEngine needs the results of one (or more) delegated tasks before handshaking can continue.

See Also:

SSLEngine.getDelegatedTask()

NEED_WRAP

public static final SSLEngineResult.HandshakeStatus NEED_WRAP

The SSLEngine must send data to the remote side before handshaking can continue, so SSLEngine.wrap() should be called.

See Also:

[SSLEngine.wrap(ByteBuffer, ByteBuffer)](../../../javax/net/ssl/SSLEngine.html#wrap%28java.nio.ByteBuffer, java.nio.ByteBuffer%29)

NEED_UNWRAP

public static final SSLEngineResult.HandshakeStatus NEED_UNWRAP

The SSLEngine needs to receive data from the remote side before handshaking can continue.

Method Detail

values

public static final SSLEngineResult.HandshakeStatus[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(SSLEngineResult.HandshakeStatus c : SSLEngineResult.HandshakeStatus.values()) System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static SSLEngineResult.HandshakeStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if this enum type has no constant with the specified name

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.