|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.protocols.ldap.ProtocolOp
org.opends.server.protocols.ldap.SearchResultEntryProtocolOp
public class SearchResultEntryProtocolOp
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 |
---|
public SearchResultEntryProtocolOp(DN dn)
dn
- The DN for this search result entry.public SearchResultEntryProtocolOp(DN dn, java.util.LinkedList<LDAPAttribute> attributes)
dn
- The DN for this search result entry.attributes
- The set of attributes for this search result entry.public SearchResultEntryProtocolOp(SearchResultEntry searchEntry)
searchEntry
- The search result entry object to use to create this
search result entry protocol op.Method Detail |
---|
public DN getDN()
public void setDN(DN dn)
dn
- The DN for this search result entry.public java.util.LinkedList<LDAPAttribute> getAttributes()
public byte getType()
getType
in class ProtocolOp
public java.lang.String getProtocolOpName()
getProtocolOpName
in class ProtocolOp
public ASN1Element encode()
encode
in class ProtocolOp
public static SearchResultEntryProtocolOp decodeSearchEntry(ASN1Element element) throws LDAPException
element
- The ASN.1 element to be decoded.
LDAPException
- If a problem occurs while decoding the provided
ASN.1 element as an LDAP search result entry
protocol op.public void toString(java.lang.StringBuilder buffer)
toString
in class ProtocolOp
buffer
- The buffer to which the string should be appended.public void toString(java.lang.StringBuilder buffer, int indent)
toString
in class ProtocolOp
buffer
- The buffer to which the information should be appended.indent
- The number of spaces from the margin that the lines should
be indented.public void toLDIF(java.lang.StringBuilder buffer, int wrapColumn)
buffer
- The buffer to which the entry should be appended.wrapColumn
- The column at which long lines should be wrapped.public SearchResultEntry toSearchResultEntry() throws LDAPException
LDAPException
- If a problem occurs while trying to create the
search result entry.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |