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

java.lang.Object
  extended byorg.apache.directory.shared.asn1.Asn1Object
      extended byorg.apache.directory.shared.ldap.codec.LdapMessage
          extended byorg.apache.directory.shared.ldap.codec.LdapResponse
              extended byorg.apache.directory.shared.ldap.codec.bind.BindResponse

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)*

Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.asn1.Asn1Object
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, initControl, setMessageId, setProtocolOP
 
Methods inherited from class org.apache.directory.shared.asn1.Asn1Object
addLength, getCurrentLength, getExpectedLength, getParent, 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

Overrides:
computeLength in class LdapResponse

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws org.apache.directory.shared.asn1.codec.EncoderException
Encode the BindResponse message to a PDU. BindResponse : LdapResult.encode [0x87 LL serverSaslCreds]

Overrides:
encode in class LdapResponse
Parameters:
buffer - The buffer where to put the PDU
Returns:
The PDU.
Throws:
org.apache.directory.shared.asn1.codec.EncoderException

toString

public java.lang.String toString()
Get a String representation of a BindResponse

Overrides:
toString in class LdapResponse
Returns:
A BindResponse String


Copyright © 2003-2006 . All Rights Reserved.