Package com.unboundid.ldap.protocol
Class SearchResultDoneProtocolOp
- java.lang.Object
-
- com.unboundid.ldap.protocol.GenericResponseProtocolOp
-
- com.unboundid.ldap.protocol.SearchResultDoneProtocolOp
-
- All Implemented Interfaces:
ProtocolOp
,java.io.Serializable
@InternalUseOnly @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SearchResultDoneProtocolOp extends GenericResponseProtocolOp
This class provides an implementation of a search result done protocol op.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.unboundid.ldap.protocol.GenericResponseProtocolOp
TYPE_REFERRALS
-
-
Constructor Summary
Constructors Constructor Description SearchResultDoneProtocolOp(int resultCode, java.lang.String matchedDN, java.lang.String diagnosticMessage, java.util.List<java.lang.String> referralURLs)
Creates a new instance of this search result done protocol op with the provided information.SearchResultDoneProtocolOp(LDAPResult result)
Creates a new search result done protocol op from the provided LDAP result object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SearchResultDoneProtocolOp
decodeProtocolOp(ASN1Element element)
Decodes the provided ASN.1 element as a search result done protocol op.ASN1Element
encodeProtocolOp()
Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.-
Methods inherited from class com.unboundid.ldap.protocol.GenericResponseProtocolOp
getDiagnosticMessage, getMatchedDN, getProtocolOpType, getReferralURLs, getResultCode, toLDAPResult, toString, toString, writeTo
-
-
-
-
Constructor Detail
-
SearchResultDoneProtocolOp
public SearchResultDoneProtocolOp(int resultCode, java.lang.String matchedDN, java.lang.String diagnosticMessage, java.util.List<java.lang.String> referralURLs)
Creates a new instance of this search result done protocol op with the provided information.- Parameters:
resultCode
- The result code for this search result done.matchedDN
- The matched DN for this search result done, if any.diagnosticMessage
- The diagnostic message for this search result done, if any.referralURLs
- The list of referral URLs for this search result done, if any.
-
SearchResultDoneProtocolOp
public SearchResultDoneProtocolOp(LDAPResult result)
Creates a new search result done protocol op from the provided LDAP result object.- Parameters:
result
- The LDAP result object to use to create this protocol op.
-
-
Method Detail
-
encodeProtocolOp
public ASN1Element encodeProtocolOp()
Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.- Returns:
- The ASN.1 element containing the encoded protocol op.
-
decodeProtocolOp
public static SearchResultDoneProtocolOp decodeProtocolOp(ASN1Element element) throws LDAPException
Decodes the provided ASN.1 element as a search result done protocol op.- Parameters:
element
- The ASN.1 element to be decoded.- Returns:
- The decoded search result done protocol op.
- Throws:
LDAPException
- If the provided ASN.1 element cannot be decoded as a search result done protocol op.
-
-