org.apache.directory.api.ldap.model.message
Interface BindResponse

All Superinterfaces:

Message, Response, ResultResponse

All Known Implementing Classes:

BindNoDResponse, BindResponseImpl

public interface BindResponse
extends ResultResponse

Bind protocol response message used to confirm the results of a bind request message. BindResponse consists simply of an indication from the server of the status of the client's request for authentication.

Author:

Apache Directory Project

Field Summary

static MessageTypeEnum

TYPE Bind response message type enumeration value

Method Summary

byte[]	getServerSaslCreds() Gets the optional property holding SASL authentication response parameters that are SASL mechanism specific.
void	setServerSaslCreds(byte[] serverSaslCreds) Sets the optional property holding SASL authentication response paramters that are SASL mechanism specific.

Methods inherited from interface org.apache.directory.api.ldap.model.message.ResultResponse

getLdapResult

Methods inherited from interface org.apache.directory.api.ldap.model.message.Message

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId

Field Detail

TYPE

static final MessageTypeEnum TYPE

Bind response message type enumeration value

Method Detail

getServerSaslCreds

byte[] getServerSaslCreds()

Gets the optional property holding SASL authentication response parameters that are SASL mechanism specific. Will return null if the authentication is simple.

Returns:

the sasl mech. specific credentials or null of auth. is simple

setServerSaslCreds

void setServerSaslCreds(byte[] serverSaslCreds)

Sets the optional property holding SASL authentication response paramters that are SASL mechanism specific. Leave null if authentication mode is simple.

Parameters:

serverSaslCreds - the sasl auth. mech. specific credentials