Package org.ldaptive.sasl

Class SaslBindRequest

java.lang.Object

org.ldaptive.AbstractRequestMessage

org.ldaptive.sasl.SaslBindRequest

All Implemented Interfaces:

BindRequest, Request

Direct Known Subclasses:

ExternalBindRequest

public class SaslBindRequest
extends AbstractRequestMessage
implements BindRequest

LDAP SASL bind request defined as:

   SaslCredentials ::= SEQUENCE {
     mechanism               LDAPString,
     credentials             OCTET STRING OPTIONAL }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SaslBindRequest.Builder	SASL bind request builder.

Nested classes/interfaces inherited from class org.ldaptive.AbstractRequestMessage

AbstractRequestMessage.AbstractBuilder<B,T extends AbstractRequestMessage>

Field Summary

Fields

Modifier and Type	Field	Description
private byte[]	saslCredentials	SASL credentials.
private String	saslMechanism	SASL mechanism.

Fields inherited from class org.ldaptive.AbstractRequestMessage

logger

Fields inherited from interface org.ldaptive.BindRequest

PROTOCOL_OP, VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SaslBindRequest()	Default constructor.
	SaslBindRequest(String mechanism)	Creates a new SASL bind request.
	SaslBindRequest(String mechanism, byte[] credentials)	Creates a new SASL bind request.
	SaslBindRequest(String mechanism, String credentials)	Creates a new SASL bind request.

Method Summary

Modifier and Type	Method	Description
static SaslBindRequest.Builder	builder()	Creates a builder for this class.
protected DEREncoder[]	getRequestEncoders(int id)	Returns the request encoders for this message.
String	toString()

Methods inherited from class org.ldaptive.AbstractRequestMessage

encode, getControls, getResponseTimeout, setControls, setResponseTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ldaptive.Request

encode

Field Details

saslMechanism

private String saslMechanism

SASL mechanism.

saslCredentials

private byte[] saslCredentials

SASL credentials.

Constructor Details

SaslBindRequest

private SaslBindRequest()

Default constructor.

SaslBindRequest

public SaslBindRequest(String mechanism)

Creates a new SASL bind request.

Parameters:

mechanism - type of SASL request

SaslBindRequest

public SaslBindRequest(String mechanism,
 String credentials)

Creates a new SASL bind request.

Parameters:

mechanism - type of SASL request

credentials - to bind as

SaslBindRequest

public SaslBindRequest(String mechanism,
 byte[] credentials)

Creates a new SASL bind request.

Parameters:

mechanism - type of SASL request

credentials - to bind as

Method Details

getRequestEncoders

protected DEREncoder[] getRequestEncoders(int id)

Description copied from class: AbstractRequestMessage

Returns the request encoders for this message.

Specified by:

getRequestEncoders in class AbstractRequestMessage

Parameters:

id - message ID

Returns:

request encoders

toString

public String toString()

Overrides:

toString in class AbstractRequestMessage

builder

public static SaslBindRequest.Builder builder()

Creates a builder for this class.

Returns:

new builder