org.apache.directory.shared.ldap.codec

Class LdapResultCodec

java.lang.Object

org.apache.directory.shared.asn1.AbstractAsn1Object

org.apache.directory.shared.ldap.codec.LdapResultCodec

All Implemented Interfaces:

Asn1Object

public class LdapResultCodec
extends AbstractAsn1Object

A ldapObject to store the LdapResult

Version:

$Rev: 921600 $, $Date: 2010-03-10 23:37:30 +0100(mer, 10 mar 2010) $,

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

parent

Constructor Summary

Constructors

Constructor and Description
LdapResultCodec() Creates a new LdapResult object.

Method Summary

Modifier and Type	Method and Description
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 +--> ...
ByteBuffer	encode(ByteBuffer buffer) Encode the LdapResult message to a PDU.
String	getErrorMessage() Get the error message
String	getMatchedDN() Get the matched DN
List<LdapURL>	getReferrals() Get the referrals
ResultCodeEnum	getResultCode() Get the result code
void	initReferrals() Initialize the referrals list
void	setErrorMessage(String errorMessage) Set the error message
void	setMatchedDN(DN matchedDN) Set the Matched DN
void	setResultCode(ResultCodeEnum resultCode) Set the result code
String	toString() Get a String representation of a LdapResult

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

LdapResultCodec

public LdapResultCodec()

Creates a new LdapResult object.

Method Detail

initReferrals

public void initReferrals()

Initialize the referrals list

getErrorMessage

public String getErrorMessage()

Get the error message

Returns:

Returns the errorMessage.

setErrorMessage

public void setErrorMessage(String errorMessage)

Set the error message

Parameters:

errorMessage - The errorMessage to set.

getMatchedDN

public String getMatchedDN()

Get the matched DN

Returns:

Returns the matchedDN.

setMatchedDN

public void setMatchedDN(DN matchedDN)

Set the Matched DN

Parameters:

matchedDN - The matchedDN to set.

getReferrals

public List<LdapURL> 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 ResultCodeEnum getResultCode()

Get the result code

Returns:

Returns the resultCode.

setResultCode

public void setResultCode(ResultCodeEnum 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

Specified by:

computeLength in interface Asn1Object

Specified by:

computeLength in class AbstractAsn1Object

Returns:

The object's computed length

encode

public ByteBuffer encode(ByteBuffer buffer)
                  throws EncoderException

Encode the LdapResult 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 String toString()

Get a String representation of a LdapResult

Overrides:

toString in class Object

Returns:

A LdapResult String