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

java.lang.Object
  extended byorg.apache.directory.shared.asn1.Asn1Object
      extended byorg.apache.directory.shared.ldap.codec.LdapResult

public class LdapResult
extends org.apache.directory.shared.asn1.Asn1Object

A ldapObject to store the LdapResult

Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.asn1.Asn1Object
parent
 
Constructor Summary
LdapResult()
          Creates a new BindResponse object.
 
Method Summary
 void addReferral(LdapURL referral)
          Add a referral
 int computeLength()
          Compute the LdapResult length LdapResult : 0x0A 01 resultCode (0..80) 0x04 L1 matchedDN (L1 = Length(matchedDN)) 0x04 L2 errorMessage (L2 = Length(errorMessage)) [0x83 L3] referrals | +--> 0x04 L4 referral +--> 0x04 L5 referral +--> ...
 java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
          Encode the LdapResult message to a PDU.
 java.lang.String getErrorMessage()
          Get the error message
 java.lang.String getMatchedDN()
          Get the matched DN
 java.util.ArrayList getReferrals()
          Get the referrals
 int getResultCode()
          Get the result code
 void setErrorMessage(LdapString errorMessage)
          Set the error message
 void setMatchedDN(LdapDN matchedDN)
          Set the Matched DN
 void setResultCode(int resultCode)
          Set the result code
 java.lang.String toString()
          Get a String representation of a LdapResult
 
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

LdapResult

public LdapResult()
Creates a new BindResponse object.

Method Detail

getErrorMessage

public java.lang.String getErrorMessage()
Get the error message

Returns:
Returns the errorMessage.

setErrorMessage

public void setErrorMessage(LdapString errorMessage)
Set the error message

Parameters:
errorMessage - The errorMessage to set.

getMatchedDN

public java.lang.String getMatchedDN()
Get the matched DN

Returns:
Returns the matchedDN.

setMatchedDN

public void setMatchedDN(LdapDN matchedDN)
Set the Matched DN

Parameters:
matchedDN - The matchedDN to set.

getReferrals

public java.util.ArrayList getReferrals()
Get the referrals

Returns:
Returns the referrals.

addReferral

public void addReferral(LdapURL referral)
Add a referral

Parameters:
referral - The referral to add.

getResultCode

public int getResultCode()
Get the result code

Returns:
Returns the resultCode.

setResultCode

public void setResultCode(int resultCode)
Set the result code

Parameters:
resultCode - The resultCode to set.

computeLength

public int computeLength()
Compute the LdapResult length LdapResult : 0x0A 01 resultCode (0..80) 0x04 L1 matchedDN (L1 = Length(matchedDN)) 0x04 L2 errorMessage (L2 = Length(errorMessage)) [0x83 L3] referrals | +--> 0x04 L4 referral +--> 0x04 L5 referral +--> ... +--> 0x04 Li referral +--> ... +--> 0x04 Ln referral L1 = Length(matchedDN) L2 = Length(errorMessage) L3 = n*Length(0x04) + sum(Length(L4) .. Length(Ln)) + sum(L4..Ln) L4..n = Length(0x04) + Length(Li) + Li Length(LdapResult) = Length(0x0x0A) + Length(0x01) + 1 + Length(0x04) + Length(L1) + L1 + Length(0x04) + Length(L2) + L2 + Length(0x83) + Length(L3) + L3


encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws org.apache.directory.shared.asn1.codec.EncoderException
Encode the LdapResult message to a PDU.

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 LdapResult

Returns:
A LdapResult String


Copyright © 2003-2006 . All Rights Reserved.