org.apache.directory.ldap.client.api.message

Class BindResponse

java.lang.Object

org.apache.directory.ldap.client.api.message.AbstractMessage

org.apache.directory.ldap.client.api.message.AbstractResponseWithResult

org.apache.directory.ldap.client.api.message.BindResponse

All Implemented Interfaces:

Message, Response, ResponseWithResult

public class BindResponse
extends AbstractResponseWithResult

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.

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
BindResponse() Creates a new instance of BindResponseImpl.

Method Summary

Modifier and Type	Method and Description
byte[]	getServerSaslCreds() Gets the optional property holding SASL authentication response parameters that are SASL mechanism specific.
void	setServerSaslCreds(byte[] credentials)
String	toString() Get a String representation of a BindResponse

Methods inherited from class org.apache.directory.ldap.client.api.message.AbstractResponseWithResult

getLdapResult, setLdapResult

Methods inherited from class org.apache.directory.ldap.client.api.message.AbstractMessage

add, getControl, getControls, getMessageId, hasControl, remove, setMessageId

Methods inherited from class java.lang.Object

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

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

add, getControl, getControls, getMessageId, hasControl, remove, setMessageId

Constructor Detail

BindResponse

public BindResponse()

Creates a new instance of BindResponseImpl.

Method Detail

getServerSaslCreds

public 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

public void setServerSaslCreds(byte[] credentials)

toString

public String toString()

Get a String representation of a BindResponse

Overrides:

toString in class AbstractResponseWithResult

Returns:

A BindResponse String