@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class AssuredReplicationResponseControl extends Control implements DecodeableControl
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only
supported for use against Ping Identity, UnboundID, and
Nokia/Alcatel-Lucent 8661 server products. These classes provide support
for proprietary functionality or for external specifications that are not
considered stable or mature enough to be guaranteed to work in an
interoperable way with other types of LDAP servers.
AssuredReplicationResponse ::= SEQUENCE { localLevel [0] LocalLevel OPTIONAL, localAssuranceSatisfied [1] BOOLEAN, localAssuranceMessage [2] OCTET STRING OPTIONAL, remoteLevel [3] RemoteLevel OPTIONAL, remoteAssuranceSatisfied [4] BOOLEAN, remoteAssuranceMessage [5] OCTET STRING OPTIONAL, csn [6] OCTET STRING OPTIONAL, serverResults [7] SEQUENCE OF ServerResult OPTIONAL, ... } ServerResult ::= SEQUENCE { resultCode [0] ENUMERATED { complete (0), timeout (1), conflict (2), serverShutdown (3), unavailable (4), duplicate (5), ... }, replicationServerID [1] INTEGER OPTIONAL, replicaID [2] INTEGER OPTIONAL, ... }
AssuredReplicationRequestControl
,
Serialized FormModifier and Type | Field and Description |
---|---|
static java.lang.String |
ASSURED_REPLICATION_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.5.29) for the assured replication response
control.
|
Constructor and Description |
---|
AssuredReplicationResponseControl(AssuredReplicationLocalLevel localLevel,
boolean localAssuranceSatisfied,
java.lang.String localAssuranceMessage,
AssuredReplicationRemoteLevel remoteLevel,
boolean remoteAssuranceSatisfied,
java.lang.String remoteAssuranceMessage,
java.lang.String csn,
java.util.Collection<AssuredReplicationServerResult> serverResults)
Creates a new assured replication response control with the provided
information.
|
AssuredReplicationResponseControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new assured replication response control with the provided
information.
|
Modifier and Type | Method and Description |
---|---|
AssuredReplicationResponseControl |
decodeControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new instance of this decodeable control from the provided
information.
|
static AssuredReplicationResponseControl |
get(LDAPResult result)
Extracts an assured replication response control from the provided LDAP
result.
|
static java.util.List<AssuredReplicationResponseControl> |
getAll(LDAPResult result)
Extracts all assured replication response controls from the provided LDAP
result.
|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available.
|
java.lang.String |
getCSN()
Retrieves the replication change sequence number (CSN) assigned to the
associated operation, if available.
|
java.lang.String |
getLocalAssuranceMessage()
Retrieves a message with additional information about local assurance
processing, if available.
|
AssuredReplicationLocalLevel |
getLocalLevel()
Retrieves the local assurance level selected by the server for the
associated operation, if available.
|
java.lang.String |
getRemoteAssuranceMessage()
Retrieves a message with additional information about remote assurance
processing, if available.
|
AssuredReplicationRemoteLevel |
getRemoteLevel()
Retrieves the remote assurance level selected by the server for the
associated operation, if available.
|
java.util.List<AssuredReplicationServerResult> |
getServerResults()
Retrieves a list of the results from individual replication servers and/or
directory servers used in assurance processing.
|
boolean |
localAssuranceSatisfied()
Indicates whether the desired local level of assurance is known to have
been satisfied.
|
boolean |
remoteAssuranceSatisfied()
Indicates whether the desired remote level of assurance is known to have
been satisfied.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided
buffer.
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
@NotNull public static final java.lang.String ASSURED_REPLICATION_RESPONSE_OID
public AssuredReplicationResponseControl(@Nullable AssuredReplicationLocalLevel localLevel, boolean localAssuranceSatisfied, @Nullable java.lang.String localAssuranceMessage, @Nullable AssuredReplicationRemoteLevel remoteLevel, boolean remoteAssuranceSatisfied, @Nullable java.lang.String remoteAssuranceMessage, @Nullable java.lang.String csn, @Nullable java.util.Collection<AssuredReplicationServerResult> serverResults)
localLevel
- The local assurance level selected by the
server for the associated operation. It
may be null
if this is not
available.localAssuranceSatisfied
- Indicates whether the desired local level
of assurance is known to have been
satisfied.localAssuranceMessage
- An optional message providing additional
information about local assurance
processing. This may be null
if
no additional message is needed.remoteLevel
- The remote assurance level selected by
the server for the associated operation.
It may be null
if this is not
available.remoteAssuranceSatisfied
- Indicates whether the desired remote
level of assurance is known to have been
satisfied.remoteAssuranceMessage
- An optional message providing additional
information about remote assurance
processing. This may be null
if
no additional message is needed.csn
- The change sequence number (CSN) that has
been assigned to the associated
operation. It may be null
if no
CSN is available.serverResults
- The set of individual results from the
local and/or remote replication servers
and/or directory servers used in
assurance processing. This may be
null
or empty if no server
results are available.public AssuredReplicationResponseControl(@NotNull java.lang.String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.LDAPException
- If the provided control cannot be decoded as an
assured replication response control.@NotNull public AssuredReplicationResponseControl decodeControl(@NotNull java.lang.String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.@Nullable public static AssuredReplicationResponseControl get(@NotNull LDAPResult result) throws LDAPException
result
- The LDAP result from which to retrieve the assured
replication response control.null
if the result did not contain an
assured replication response control.LDAPException
- If a problem is encountered while attempting to
decode the assured replication response control
contained in the provided result.@NotNull public static java.util.List<AssuredReplicationResponseControl> getAll(@NotNull LDAPResult result) throws LDAPException
result
- The LDAP result from which to retrieve the assured
replication response controls.LDAPException
- If a problem is encountered while attempting to
decode any assured replication response control
contained in the provided result.@Nullable public AssuredReplicationLocalLevel getLocalLevel()
null
if this is not available.public boolean localAssuranceSatisfied()
true
if the desired local level of assurance is known to
have been satisfied, or false
if not.@Nullable public java.lang.String getLocalAssuranceMessage()
null
if none is available.@Nullable public AssuredReplicationRemoteLevel getRemoteLevel()
null
if the remote assurance
level is not available.public boolean remoteAssuranceSatisfied()
true
if the desired remote level of assurance is known to
have been satisfied, or false
if not.@Nullable public java.lang.String getRemoteAssuranceMessage()
null
if none is available.@Nullable public java.lang.String getCSN()
null
if the CSN is not available.@NotNull public java.util.List<AssuredReplicationServerResult> getServerResults()
@NotNull public java.lang.String getControlName()
getControlName
in class Control