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

java.lang.Object
  extended byorg.apache.directory.shared.asn1.Asn1Object
      extended byorg.apache.directory.shared.ldap.codec.LdapMessage
          extended byorg.apache.directory.shared.ldap.codec.LdapResponse
              extended byorg.apache.directory.shared.ldap.codec.extended.ExtendedResponse

public class ExtendedResponse
extends LdapResponse

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

Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.asn1.Asn1Object
parent
 
Constructor Summary
ExtendedResponse()
          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(org.apache.directory.shared.asn1.primitives.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.LdapResponse
getLdapResponseLength, getLdapResult, setLdapResult
 
Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessage
addControl, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getDelRequest, getDelResponse, getExtendedRequest, getExtendedResponse, getLdapResponse, getMessageId, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, initControl, setMessageId, setProtocolOP
 
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

ExtendedResponse

public ExtendedResponse()
Creates a new ExtendedResponse object.

Method Detail

getMessageType

public int getMessageType()
Get the message type

Overrides:
getMessageType in class LdapMessage
Returns:
Returns the type.

getResponseName

public java.lang.String getResponseName()
Get the extended response name

Returns:
Returns the name.

setResponseName

public void setResponseName(org.apache.directory.shared.asn1.primitives.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

Overrides:
computeLength in class LdapResponse
Returns:
The ExtendedResponse length

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws org.apache.directory.shared.asn1.codec.EncoderException
Encode the ExtendedResponse message to a PDU. ExtendedResponse : LdapResult.encode() [0x8A LL response name] [0x8B LL response]

Overrides:
encode in class LdapResponse
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 an ExtendedResponse

Overrides:
toString in class LdapResponse
Returns:
An ExtendedResponse String


Copyright © 2003-2006 . All Rights Reserved.