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: 764131 $, $Date: 2009-04-11 03:03:00 +0200 (Sam, 11 avr 2009) $,

Author:

Apache Directory Project

Field Summary

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

parent

Constructor Summary

BindResponseCodec()
Creates a new BindResponse object.

Method Summary

int	computeLength() Compute the BindResponse length BindResponse : 0x61 L1 | +--> LdapResult +--> [serverSaslCreds] L1 = Length(LdapResult) [ + Length(serverSaslCreds) ] Length(BindResponse) = Length(0x61) + Length(L1) + L1
java.nio.ByteBuffer	encode(java.nio.ByteBuffer buffer) Encode the BindResponse message to a PDU.
int	getMessageType() Get the message type
byte[]	getServerSaslCreds()
void	setServerSaslCreds(byte[] serverSaslCreds) Set the server sasl credentials
java.lang.String	toString() Get a String representation of a BindResponse

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

getLdapResponseLength, getLdapResult, setLdapResult

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

addControl, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getDelRequest, getDelResponse, getExtendedRequest, getExtendedResponse, getIntermediateResponse, getLdapResponse, getMessageId, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, initControls, setMessageId, setProtocolOP

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 int getMessageType()

Get the message type

Overrides:

getMessageType in class LdapMessageCodec

Returns:

Returns the type.

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.

computeLength

public int computeLength()

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

Specified by:

computeLength in interface Asn1Object

Overrides:

computeLength in class LdapResponseCodec

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws EncoderException

Encode the BindResponse message to a PDU. BindResponse : LdapResult.encode [0x87 LL serverSaslCreds]

Specified by:

encode in interface Asn1Object

Overrides:

encode in class LdapResponseCodec

Parameters:

buffer - The buffer where to put the PDU

Returns:

The PDU.

Throws:

EncoderException - If anything goes wrong.

toString

public java.lang.String toString()

Get a String representation of a BindResponse

Overrides:

toString in class LdapResponseCodec

Returns:

A BindResponse String