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: 912399 $, $Date: 2010-02-21 21:52:31 +0100(dom, 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

Constructors

Constructor and Description
ExtendedResponseCodec() Creates a new ExtendedResponse object.

Method Summary

Modifier and Type	Method and Description
protected int	computeLengthProtocolOp() 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
protected void	encodeProtocolOp(ByteBuffer buffer) Encode the ExtendedResponse message to a PDU.
MessageTypeEnum	getMessageType() Get the message type
String	getMessageTypeName() Get the message type Name
Object	getResponse() Get the extended response
String	getResponseName() Get the extended response name
void	setResponse(Object response) Set the extended response
void	setResponseName(OID responseName) Set the extended response name
String	toString() Get a String representation of an ExtendedResponse

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

computeLdapResultLength, encode, getLdapResponseLength, getLdapResult, setLdapResult

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

addControl, addControls, computeLength, encode, getCodecControl, getControls, getControls, getCurrentControl, getMessageId, 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

ExtendedResponseCodec

public ExtendedResponseCodec()

Creates a new ExtendedResponse object.

Method Detail

getMessageType

public MessageTypeEnum getMessageType()

Get the message type

Specified by:

getMessageType in class LdapMessageCodec

Returns:

Returns the type.

getMessageTypeName

public String getMessageTypeName()

Get the message type Name

Specified by:

getMessageTypeName in class LdapMessageCodec

Returns:

The message type name

getResponseName

public 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 Object getResponse()

Get the extended response

Returns:

Returns the response.

setResponse

public void setResponse(Object response)

Set the extended response

Parameters:

response - The response to set.

computeLengthProtocolOp

protected int computeLengthProtocolOp()

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:

computeLengthProtocolOp in class LdapMessageCodec

Returns:

The ExtendedResponse length

encodeProtocolOp

protected void encodeProtocolOp(ByteBuffer buffer)
                         throws EncoderException

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

Specified by:

encodeProtocolOp in class LdapMessageCodec

Parameters:

buffer - The buffer where to put the PDU

Throws:

EncoderException

toString

public String toString()

Get a String representation of an ExtendedResponse

Overrides:

toString in class LdapResponseCodec

Returns:

An ExtendedResponse String