Package com.unboundid.ldap.protocol
Class SearchResultEntryProtocolOp
- java.lang.Object
-
- com.unboundid.ldap.protocol.SearchResultEntryProtocolOp
-
- All Implemented Interfaces:
ProtocolOp
,java.io.Serializable
@InternalUseOnly @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SearchResultEntryProtocolOp extends java.lang.Object implements ProtocolOp
This class provides an implementation of an LDAP search result entry protocol op.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SearchResultEntryProtocolOp(Entry entry)
Creates a new search result entry protocol op from the provided entry.SearchResultEntryProtocolOp(java.lang.String dn, java.util.List<Attribute> attributes)
Creates a new search result entry protocol op with the provided information.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SearchResultEntryProtocolOp
decodeProtocolOp(ASN1Element element)
Decodes the provided ASN.1 element as a search result entry protocol op.ASN1Element
encodeProtocolOp()
Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.java.util.List<Attribute>
getAttributes()
Retrieves the list of attributes for this search result entry.java.lang.String
getDN()
Retrieves the DN for this search result entry.byte
getProtocolOpType()
Retrieves the BER type for this protocol op.SearchResultEntry
toSearchResultEntry(Control... controls)
Creates a search result entry from this protocol op.java.lang.String
toString()
Retrieves a string representation of this protocol op.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op to the provided buffer.void
writeTo(ASN1Buffer buffer)
Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer.
-
-
-
Constructor Detail
-
SearchResultEntryProtocolOp
public SearchResultEntryProtocolOp(@NotNull java.lang.String dn, @NotNull java.util.List<Attribute> attributes)
Creates a new search result entry protocol op with the provided information.- Parameters:
dn
- The entry DN for this search result entry.attributes
- The list of attributes to include in this search result entry.
-
SearchResultEntryProtocolOp
public SearchResultEntryProtocolOp(@NotNull Entry entry)
Creates a new search result entry protocol op from the provided entry.- Parameters:
entry
- The entry to use to create this protocol op.
-
-
Method Detail
-
getDN
@NotNull public java.lang.String getDN()
Retrieves the DN for this search result entry.- Returns:
- The DN for this search result entry.
-
getAttributes
@NotNull public java.util.List<Attribute> getAttributes()
Retrieves the list of attributes for this search result entry.- Returns:
- The list of attributes for this search result entry.
-
getProtocolOpType
public byte getProtocolOpType()
Retrieves the BER type for this protocol op.- Specified by:
getProtocolOpType
in interfaceProtocolOp
- Returns:
- The BER type for this protocol op.
-
encodeProtocolOp
@NotNull public ASN1Element encodeProtocolOp()
Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.- Specified by:
encodeProtocolOp
in interfaceProtocolOp
- Returns:
- The ASN.1 element containing the encoded protocol op.
-
decodeProtocolOp
@NotNull public static SearchResultEntryProtocolOp decodeProtocolOp(@NotNull ASN1Element element) throws LDAPException
Decodes the provided ASN.1 element as a 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 the provided ASN.1 element cannot be decoded as a search result entry protocol op.
-
writeTo
public void writeTo(@NotNull ASN1Buffer buffer)
Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer. This method is intended for internal use only and should not be used by third-party code.- Specified by:
writeTo
in interfaceProtocolOp
- Parameters:
buffer
- The ASN.1 buffer to which the encoded representation should be written.
-
toSearchResultEntry
@NotNull public SearchResultEntry toSearchResultEntry(@Nullable Control... controls)
Creates a search result entry from this protocol op.- Parameters:
controls
- The set of controls to include in the search result entry. It may be empty ornull
if no controls should be included.- Returns:
- The search result entry that was created.
-
toString
@NotNull public java.lang.String toString()
Retrieves a string representation of this protocol op.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this protocol op.
-
toString
public void toString(@NotNull java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op to the provided buffer.- Specified by:
toString
in interfaceProtocolOp
- Parameters:
buffer
- The buffer to which the string representation should be appended.
-
-