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

java.lang.Object
  extended by org.apache.directory.shared.asn1.AbstractAsn1Object
      extended by org.apache.directory.shared.ldap.codec.LdapMessageCodec
          extended by org.apache.directory.shared.ldap.codec.LdapResponseCodec
All Implemented Interfaces:
Asn1Object
Direct Known Subclasses:
AddResponseCodec, BindResponseCodec, CompareResponseCodec, DelResponseCodec, ErrorResponse, ExtendedResponseCodec, IntermediateResponseCodec, ModifyDNResponseCodec, ModifyResponseCodec, SearchResponse, SearchResultDoneCodec

public abstract class LdapResponseCodec
extends LdapMessageCodec

A generic LdapResponse Object. It will contain the LdapResult.

Version:
$Rev: 912399 $, $Date: 2010-02-21 21:52:31 +0100 (Sun, 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
LdapResponseCodec()
          Creates a new LdapResponse object.
 
Method Summary
 int computeLdapResultLength()
          Compute the LdapResponse length
 java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
          Encode the AddResponse message to a PDU.
 int getLdapResponseLength()
           
 LdapResultCodec getLdapResult()
          Get the LdapResult
 void setLdapResult(LdapResultCodec ldapResult)
          Set the ldap result
 java.lang.String toString()
          Get a String representation of an Response
 
Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec
addControl, addControls, computeLength, computeLengthProtocolOp, encode, encodeProtocolOp, getCodecControl, getControls, getControls, getCurrentControl, getMessageId, getMessageType, getMessageTypeName, 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

LdapResponseCodec

public LdapResponseCodec()
Creates a new LdapResponse object.

Method Detail

getLdapResult

public LdapResultCodec getLdapResult()
Get the LdapResult

Returns:
Returns the ldapResult.

setLdapResult

public void setLdapResult(LdapResultCodec ldapResult)
Set the ldap result

Parameters:
ldapResult - The ldapResult to set.

getLdapResponseLength

public int getLdapResponseLength()
Returns:
Returns the ldapResponseLength.

computeLdapResultLength

public int computeLdapResultLength()
Compute the LdapResponse length


encode

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

Specified by:
encode in interface Asn1Object
Overrides:
encode in class AbstractAsn1Object
Parameters:
buffer - The buffer where to put the PDU
Returns:
The PDU.
Throws:
EncoderException - if the buffer can't be encoded

toString

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

Overrides:
toString in class java.lang.Object
Returns:
An Response String


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