|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.asn1.AbstractAsn1Object
org.apache.directory.shared.ldap.codec.LdapMessageCodec
org.apache.directory.shared.ldap.codec.search.SearchResultEntryCodec
public class SearchResultEntryCodec
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.
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 | |
---|---|
SearchResultEntryCodec()
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 |
protected int |
computeLengthProtocolOp()
Compute the SearchResultEntry length SearchResultEntry : |
protected void |
encodeProtocolOp(java.nio.ByteBuffer buffer)
Encode the SearchResultEntry message to a PDU. |
java.lang.String |
getCurrentAttributeValueType()
|
Entry |
getEntry()
Get the entry. |
MessageTypeEnum |
getMessageType()
Get the message type |
java.lang.String |
getMessageTypeName()
Get the message type Name |
DN |
getObjectName()
Get the entry DN |
void |
setEntry(Entry entry)
Sets the entry. |
void |
setObjectName(DN 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.LdapMessageCodec |
---|
addControl, addControls, computeLength, encode, getCodecControl, getControls, getControls, getCurrentControl, getMessageId, initControls, setMessageId, toString |
Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object |
---|
addLength, encode, 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 |
---|
public SearchResultEntryCodec()
Method Detail |
---|
public MessageTypeEnum getMessageType()
getMessageType
in class LdapMessageCodec
public java.lang.String getMessageTypeName()
getMessageTypeName
in class LdapMessageCodec
public DN getObjectName()
public void setObjectName(DN objectName)
objectName
- The objectName to set.public Entry getEntry()
public void setEntry(Entry entry)
entry
- the entrypublic void addAttributeValues(java.lang.String type)
type
- The attribute's namepublic void addAttributeValue(java.lang.Object value)
value
- protected int computeLengthProtocolOp()
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
computeLengthProtocolOp
in class LdapMessageCodec
protected void encodeProtocolOp(java.nio.ByteBuffer buffer) throws EncoderException
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
encodeProtocolOp
in class LdapMessageCodec
buffer
- The buffer where to put the PDU
EncoderException
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getCurrentAttributeValueType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |