org.apache.directory.shared.ldap.codec.bind

Class BindResponseCodec

java.lang.Object

org.apache.directory.shared.asn1.AbstractAsn1Object

org.apache.directory.shared.ldap.codec.LdapMessageCodec

org.apache.directory.shared.ldap.codec.LdapResponseCodec

org.apache.directory.shared.ldap.codec.bind.BindResponseCodec

All Implemented Interfaces:

Asn1Object

public class BindResponseCodec
extends LdapResponseCodec

A BindResponse Message. Its syntax is : BindResponse ::= [APPLICATION 1] SEQUENCE { COMPONENTS OF LDAPResult, serverSaslCreds [7] OCTET STRING OPTIONAL } LdapResult ::= resultCode matchedDN errorMessage (referrals)*

Version:

$Rev: 912399 $, $Date: 2010-02-21 21:52:31 +0100(dom, 21 feb 2010) $,

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec

ldapMessageLength

Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

parent

Constructor Summary

Constructors

Constructor and Description
BindResponseCodec() Creates a new BindResponse object.

Method Summary

Modifier and Type	Method and Description
protected int	computeLengthProtocolOp() Compute the BindResponse length BindResponse :
protected void	encodeProtocolOp(ByteBuffer buffer) Encode the BindResponse message to a PDU.
MessageTypeEnum	getMessageType() Get the message type
String	getMessageTypeName() Get the message type Name
byte[]	getServerSaslCreds()
void	setServerSaslCreds(byte[] serverSaslCreds) Set the server sasl credentials
String	toString() Get a String representation of a BindResponse

Methods inherited from class org.apache.directory.shared.ldap.codec.LdapResponseCodec

computeLdapResultLength, encode, getLdapResponseLength, getLdapResult, setLdapResult

Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec

addControl, addControls, computeLength, encode, getCodecControl, getControls, getControls, getCurrentControl, getMessageId, initControls, setMessageId, toString

Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

addLength, getCurrentLength, getExpectedLength, getParent, getTlvId, setCurrentLength, setExpectedLength, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

BindResponseCodec

public BindResponseCodec()

Creates a new BindResponse object.

Method Detail

getMessageType

public MessageTypeEnum getMessageType()

Get the message type

Specified by:

getMessageType in class LdapMessageCodec

Returns:

Returns the type.

getMessageTypeName

public String getMessageTypeName()

Get the message type Name

Specified by:

getMessageTypeName in class LdapMessageCodec

Returns:

The message type name

getServerSaslCreds

public byte[] getServerSaslCreds()

Returns:

Returns the serverSaslCreds.

setServerSaslCreds

public void setServerSaslCreds(byte[] serverSaslCreds)

Set the server sasl credentials

Parameters:

serverSaslCreds - The serverSaslCreds to set.

computeLengthProtocolOp

protected int computeLengthProtocolOp()

Compute the BindResponse length BindResponse :

 0x61 L1 
   | 
   +--> LdapResult
   +--> [serverSaslCreds] 
   
 L1 = Length(LdapResult) [ + Length(serverSaslCreds) ] 
 Length(BindResponse) = Length(0x61) + Length(L1) + L1
 

Specified by:

computeLengthProtocolOp in class LdapMessageCodec

encodeProtocolOp

protected void encodeProtocolOp(ByteBuffer buffer)
                         throws EncoderException

Encode the BindResponse message to a PDU. BindResponse :

 LdapResult.encode 
 [0x87 LL serverSaslCreds]
 

Specified by:

encodeProtocolOp in class LdapMessageCodec

Parameters:

buffer - The buffer where to put the PDU

Throws:

EncoderException

toString

public String toString()

Get a String representation of a BindResponse

Overrides:

toString in class LdapResponseCodec

Returns:

A BindResponse String