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

Class BindResponseImpl

java.lang.Object

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

org.apache.directory.api.ldap.model.message.AbstractResponse

org.apache.directory.api.ldap.model.message.AbstractResultResponse

org.apache.directory.api.ldap.model.message.BindResponseImpl

All Implemented Interfaces:

BindResponse, Message, Response, ResultResponse

Direct Known Subclasses:

BindNoDResponse

public class BindResponseImpl
extends AbstractResultResponse
implements BindResponse

BindResponse implementation.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static long	serialVersionUID
private byte[]	serverSaslCreds optional property holding SASL authentication response parameters

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractResultResponse

ldapResult

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

controls

Constructor Summary

Constructors

Constructor and Description
BindResponseImpl() Creates a BindResponse as a reply to an BindRequest.
BindResponseImpl(int id) Creates a BindResponse as a reply to an BindRequest.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Checks to see if this BindResponse is equal to another BindResponse.
byte[]	getServerSaslCreds() Gets the optional property holding SASL authentication response paramters that are SASL mechanism specific.
int	hashCode()
void	setServerSaslCreds(byte[] serverSaslCreds) Sets the optional property holding SASL authentication response paramters that are SASL mechanism specific.
String	toString() Get a String representation of a BindResponse

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractResultResponse

getLdapResult

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

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

Methods inherited from class java.lang.Object

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

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

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

serverSaslCreds

private byte[] serverSaslCreds

optional property holding SASL authentication response parameters

Constructor Detail

BindResponseImpl

public BindResponseImpl()

Creates a BindResponse as a reply to an BindRequest.

BindResponseImpl

public BindResponseImpl(int id)

Creates a BindResponse as a reply to an BindRequest.

Parameters:

id - the session unique message id

Method Detail

getServerSaslCreds

public byte[] getServerSaslCreds()

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

Specified by:

getServerSaslCreds in interface BindResponse

Returns:

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

setServerSaslCreds

public 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.

Specified by:

setServerSaslCreds in interface BindResponse

Parameters:

serverSaslCreds - the sasl auth. mech. specific credentials

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractResultResponse

Returns:

the instance's hash code

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Checks to see if this BindResponse is equal to another BindResponse. The implementation and lockable properties are not factored into the evaluation of equality. Only the messageId, saslCredentials and the LdapResults of this BindResponse PDU and the compared object are taken into account if that object also implements the BindResponse interface.

Overrides:

equals in class AbstractResultResponse

Parameters:

obj - the object to test for equality with this BindResponse

Returns:

true if obj equals this BindResponse false otherwise

toString

public String toString()

Get a String representation of a BindResponse

Overrides:

toString in class AbstractResultResponse

Returns:

A BindResponse String