org.apache.directory.shared.ldap.codec.search
Class SearchResultEntry

java.lang.Object
  extended by org.apache.directory.shared.asn1.AbstractAsn1Object
      extended by org.apache.directory.shared.ldap.codec.LdapMessage
          extended by org.apache.directory.shared.ldap.codec.search.SearchResultEntry
All Implemented Interfaces:
Asn1Object

public class SearchResultEntry
extends LdapMessage

A SearchResultEntry Message. Its syntax is : SearchResultEntry ::= [APPLICATION 4] SEQUENCE { objectName LDAPDN, attributes PartialAttributeList } PartialAttributeList ::= SEQUENCE OF SEQUENCE { type AttributeDescription, vals SET OF AttributeValue } AttributeDescription ::= LDAPString AttributeValue ::= OCTET STRING It contains an entry, with all its attributes, and all the attributes values. If a search request is submited, all the results are sent one by one, followed by a searchResultDone message.

Version:
$Rev: 693466 $, $Date: 2008-09-09 16:07:18 +0200 (Di, 09 Sep 2008) $,
Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
parent
 
Constructor Summary
SearchResultEntry()
          Creates a new SearchResultEntry object.
 
Method Summary
 void addAttributeValue(java.lang.Object value)
          Add a new value to the current attribute
 void addAttributeValues(java.lang.String type)
          Create a new attributeValue
 int computeLength()
          Compute the SearchResultEntry length SearchResultEntry : 0x64 L1 | +--> 0x04 L2 objectName +--> 0x30 L3 (attributes) | +--> 0x30 L4-1 (partial attributes list) | | | +--> 0x04 L5-1 type | +--> 0x31 L6-1 (values) | | | +--> 0x04 L7-1-1 value | +--> ...
 java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
          Encode the SearchResultEntry message to a PDU.
 java.lang.String getCurrentAttributeValueType()
           
 Entry getEntry()
          Get the entry.
 int getMessageType()
          Get the message type
 LdapDN getObjectName()
          Get the entry DN
 void setEntry(Entry entry)
          Sets the entry.
 void setObjectName(LdapDN objectName)
          Set the entry DN.
 java.lang.String toString()
          Returns the Search Result Entry string
 
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, 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

SearchResultEntry

public SearchResultEntry()
Creates a new SearchResultEntry object.

Method Detail

getMessageType

public int getMessageType()
Get the message type

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

getObjectName

public LdapDN getObjectName()
Get the entry DN

Returns:
Returns the objectName.

setObjectName

public void setObjectName(LdapDN objectName)
Set the entry DN.

Parameters:
objectName - The objectName to set.

getEntry

public Entry getEntry()
Get the entry.

Returns:
Returns the entry

setEntry

public void setEntry(Entry entry)
Sets the entry.

Parameters:
entry - the entry

addAttributeValues

public void addAttributeValues(java.lang.String type)
Create a new attributeValue

Parameters:
type - The attribute's name

addAttributeValue

public void addAttributeValue(java.lang.Object value)
Add a new value to the current attribute

Parameters:
value -

computeLength

public int computeLength()
Compute the SearchResultEntry length SearchResultEntry : 0x64 L1 | +--> 0x04 L2 objectName +--> 0x30 L3 (attributes) | +--> 0x30 L4-1 (partial attributes list) | | | +--> 0x04 L5-1 type | +--> 0x31 L6-1 (values) | | | +--> 0x04 L7-1-1 value | +--> ... | +--> 0x04 L7-1-n value | +--> 0x30 L4-2 (partial attributes list) | | | +--> 0x04 L5-2 type | +--> 0x31 L6-2 (values) | | | +--> 0x04 L7-2-1 value | +--> ... | +--> 0x04 L7-2-n value | +--> ... | +--> 0x30 L4-m (partial attributes list) | +--> 0x04 L5-m type +--> 0x31 L6-m (values) | +--> 0x04 L7-m-1 value +--> ... +--> 0x04 L7-m-n value

Specified by:
computeLength in interface Asn1Object
Overrides:
computeLength in class LdapMessage
Returns:
The object's computed length

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws EncoderException
Encode the SearchResultEntry message to a PDU. SearchResultEntry : 0x64 LL 0x04 LL objectName 0x30 LL attributes 0x30 LL partialAttributeList 0x04 LL type 0x31 LL vals 0x04 LL attributeValue ... 0x04 LL attributeValue ... 0x30 LL partialAttributeList 0x04 LL type 0x31 LL vals 0x04 LL attributeValue ... 0x04 LL attributeValue

Specified by:
encode in interface Asn1Object
Overrides:
encode in class LdapMessage
Parameters:
buffer - The buffer where to put the PDU
Returns:
The PDU.
Throws:
EncoderException - If anything goes wrong.

toString

public java.lang.String toString()
Returns the Search Result Entry string

Overrides:
toString in class LdapMessage
Returns:
The Search Result Entry string

getCurrentAttributeValueType

public java.lang.String getCurrentAttributeValueType()
Returns:
Returns the currentAttributeValue.


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.