Package org.ldaptive

Class BindResponse

java.lang.Object

org.ldaptive.AbstractMessage

org.ldaptive.AbstractResult

org.ldaptive.BindResponse

All Implemented Interfaces:

Message, Result

public final class BindResponse
extends AbstractResult

LDAP bind response defined as:

   BindResponse ::= [APPLICATION 1] SEQUENCE {
     COMPONENTS OF LDAPResult,
     serverSaslCreds    [7] OCTET STRING OPTIONAL }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BindResponse.Builder
protected static class	BindResponse.SASLCredsHandler	Parse handler implementation for the server SASL creds.

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

AbstractResult.AbstractBuilder<B,T extends AbstractResult>, AbstractResult.DiagnosticMessageHandler, AbstractResult.MatchedDNHandler, AbstractResult.ReferralHandler, AbstractResult.ResultCodeHandler

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

AbstractMessage.ControlParser, AbstractMessage.ControlsHandler, AbstractMessage.MessageIDHandler

Field Summary

Fields

Modifier and Type	Field	Description
private static final DERPath	DIAGNOSTIC_MESSAGE_PATH	DER path to diagnostic message.
private static final int	HASH_CODE_SEED	hash code seed.
private static final DERPath	MATCHED_DN_PATH	DER path to matched DN.
static final int	PROTOCOL_OP	BER protocol number.
private static final DERPath	REFERRAL_PATH	DER path to referral.
private static final DERPath	RESULT_CODE_PATH	DER path to result code.
private static final DERPath	SASL_CREDENTIALS_PATH	DER path to SASL credentials.
private byte[]	serverSaslCreds	Server SASL credentials.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BindResponse()	Default constructor.
	BindResponse(DERBuffer buffer)	Creates a new bind response.

Method Summary

Modifier and Type	Method	Description
static BindResponse.Builder	builder()	Creates a builder for this class.
boolean	equals(Object o)
byte[]	getServerSaslCreds()	Returns the server SASL credentials.
int	hashCode()	Returns the hash code for this object.
private void	setServerSaslCreds(byte[] creds)	Sets the server SASL credentials.

Methods inherited from class org.ldaptive.AbstractResult

addReferralURLs, copyValues, equalsResult, getDiagnosticMessage, getMatchedDN, getReferralURLs, getResultCode, setDiagnosticMessage, setMatchedDN, setResultCode, toString

Methods inherited from class org.ldaptive.AbstractMessage

addControls, copyValues, equalsMessage, getControls, getMessageID, setMessageID

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ldaptive.Message

getControl, getControls, getMessageID

Methods inherited from interface org.ldaptive.Result

getEncodedDiagnosticMessage, isSuccess

Field Details

PROTOCOL_OP

public static final int PROTOCOL_OP

BER protocol number.

See Also:

• Constant Field Values

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

• Constant Field Values

RESULT_CODE_PATH

private static final DERPath RESULT_CODE_PATH

DER path to result code.

MATCHED_DN_PATH

private static final DERPath MATCHED_DN_PATH

DER path to matched DN.

DIAGNOSTIC_MESSAGE_PATH

private static final DERPath DIAGNOSTIC_MESSAGE_PATH

DER path to diagnostic message.

REFERRAL_PATH

private static final DERPath REFERRAL_PATH

DER path to referral.

SASL_CREDENTIALS_PATH

private static final DERPath SASL_CREDENTIALS_PATH

DER path to SASL credentials.

serverSaslCreds

private byte[] serverSaslCreds

Server SASL credentials.

Constructor Details

BindResponse

private BindResponse()

Default constructor.

BindResponse

public BindResponse(DERBuffer buffer)

Creates a new bind response.

Parameters:

buffer - to decode

Method Details

getServerSaslCreds

public byte[] getServerSaslCreds()

Returns the server SASL credentials.

Returns:

server SASL credentials

setServerSaslCreds

private void setServerSaslCreds(byte[] creds)

Sets the server SASL credentials.

Parameters:

creds - server SASL credentials

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractResult

hashCode

public int hashCode()

Description copied from class: AbstractMessage

Returns the hash code for this object.

Specified by:

hashCode in class AbstractMessage

Returns:

hash code

builder

public static BindResponse.Builder builder()

Creates a builder for this class.

Returns:

new builder