org.apache.directory.shared.ldap.codec.extended
Class ExtendedResponseCodec

java.lang.Object
  org.apache.directory.shared.asn1.AbstractAsn1Object
      org.apache.directory.shared.ldap.codec.LdapMessageCodec
          org.apache.directory.shared.ldap.codec.LdapResponseCodec
              org.apache.directory.shared.ldap.codec.extended.ExtendedResponseCodec

All Implemented Interfaces:

Asn1Object

public class ExtendedResponseCodec
extends LdapResponseCodec

A ExtendedResponse Message. Its syntax is : ExtendedResponse ::= [APPLICATION 24] SEQUENCE { COMPONENTS OF LDAPResult, responseName [10] LDAPOID OPTIONAL, response [11] OCTET STRING OPTIONAL }

Version:

$Rev: 764131 $, $Date: 2009-04-11 03:03:00 +0200 (Sam, 11 avr 2009) $,

Author:

Apache Directory Project

Field Summary

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

parent

Constructor Summary

ExtendedResponseCodec()
Creates a new ExtendedResponse object.

Method Summary

int	computeLength() Compute the ExtendedResponse length ExtendedResponse : 0x78 L1 | +--> LdapResult [+--> 0x8A L2 name [+--> 0x8B L3 response]] L1 = Length(LdapResult) [ + Length(0x8A) + Length(L2) + L2 [ + Length(0x8B) + Length(L3) + L3]] Length(ExtendedResponse) = Length(0x78) + Length(L1) + L1
java.nio.ByteBuffer	encode(java.nio.ByteBuffer buffer) Encode the ExtendedResponse message to a PDU.
int	getMessageType() Get the message type
java.lang.Object	getResponse() Get the extended response
java.lang.String	getResponseName() Get the extended response name
void	setResponse(java.lang.Object response) Set the extended response
void	setResponseName(OID responseName) Set the extended response name
java.lang.String	toString() Get a String representation of an ExtendedResponse

Methods inherited from class org.apache.directory.shared.ldap.codec.LdapResponseCodec

getLdapResponseLength, getLdapResult, setLdapResult

Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec

addControl, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getDelRequest, getDelResponse, getExtendedRequest, getExtendedResponse, getIntermediateResponse, getLdapResponse, getMessageId, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, initControls, setMessageId, setProtocolOP

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

ExtendedResponseCodec

public ExtendedResponseCodec()

Creates a new ExtendedResponse object.

Method Detail

getMessageType

public int getMessageType()

Get the message type

Overrides:

getMessageType in class LdapMessageCodec

Returns:

Returns the type.

getResponseName

public java.lang.String getResponseName()

Get the extended response name

Returns:

Returns the name.

setResponseName

public void setResponseName(OID responseName)

Set the extended response name

Parameters:

responseName - The name to set.

getResponse

public java.lang.Object getResponse()

Get the extended response

Returns:

Returns the response.

setResponse

public void setResponse(java.lang.Object response)

Set the extended response

Parameters:

response - The response to set.

computeLength

public int computeLength()

Compute the ExtendedResponse length ExtendedResponse : 0x78 L1 | +--> LdapResult [+--> 0x8A L2 name [+--> 0x8B L3 response]] L1 = Length(LdapResult) [ + Length(0x8A) + Length(L2) + L2 [ + Length(0x8B) + Length(L3) + L3]] Length(ExtendedResponse) = Length(0x78) + Length(L1) + L1

Specified by:

computeLength in interface Asn1Object

Overrides:

computeLength in class LdapResponseCodec

Returns:

The ExtendedResponse length

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws EncoderException

Encode the ExtendedResponse message to a PDU. ExtendedResponse : LdapResult.encode() [0x8A LL response name] [0x8B LL response]

Specified by:

encode in interface Asn1Object

Overrides:

encode in class LdapResponseCodec

Parameters:

buffer - The buffer where to put the PDU

Returns:

The PDU.

Throws:

EncoderException - If anything goes wrong.

toString

public java.lang.String toString()

Get a String representation of an ExtendedResponse

Overrides:

toString in class LdapResponseCodec

Returns:

An ExtendedResponse String