com.ongres.scram.client

Enum ScramClient.ChannelBinding

java.lang.Object

java.lang.Enum<ScramClient.ChannelBinding>

com.ongres.scram.client.ScramClient.ChannelBinding

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ScramClient.ChannelBinding>

Enclosing class:

ScramClient

public static enum ScramClient.ChannelBinding
extends java.lang.Enum<ScramClient.ChannelBinding>

Select whether this client will support channel binding or not

Enum Constant Summary

Enum Constants

Enum Constant and Description
IF_SERVER_SUPPORTS_IT Channel binding is preferred.
NO Don't use channel binding.
YES Force use of channel binding.

Field Summary

Fields

Modifier and Type	Field and Description
private Gs2CbindFlag	gs2CbindFlag

Method Summary

Modifier and Type	Method and Description
Gs2CbindFlag	gs2CbindFlag()
static ScramClient.ChannelBinding	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScramClient.ChannelBinding[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO

public static final ScramClient.ChannelBinding NO

Don't use channel binding. Server must support at least one non-channel binding mechanism.

YES

public static final ScramClient.ChannelBinding YES

Force use of channel binding. Server must support at least one channel binding mechanism. Channel binding data will need to be provided as part of the ClientFirstMessage.

IF_SERVER_SUPPORTS_IT

public static final ScramClient.ChannelBinding IF_SERVER_SUPPORTS_IT

Channel binding is preferred. Non-channel binding mechanisms will be used if either the server does not support channel binding, or no channel binding data is provided as part of the ClientFirstMessage

Field Detail

gs2CbindFlag

private final Gs2CbindFlag gs2CbindFlag

Method Detail

values

public static ScramClient.ChannelBinding[] values()

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

for (ScramClient.ChannelBinding c : ScramClient.ChannelBinding.values())
    System.out.println(c);

Returns:

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

valueOf

public static ScramClient.ChannelBinding valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

gs2CbindFlag

public Gs2CbindFlag gs2CbindFlag()