com.unboundid.ldap.protocol
Class SearchResultReferenceProtocolOp

java.lang.Object
  extended by com.unboundid.ldap.protocol.SearchResultReferenceProtocolOp
All Implemented Interfaces:
ProtocolOp, java.io.Serializable

@InternalUseOnly
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class SearchResultReferenceProtocolOp
extends java.lang.Object
implements ProtocolOp

This class provides an implementation of an LDAP search result reference protocol op.

See Also:
Serialized Form

Constructor Summary
SearchResultReferenceProtocolOp(java.util.List<java.lang.String> referralURLs)
          Creates a new search result reference protocol op with the provided information.
SearchResultReferenceProtocolOp(SearchResultReference reference)
          Creates a new search result reference protocol op from the provided search result reference.
 
Method Summary
static SearchResultReferenceProtocolOp decodeProtocolOp(ASN1Element element)
          Decodes the provided ASN.1 element as a search result reference protocol op.
 ASN1Element encodeProtocolOp()
          Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.
 byte getProtocolOpType()
          Retrieves the BER type for this protocol op.
 java.util.List<java.lang.String> getReferralURLs()
          Retrieves the list of referral URLs for this search result reference.
 SearchResultReference toSearchResultReference(Control... controls)
          Creates a search result reference 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SearchResultReferenceProtocolOp

public SearchResultReferenceProtocolOp(java.util.List<java.lang.String> referralURLs)
Creates a new search result reference protocol op with the provided information.

Parameters:
referralURLs - The list of referral URLs for this search result reference.

SearchResultReferenceProtocolOp

public SearchResultReferenceProtocolOp(SearchResultReference reference)
Creates a new search result reference protocol op from the provided search result reference.

Parameters:
reference - The search result reference to use to create this protocol op.
Method Detail

getReferralURLs

public java.util.List<java.lang.String> getReferralURLs()
Retrieves the list of referral URLs for this search result reference.

Returns:
The list of referral URLs for this search result reference.

getProtocolOpType

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

Specified by:
getProtocolOpType in interface ProtocolOp
Returns:
The BER type for this protocol op.

encodeProtocolOp

public ASN1Element encodeProtocolOp()
Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.

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

decodeProtocolOp

public static SearchResultReferenceProtocolOp decodeProtocolOp(ASN1Element element)
                                                        throws LDAPException
Decodes the provided ASN.1 element as a search result reference protocol op.

Parameters:
element - The ASN.1 element to be decoded.
Returns:
The decoded search result reference protocol op.
Throws:
LDAPException - If the provided ASN.1 element cannot be decoded as a search result reference protocol op.

writeTo

public void writeTo(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 interface ProtocolOp
Parameters:
buffer - The ASN.1 buffer to which the encoded representation should be written.

toSearchResultReference

public SearchResultReference toSearchResultReference(Control... controls)
Creates a search result reference from this protocol op.

Parameters:
controls - The set of controls to include in the search result reference. It may be empty or null if no controls should be included.
Returns:
The search result reference that was created.

toString

public java.lang.String toString()
Retrieves a string representation of this protocol op.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this 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 interface ProtocolOp
Parameters:
buffer - The buffer to which the string representation should be appended.