|
|||||||||
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.SearchResultReferenceProtocolOp
public class SearchResultReferenceProtocolOp
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 |
---|
public SearchResultReferenceProtocolOp(java.util.List<java.lang.String> referralURLs)
referralURLs
- The set of URLs for this search result reference.public SearchResultReferenceProtocolOp(SearchResultReference searchReference)
searchReference
- The search result reference object to use to
create this search result reference protocol op.Method Detail |
---|
public java.util.List<java.lang.String> getReferralURLs()
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 SearchResultReferenceProtocolOp decodeSearchReference(ASN1Element element) throws LDAPException
element
- The ASN.1 element to decode.
LDAPException
- If a problem occurs while decoding the provided
ASN.1 element as an LDAP search result reference
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |