ScramSaslClient.ClientFirstMessage (Ldaptive 2.4.2 API)

java.lang.Object
- org.ldaptive.transport.ScramSaslClient.ClientFirstMessage

Enclosing class:

ScramSaslClient
```
static class ScramSaslClient.ClientFirstMessage
extends Object
```
Properties associated with the client first message.

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`clientNonce`	Protocol nonce.
`private String`	`clientUsername`	Username to authenticate.
`private static int`	`DEFAULT_NONCE_SIZE`	Default nonce size.
`private static String`	`GS2_NO_CHANNEL_BINDING`	GS2 header for no channel binding.
`private String`	`message`	Message produced from the username and nonce.

Constructor Summary

Constructors
Constructor Description

ClientFirstMessage(String username, byte[] nonce)
Creates a new client first message.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`encode()`	Encodes this message to send to the server.
`String`	`getMessage()`
`String`	`getNonce()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - GS2_NO_CHANNEL_BINDING
```
private static final String GS2_NO_CHANNEL_BINDING
```
    GS2 header for no channel binding.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_NONCE_SIZE
```
private static final int DEFAULT_NONCE_SIZE
```
    Default nonce size.
    
    See Also:
    
    Constant Field Values
  - clientUsername
```
private final String clientUsername
```
    Username to authenticate.
  - clientNonce
```
private final String clientNonce
```
    Protocol nonce.
  - message
```
private final String message
```
    Message produced from the username and nonce.
- Constructor Detail
  - ClientFirstMessage
```
ClientFirstMessage(String username,
                   byte[] nonce)
```
    Creates a new client first message. If nonce is null a random is created for this client.
    
    Parameters:
    
    username - to authenticate
    
    nonce - to supply to the server or null
- Method Detail
  - getNonce
```
public String getNonce()
```
  - getMessage
```
public String getMessage()
```
  - encode
```
public String encode()
```
    Encodes this message to send to the server. This methods prepends the message with a GS2 header indicating that no channel binding is supported.
    
    Returns:
    
    encoded message