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

java.lang.Object
  extended by org.apache.directory.shared.asn1.AbstractAsn1Object
      extended by org.apache.directory.shared.ldap.codec.LdapMessage
          extended by org.apache.directory.shared.ldap.codec.LdapResponse
              extended by org.apache.directory.shared.ldap.codec.bind.BindResponse
All Implemented Interfaces:
Asn1Object

public class BindResponse
extends LdapResponse

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: 664290 $, $Date: 2008-06-07 08:28:06 +0200 (Sa, 07 Jun 2008) $,
Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
parent
 
Constructor Summary
BindResponse()
          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.LdapResponse
getLdapResponseLength, getLdapResult, setLdapResult
 
Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessage
addControl, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getDelRequest, getDelResponse, getExtendedRequest, getExtendedResponse, 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

BindResponse

public BindResponse()
Creates a new BindResponse object.

Method Detail

getMessageType

public int getMessageType()
Get the message type

Overrides:
getMessageType in class LdapMessage
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 LdapResponse
Returns:
The object's computed length

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 LdapResponse
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 LdapResponse
Returns:
A BindResponse String


Copyright © 2003-2009 Apache Software Foundation. All Rights Reserved.