org.opends.server.protocols.ldap
Class SearchResultReferenceProtocolOp

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

public class SearchResultReferenceProtocolOp
extends ProtocolOp

This class defines the structures and methods for an LDAP search result reference protocol op, which is used to indicate to the client that an alternate location or server may hold more matching entries.


Constructor Summary
SearchResultReferenceProtocolOp(java.util.List<java.lang.String> referralURLs)
          Creates a new search result reference protocol op with the provided set of referral URLs.
SearchResultReferenceProtocolOp(SearchResultReference searchReference)
          Creates a new search result reference protocol op from the provided search result reference object.
 
Method Summary
static SearchResultReferenceProtocolOp decodeSearchReference(ASN1Element element)
          Decodes the provided ASN.1 element as a search result reference protocol op.
 ASN1Element encode()
          Encodes this protocol op to an ASN.1 element suitable for including in an LDAP message.
 java.lang.String getProtocolOpName()
          Retrieves the name for this protocol op type.
 java.util.List<java.lang.String> getReferralURLs()
          Retrieves the set of referral URLs for this search result reference protocol op.
 byte getType()
          Retrieves the BER type for this protocol op.
 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

SearchResultReferenceProtocolOp

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

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

SearchResultReferenceProtocolOp

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

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

getReferralURLs

public java.util.List<java.lang.String> getReferralURLs()
Retrieves the set of referral URLs for this search result reference protocol op. The returned list may be altered by the caller.

Returns:
The set of referral URLs for this search result reference protocol op.

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.

decodeSearchReference

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

Parameters:
element - The ASN.1 element to decode.
Returns:
The decoded search result reference protocol op.
Throws:
LDAPException - If a problem occurs while decoding the provided ASN.1 element as an LDAP search result reference 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.