org.apache.directory.shared.ldap.codec
Class LdapResponse

java.lang.Object
  extended by org.apache.directory.shared.asn1.Asn1Object
      extended by org.apache.directory.shared.ldap.codec.LdapMessage
          extended by org.apache.directory.shared.ldap.codec.LdapResponse
Direct Known Subclasses:
AddResponse, BindResponse, CompareResponse, DelResponse, ExtendedResponse, ModifyDNResponse, ModifyResponse, SearchResultDone

public class LdapResponse
extends LdapMessage

A generic LdapResponse Object. It will contain the LdapResult.

Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.asn1.Asn1Object
parent
 
Constructor Summary
LdapResponse()
          Creates a new LdapResponse object.
 
Method Summary
 int computeLength()
          Compute the LdapResponse length LdapResponse : LdapResult
 ByteBuffer encode(ByteBuffer buffer)
          Encode the AddResponse message to a PDU.
 int getLdapResponseLength()
           
 LdapResult getLdapResult()
          Get the LdapResult
 void setLdapResult(LdapResult ldapResult)
          Set the ldap result
 String toString()
          Get a String representation of an Response
 
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, getMessageType, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, initControls, setMessageId, setProtocolOP
 
Methods inherited from class org.apache.directory.shared.asn1.Asn1Object
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

LdapResponse

public LdapResponse()
Creates a new LdapResponse object.

Method Detail

getLdapResult

public LdapResult getLdapResult()
Get the LdapResult

Returns:
Returns the ldapResult.

setLdapResult

public void setLdapResult(LdapResult ldapResult)
Set the ldap result

Parameters:
ldapResult - The ldapResult to set.

getLdapResponseLength

public int getLdapResponseLength()
Returns:
Returns the ldapResponseLength.

computeLength

public int computeLength()
Compute the LdapResponse length LdapResponse : LdapResult

Overrides:
computeLength in class LdapMessage
Returns:
The object's computed length

encode

public ByteBuffer encode(ByteBuffer buffer)
                  throws EncoderException
Encode the AddResponse message to a PDU.

Overrides:
encode in class LdapMessage
Parameters:
buffer - The buffer where to put the PDU
Returns:
The PDU.
Throws:
EncoderException - If anything goes wrong.

toString

public String toString()
Get a String representation of an Response

Overrides:
toString in class LdapMessage
Returns:
An Response String


Copyright © 2004-2012. All Rights Reserved.