DefaultSaslClientRequest (Ldaptive 2.0.0-RC3 API)

java.lang.Object
- org.ldaptive.sasl.DefaultSaslClientRequest

All Implemented Interfaces:

CallbackHandler

Direct Known Subclasses:

CramMD5BindRequest, DigestMD5BindRequest, GssApiBindRequest
```
public abstract class DefaultSaslClientRequest
extends Object
implements CallbackHandler
```
Base class for SASL client requests.

Field Summary

Fields
Modifier and Type Field Description

private RequestControl[] controls
LDAP controls.

Constructor Summary

Constructors
Constructor Description

DefaultSaslClientRequest()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`SaslBindRequest`	`createBindRequest(byte[] saslCredentials)`	Creates a new bind request for this client.
`String`	`getAuthorizationID()`	Returns the SASL authorization.
`RequestControl[]`	`getControls()`
`abstract Mechanism`	`getMechanism()`	Returns the SASL mechanism.
`SaslClient`	`getSaslClient()`	Returns the SASL client to use for this request.
`Map<String,?>`	`getSaslProperties()`	Returns the SASL properties.
`void`	`setControls(RequestControl... cntrls)`
`String`	`toString()`

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

Methods inherited from interface javax.security.auth.callback.CallbackHandler
handle

- Field Detail
  - controls
```
private RequestControl[] controls
```
    LDAP controls.
- Constructor Detail
  - DefaultSaslClientRequest
```
public DefaultSaslClientRequest()
```
- Method Detail
  - getControls
```
public RequestControl[] getControls()
```
  - setControls
```
public void setControls(RequestControl... cntrls)
```
  - getMechanism
```
public abstract Mechanism getMechanism()
```
    Returns the SASL mechanism.
    
    Returns:
    
    SASL mechanism
  - getAuthorizationID
```
public String getAuthorizationID()
```
    Returns the SASL authorization.
    
    Returns:
    
    SASL authorization
  - getSaslProperties
```
public Map<String,?> getSaslProperties()
```
    Returns the SASL properties.
    
    Returns:
    
    SASL properties
  - getSaslClient
```
public SaslClient getSaslClient()
```
    Returns the SASL client to use for this request.
    
    Returns:
    
    SASL client
  - createBindRequest
```
public SaslBindRequest createBindRequest(byte[] saslCredentials)
```
    Creates a new bind request for this client.
    
    Parameters:
    
    saslCredentials - to bind with
    
    Returns:
    
    SASL bind request
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object