org.ldaptive

Class BindRequest

java.lang.Object

org.ldaptive.AbstractRequest

org.ldaptive.BindRequest

All Implemented Interfaces:

Message<RequestControl>, Request

public class BindRequest
extends AbstractRequest

Contains the data required to perform an ldap bind operation.

Field Summary

Fields

Modifier and Type	Field and Description
private Credential	bindCredential Credential for the bind DN.
private java.lang.String	bindDn DN to bind as before performing operations.
private SaslConfig	saslConfig Configuration for SASL authentication.

Constructor Summary

Constructors

Constructor and Description
BindRequest() Default constructor.
BindRequest(SaslConfig config) Creates a new bind request.
BindRequest(java.lang.String dn, Credential credential) Creates a new bind request.
BindRequest(java.lang.String dn, Credential credential, SaslConfig config) Creates a new bind request.

Method Summary

Modifier and Type	Method and Description
Credential	getCredential() Returns the credential used with the bind DN.
java.lang.String	getDn() Returns the bind DN.
SaslConfig	getSaslConfig() Returns the sasl config.
void	setCredential(Credential credential) Sets the credential of the bind DN.
void	setDn(java.lang.String dn) Sets the bind DN to authenticate as before performing operations.
void	setSaslConfig(SaslConfig config) Sets the sasl config.
java.lang.String	toString()

Methods inherited from class org.ldaptive.AbstractRequest

getControls, getIntermediateResponseHandlers, getReferralHandler, setControls, setIntermediateResponseHandlers, setReferralHandler

Methods inherited from class java.lang.Object

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

Field Detail

bindDn

private java.lang.String bindDn

DN to bind as before performing operations.

bindCredential

private Credential bindCredential

Credential for the bind DN.

saslConfig

private SaslConfig saslConfig

Configuration for SASL authentication.

Constructor Detail

BindRequest

public BindRequest()

Default constructor.

BindRequest

public BindRequest(java.lang.String dn,
                   Credential credential)

Creates a new bind request.

Parameters:

dn - to bind as

credential - to bind with

BindRequest

public BindRequest(java.lang.String dn,
                   Credential credential,
                   SaslConfig config)

Creates a new bind request.

Parameters:

dn - to bind as

credential - to bind with

config - sasl configuration

BindRequest

public BindRequest(SaslConfig config)

Creates a new bind request.

Parameters:

config - sasl configuration

Method Detail

getDn

public java.lang.String getDn()

Returns the bind DN.

Returns:

DN to bind as

setDn

public void setDn(java.lang.String dn)

Sets the bind DN to authenticate as before performing operations.

Parameters:

dn - to bind as

getCredential

public Credential getCredential()

Returns the credential used with the bind DN.

Returns:

bind DN credential

setCredential

public void setCredential(Credential credential)

Sets the credential of the bind DN.

Parameters:

credential - to use with bind DN

getSaslConfig

public SaslConfig getSaslConfig()

Returns the sasl config.

Returns:

sasl config

setSaslConfig

public void setSaslConfig(SaslConfig config)

Sets the sasl config.

Parameters:

config - sasl config

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object