org.opends.server.protocols.ldap
Class SearchResultEntryProtocolOp

java.lang.Object
  extended by org.opends.server.protocols.ldap.ProtocolOp
      extended by org.opends.server.protocols.ldap.SearchResultEntryProtocolOp

public class SearchResultEntryProtocolOp
extends ProtocolOp

This class defines the structures and methods for an LDAP search result entry protocol op, which is used to return entries that match the associated search criteria.


Constructor Summary
SearchResultEntryProtocolOp(DN dn)
          Creates a new LDAP search result entry protocol op with the specified DN and no attributes.
SearchResultEntryProtocolOp(DN dn, java.util.LinkedList<LDAPAttribute> attributes)
          Creates a new LDAP search result entry protocol op with the specified DN and set of attributes.
SearchResultEntryProtocolOp(SearchResultEntry searchEntry)
          Creates a new search result entry protocol op from the provided search result entry.
 
Method Summary
static SearchResultEntryProtocolOp decodeSearchEntry(ASN1Element element)
          Decodes the provided ASN.1 element as an LDAP search result entry protocol op.
 ASN1Element encode()
          Encodes this protocol op to an ASN.1 element suitable for including in an LDAP message.
 java.util.LinkedList<LDAPAttribute> getAttributes()
          Retrieves the set of attributes for this search result entry.
 DN getDN()
          Retrieves the DN for this search result entry.
 java.lang.String getProtocolOpName()
          Retrieves the name for this protocol op type.
 byte getType()
          Retrieves the BER type for this protocol op.
 void setDN(DN dn)
          Specifies the DN for this search result entry.
 void toLDIF(java.lang.StringBuilder buffer, int wrapColumn)
          Appends an LDIF representation of the entry to the provided buffer.
 SearchResultEntry toSearchResultEntry()
          Converts this protocol op to a search result entry.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this LDAP protocol op to the provided buffer.
 void toString(java.lang.StringBuilder buffer, int indent)
          Appends a multi-line string representation of this LDAP protocol op to the provided buffer.
 
Methods inherited from class org.opends.server.protocols.ldap.ProtocolOp
decode, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SearchResultEntryProtocolOp

public SearchResultEntryProtocolOp(DN dn)
Creates a new LDAP search result entry protocol op with the specified DN and no attributes.

Parameters:
dn - The DN for this search result entry.

SearchResultEntryProtocolOp

public SearchResultEntryProtocolOp(DN dn,
                                   java.util.LinkedList<LDAPAttribute> attributes)
Creates a new LDAP search result entry protocol op with the specified DN and set of attributes.

Parameters:
dn - The DN for this search result entry.
attributes - The set of attributes for this search result entry.

SearchResultEntryProtocolOp

public SearchResultEntryProtocolOp(SearchResultEntry searchEntry)
Creates a new search result entry protocol op from the provided search result entry.

Parameters:
searchEntry - The search result entry object to use to create this search result entry protocol op.
Method Detail

getDN

public DN getDN()
Retrieves the DN for this search result entry.

Returns:
The DN for this search result entry.

setDN

public void setDN(DN dn)
Specifies the DN for this search result entry.

Parameters:
dn - The DN for this search result entry.

getAttributes

public java.util.LinkedList<LDAPAttribute> getAttributes()
Retrieves the set of attributes for this search result entry. The returned list may be altered by the caller.

Returns:
The set of attributes for this search result entry.

getType

public byte getType()
Retrieves the BER type for this protocol op.

Specified by:
getType in class ProtocolOp
Returns:
The BER type for this protocol op.

getProtocolOpName

public java.lang.String getProtocolOpName()
Retrieves the name for this protocol op type.

Specified by:
getProtocolOpName in class ProtocolOp
Returns:
The name for this protocol op type.

encode

public ASN1Element encode()
Encodes this protocol op to an ASN.1 element suitable for including in an LDAP message.

Specified by:
encode in class ProtocolOp
Returns:
The ASN.1 element containing the encoded protocol op.

decodeSearchEntry

public static SearchResultEntryProtocolOp decodeSearchEntry(ASN1Element element)
                                                     throws LDAPException
Decodes the provided ASN.1 element as an LDAP search result entry protocol op.

Parameters:
element - The ASN.1 element to be decoded.
Returns:
The decoded search result entry protocol op.
Throws:
LDAPException - If a problem occurs while decoding the provided ASN.1 element as an LDAP search result entry protocol op.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op to the provided buffer.

Specified by:
toString in class ProtocolOp
Parameters:
buffer - The buffer to which the string should be appended.

toString

public void toString(java.lang.StringBuilder buffer,
                     int indent)
Appends a multi-line string representation of this LDAP protocol op to the provided buffer.

Specified by:
toString in class ProtocolOp
Parameters:
buffer - The buffer to which the information should be appended.
indent - The number of spaces from the margin that the lines should be indented.

toLDIF

public void toLDIF(java.lang.StringBuilder buffer,
                   int wrapColumn)
Appends an LDIF representation of the entry to the provided buffer.

Parameters:
buffer - The buffer to which the entry should be appended.
wrapColumn - The column at which long lines should be wrapped.

toSearchResultEntry

public SearchResultEntry toSearchResultEntry()
                                      throws LDAPException
Converts this protocol op to a search result entry.

Returns:
The search result entry created from this protocol op.
Throws:
LDAPException - If a problem occurs while trying to create the search result entry.