|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.IntermediateResponse
com.unboundid.ldap.sdk.unboundidds.extensions.ChangelogEntryIntermediateResponse
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ChangelogEntryIntermediateResponse
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class provides an implementation of an intermediate response which provides information about a changelog entry returned from a Directory Server. The changelog entry intermediate response value is encoded as follows:
ChangelogEntryIntermediateResponse ::= SEQUENCE { resumeToken OCTET STRING, serverID OCTET STRING, changelogEntryDN LDAPDN, changelogEntryAttributes PartialAttributeList, ... }
Field Summary | |
---|---|
static java.lang.String |
CHANGELOG_ENTRY_INTERMEDIATE_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.6.11) for the get stream directory values intermediate response. |
Fields inherited from class com.unboundid.ldap.sdk.IntermediateResponse |
---|
TYPE_INTERMEDIATE_RESPONSE_OID, TYPE_INTERMEDIATE_RESPONSE_VALUE |
Constructor Summary | |
---|---|
ChangelogEntryIntermediateResponse(ChangeLogEntry changeLogEntry,
java.lang.String serverID,
ASN1OctetString resumeToken,
Control... controls)
Creates a new changelog entry intermediate response with the provided information. |
|
ChangelogEntryIntermediateResponse(IntermediateResponse r)
Creates a new changelog entry intermediate response from the provided generic intermediate response. |
Method Summary | |
---|---|
UnboundIDChangeLogEntry |
getChangeLogEntry()
Retrieves the changelog entry contained in this intermediate response. |
java.lang.String |
getIntermediateResponseName()
Retrieves the user-friendly name for the intermediate response, if available. |
ASN1OctetString |
getResumeToken()
Retrieves a token that may be used to resume the process of retrieving changes at the point immediately after this change. |
java.lang.String |
getServerID()
Retrieves the server ID for the server from which the changelog entry was retrieved. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this intermediate response to the provided buffer. |
java.lang.String |
valueToString()
Retrieves a human-readable string representation for the contents of the value for this intermediate response, if appropriate. |
Methods inherited from class com.unboundid.ldap.sdk.IntermediateResponse |
---|
getControl, getControls, getMessageID, getOID, getValue, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CHANGELOG_ENTRY_INTERMEDIATE_RESPONSE_OID
Constructor Detail |
---|
public ChangelogEntryIntermediateResponse(ChangeLogEntry changeLogEntry, java.lang.String serverID, ASN1OctetString resumeToken, Control... controls)
changeLogEntry
- The changelog entry included in this intermediate
response. It must not be null
.serverID
- The server ID for the server from which the
changelog entry was received. It must not be
null
.resumeToken
- A token that may be used to resume the process of
retrieving changes at the point immediately after
this change. It must not be null
.controls
- The set of controls to include in the response. It
may be null
or empty if no controls should
be included.public ChangelogEntryIntermediateResponse(IntermediateResponse r) throws LDAPException
r
- The generic intermediate response to be decoded.
LDAPException
- If the provided intermediate response cannot be
decoded as a changelog entry response.Method Detail |
---|
public UnboundIDChangeLogEntry getChangeLogEntry()
public java.lang.String getServerID()
public ASN1OctetString getResumeToken()
public java.lang.String getIntermediateResponseName()
null
will be returned.
getIntermediateResponseName
in class IntermediateResponse
null
if neither a user-friendly name
nor a response OID are available.public java.lang.String valueToString()
valueToString
in class IntermediateResponse
null
if there is
no value or no string representation is available.public void toString(java.lang.StringBuilder buffer)
toString
in interface LDAPResponse
toString
in class IntermediateResponse
buffer
- The buffer to which the string representation should be
appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |