com.unboundid.ldap.sdk.unboundidds.controls.AssuredReplicationRequestControl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation
Show all versions of unboundid-ldapsdk Show documentation
The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use
Java API for communicating with LDAP directory servers and performing
related tasks like reading and writing LDIF, encoding and decoding data
using base64 and ASN.1 BER, and performing secure communication. This
package contains the Standard Edition of the LDAP SDK, which is a
complete, general-purpose library for communicating with LDAPv3 directory
servers.
/*
* Copyright 2013-2018 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright (C) 2015-2018 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk.unboundidds.controls;
import java.util.ArrayList;
import com.unboundid.asn1.ASN1Boolean;
import com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1Enumerated;
import com.unboundid.asn1.ASN1Long;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.asn1.ASN1Sequence;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.util.Debug;
import com.unboundid.util.NotMutable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import static com.unboundid.ldap.sdk.unboundidds.controls.ControlMessages.*;
/**
* This class provides an implementation of an LDAP control that can be included
* in add, bind, modify, modify DN, and certain extended requests to indicate
* the level of replication assurance desired for the associated operation.
*
*
* NOTE: This class, and other classes within the
* {@code 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.
*
*
* The OID for this control is 1.3.6.1.4.1.30221.2.5.28, and it may have a
* criticality of either TRUE or FALSE. It must have a value with the following
* encoding:
*
* AssuredReplicationRequest ::= SEQUENCE {
* minimumLocalLevel [0] LocalLevel OPTIONAL,
* maximumLocalLevel [1] LocalLevel OPTIONAL,
* minimumRemoteLevel [2] RemoteLevel OPTIONAL,
* maximumRemoteLevel [3] RemoteLevel OPTIONAL,
* timeoutMillis [4] INTEGER (1 .. 2147483647) OPTIONAL,
* sendResponseImmediately [5] BOOLEAN DEFAULT FALSE,
* ... }
*
* LocalLevel ::= ENUMERATED {
* none (0),
* receivedAnyServer (1),
* processedAllServers (2),
* ... }
*
* RemoteLevel ::= ENUMERATED {
* none (0),
* receivedAnyRemoteLocation (1),
* receivedAllRemoteLocations (2),
* processedAllRemoteServers (3),
* ... }
*
*
* Example
* The following example demonstrates the use of the assured replication request
* control in conjunction with a delete operation to request that the server not
* return the delete result to the client until the delete has been applied to
* all available servers in the local data center and has also been replicated
* to at least one remote data center:
*
* DeleteRequest deleteRequest = new DeleteRequest(
* "uid=test.user,ou=People,dc=example,dc=com");
* deleteRequest.addControl(new AssuredReplicationRequestControl(
* AssuredReplicationLocalLevel.PROCESSED_ALL_SERVERS,
* AssuredReplicationRemoteLevel.RECEIVED_ANY_REMOTE_LOCATION,
* 5000L));
* LDAPResult deleteResult = connection.delete(deleteRequest);
*
* if (deleteResult.getResultCode() == ResultCode.SUCCESS)
* {
* AssuredReplicationResponseControl assuredReplicationResponse =
* AssuredReplicationResponseControl.get(deleteResult);
* if (assuredReplicationResponse == null)
* {
* // The entry was deleted, but its replication could not be confirmed in
* // either the local or remote data centers.
* }
* else
* {
* if (assuredReplicationResponse.localAssuranceSatisfied())
* {
* if (assuredReplicationResponse.remoteAssuranceSatisfied())
* {
* // The entry was deleted. The delete has been applied across all
* // available local servers, and has been replicated to at least one
* // remote data center.
* }
* else
* {
* // The entry was deleted. The delete has been applied across all
* // available local servers, but cannot be confirmed to have yet
* // been replicated to any remote data centers.
* }
* }
* else if (assuredReplicationResponse.remoteAssuranceSatisfied())
* {
* // The entry was deleted. The delete has been confirmed to have been
* // replicated to at least one remote data center, but cannot be
* // confirmed to have yet been applied to all available local servers.
* }
* else
* {
* // The entry was deleted, but its replication could not be confirmed
* // to either local servers or remote data centers.
* }
* }
* }
* else
* {
* // The entry could not be deleted.
* }
*
*
* @see AssuredReplicationResponseControl
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class AssuredReplicationRequestControl
extends Control
{
/**
* The OID (1.3.6.1.4.1.30221.2.5.28) for the assured replication request
* control.
*/
public static final String ASSURED_REPLICATION_REQUEST_OID =
"1.3.6.1.4.1.30221.2.5.28";
/**
* The BER type for the minimum local assurance level.
*/
private static final byte TYPE_MIN_LOCAL_LEVEL = (byte) 0x80;
/**
* The BER type for the maximum local assurance level.
*/
private static final byte TYPE_MAX_LOCAL_LEVEL = (byte) 0x81;
/**
* The BER type for the minimum remote assurance level.
*/
private static final byte TYPE_MIN_REMOTE_LEVEL = (byte) 0x82;
/**
* The BER type for the maximum remote assurance level.
*/
private static final byte TYPE_MAX_REMOTE_LEVEL = (byte) 0x83;
/**
* The BER type for the maximum remote assurance level.
*/
private static final byte TYPE_SEND_RESPONSE_IMMEDIATELY = (byte) 0x84;
/**
* The BER type for the timeout.
*/
private static final byte TYPE_TIMEOUT = (byte) 0x85;
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -2013933506118879241L;
// The requested maximum local assurance level.
private final AssuredReplicationLocalLevel maximumLocalLevel;
// The requested minimum local assurance level.
private final AssuredReplicationLocalLevel minimumLocalLevel;
// The requested maximum remote assurance level.
private final AssuredReplicationRemoteLevel maximumRemoteLevel;
// The requested minimum remote assurance level.
private final AssuredReplicationRemoteLevel minimumRemoteLevel;
// Indicates whether the server should immediately send the operation response
// without waiting for assurance processing.
private final boolean sendResponseImmediately;
// The maximum length of time in milliseconds that the server should wait for
// the desired assurance level to be attained.
private final Long timeoutMillis;
/**
* Creates a new assured replication request control with the provided
* information. It will not be critical.
*
* @param minimumLocalLevel The minimum replication assurance level desired
* for servers in the same location as the server
* receiving the change. This may be overridden
* by the server if the associated operation
* matches an assured replication criteria with a
* higher local assurance level. If this is
* {@code null}, then the server will determine
* minimum local assurance level for the
* operation.
* @param minimumRemoteLevel The minimum replication assurance level desired
* for servers in different locations from the
* server receiving the change. This may be
* overridden by the server if the associated
* operation matches an assured replication
* criteria with a higher remote assurance level.
* If this is {@code null}, then the server will
* determine the remote assurance level for the
* operation.
* @param timeoutMillis The maximum length of time in milliseconds to
* wait for the desired assurance to be satisfied.
* If this is {@code null}, then the server will
* determine the timeout to use.
*/
public AssuredReplicationRequestControl(
final AssuredReplicationLocalLevel minimumLocalLevel,
final AssuredReplicationRemoteLevel minimumRemoteLevel,
final Long timeoutMillis)
{
this(false, minimumLocalLevel, null, minimumRemoteLevel, null,
timeoutMillis, false);
}
/**
* Creates a new assured replication request control with the provided
* information.
*
* @param isCritical Indicates whether the control should be
* marked critical.
* @param minimumLocalLevel The minimum replication assurance level
* desired for servers in the same location
* as the server receiving the change. This
* may be overridden by the server if the
* associated operation matches an assured
* replication criteria with a higher local
* assurance level. If this is {@code null},
* then the server will determine the minimum
* local assurance level for the operation.
* @param maximumLocalLevel The maximum replication assurance level
* desired for servers in the same location
* as the server receiving the change. This
* may override the server configuration if
* the operation matches an assured
* replication criteria that would have
* otherwise used a higher local assurance
* level. If this is {@code null}, then the
* server will determine the maximum local
* assurance level for the operation.
* @param minimumRemoteLevel The minimum replication assurance level
* desired for servers in different locations
* from the server receiving the change.
* This may be overridden by the server if
* the associated operation matches an
* assured replication criteria with a higher
* remote assurance level. If this is
* {@code null}, then the server will
* determine the minimum remote assurance
* level for the operation.
* @param maximumRemoteLevel The maximum replication assurance level
* desired for servers in different locations
* from the server receiving the change.
* This may override the server configuration
* if the operation matches an assured
* replication criteria that would have
* otherwise used a higher remote assurance
* level. If this is {@code null}, then the
* server will determine the maximum remote
* assurance level for the operation.
* @param timeoutMillis The maximum length of time in milliseconds
* to wait for the desired assurance to be
* satisfied. If this is {@code null}, then
* the server will determine the timeout to
* use.
* @param sendResponseImmediately Indicates whether the server should
* send the response to the client immediately after the change
* has been applied to the server receiving the change, without
* waiting for the desired assurance to be satisfied.
*/
public AssuredReplicationRequestControl(final boolean isCritical,
final AssuredReplicationLocalLevel minimumLocalLevel,
final AssuredReplicationLocalLevel maximumLocalLevel,
final AssuredReplicationRemoteLevel minimumRemoteLevel,
final AssuredReplicationRemoteLevel maximumRemoteLevel,
final Long timeoutMillis, final boolean sendResponseImmediately)
{
super(ASSURED_REPLICATION_REQUEST_OID, isCritical,
encodeValue(minimumLocalLevel, maximumLocalLevel, minimumRemoteLevel,
maximumRemoteLevel, sendResponseImmediately, timeoutMillis));
this.minimumLocalLevel = minimumLocalLevel;
this.maximumLocalLevel = maximumLocalLevel;
this.minimumRemoteLevel = minimumRemoteLevel;
this.maximumRemoteLevel = maximumRemoteLevel;
this.sendResponseImmediately = sendResponseImmediately;
this.timeoutMillis = timeoutMillis;
}
/**
* Creates a new assured replication request control from the provided generic
* control.
*
* @param c The generic control to decode as an assured replication request
* control. It must not be {@code null}.
*
* @throws LDAPException If the provided generic control cannot be parsed as
* an assured replication request control.
*/
public AssuredReplicationRequestControl(final Control c)
throws LDAPException
{
super(c);
final ASN1OctetString value = c.getValue();
if (value == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_ASSURED_REPLICATION_REQUEST_NO_VALUE.get());
}
AssuredReplicationLocalLevel maxLocalLevel = null;
AssuredReplicationLocalLevel minLocalLevel = null;
AssuredReplicationRemoteLevel maxRemoteLevel = null;
AssuredReplicationRemoteLevel minRemoteLevel = null;
boolean sendImmediately = false;
Long timeout = null;
try
{
for (final ASN1Element e :
ASN1Sequence.decodeAsSequence(value.getValue()).elements())
{
switch (e.getType())
{
case TYPE_MIN_LOCAL_LEVEL:
int intValue = ASN1Enumerated.decodeAsEnumerated(e).intValue();
minLocalLevel = AssuredReplicationLocalLevel.valueOf(intValue);
if (minLocalLevel == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_ASSURED_REPLICATION_REQUEST_INVALID_MIN_LOCAL_LEVEL.get(
intValue));
}
break;
case TYPE_MAX_LOCAL_LEVEL:
intValue = ASN1Enumerated.decodeAsEnumerated(e).intValue();
maxLocalLevel = AssuredReplicationLocalLevel.valueOf(intValue);
if (maxLocalLevel == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_ASSURED_REPLICATION_REQUEST_INVALID_MAX_LOCAL_LEVEL.get(
intValue));
}
break;
case TYPE_MIN_REMOTE_LEVEL:
intValue = ASN1Enumerated.decodeAsEnumerated(e).intValue();
minRemoteLevel = AssuredReplicationRemoteLevel.valueOf(intValue);
if (minRemoteLevel == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_ASSURED_REPLICATION_REQUEST_INVALID_MIN_REMOTE_LEVEL.get(
intValue));
}
break;
case TYPE_MAX_REMOTE_LEVEL:
intValue = ASN1Enumerated.decodeAsEnumerated(e).intValue();
maxRemoteLevel = AssuredReplicationRemoteLevel.valueOf(intValue);
if (maxRemoteLevel == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_ASSURED_REPLICATION_REQUEST_INVALID_MAX_REMOTE_LEVEL.get(
intValue));
}
break;
case TYPE_SEND_RESPONSE_IMMEDIATELY:
sendImmediately = ASN1Boolean.decodeAsBoolean(e).booleanValue();
break;
case TYPE_TIMEOUT:
timeout = ASN1Long.decodeAsLong(e).longValue();
break;
default:
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_ASSURED_REPLICATION_REQUEST_UNEXPECTED_ELEMENT_TYPE.get(
StaticUtils.toHex(e.getType())));
}
}
}
catch (final LDAPException le)
{
Debug.debugException(le);
throw le;
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_ASSURED_REPLICATION_REQUEST_ERROR_DECODING_VALUE.get(
StaticUtils.getExceptionMessage(e)),
e);
}
minimumLocalLevel = minLocalLevel;
maximumLocalLevel = maxLocalLevel;
minimumRemoteLevel = minRemoteLevel;
maximumRemoteLevel = maxRemoteLevel;
sendResponseImmediately = sendImmediately;
timeoutMillis = timeout;
}
/**
* Encodes the provided information as needed for use as the value of this
* control.
*
* @param minimumLocalLevel The minimum replication assurance level
* desired for servers in the same location
* as the server receiving the change. This
* may be overridden by the server if the
* associated operation matches an assured
* replication criteria with a higher local
* assurance level. If this is {@code null},
* then the server will determine the minimum
* local assurance level for the operation.
* @param maximumLocalLevel The maximum replication assurance level
* desired for servers in the same location
* as the server receiving the change. This
* may override the server configuration if
* the operation matches an assured
* replication criteria that would have
* otherwise used a higher local assurance
* level. If this is {@code null}, then the
* server will determine the maximum local
* assurance level for the operation.
* @param minimumRemoteLevel The minimum replication assurance level
* desired for servers in different locations
* from the server receiving the change.
* This may be overridden by the server if
* the associated operation matches an
* assured replication criteria with a higher
* remote assurance level. If this is
* {@code null}, then the server will
* determine the minimum remote assurance
* level for the operation.
* @param maximumRemoteLevel The maximum replication assurance level
* desired for servers in different locations
* from the server receiving the change.
* This may override the server configuration
* if the operation matches an assured
* replication criteria that would have
* otherwise used a higher remote assurance
* level. If this is {@code null}, then the
* server will determine the maximum remote
* assurance level for the operation.
* @param timeoutMillis The maximum length of time in milliseconds
* to wait for the desired assurance to be
* satisfied. If this is {@code null}, then
* the server will determine the timeout to
* use.
* @param sendResponseImmediately Indicates whether the server should
* send the response to the client immediately after the change
* has been applied to the server receiving the change, without
* waiting for the desired assurance to be satisfied.
*
* @return The ASN.1 octet string containing the encoded value.
*/
private static ASN1OctetString encodeValue(
final AssuredReplicationLocalLevel minimumLocalLevel,
final AssuredReplicationLocalLevel maximumLocalLevel,
final AssuredReplicationRemoteLevel minimumRemoteLevel,
final AssuredReplicationRemoteLevel maximumRemoteLevel,
final boolean sendResponseImmediately,
final Long timeoutMillis)
{
final ArrayList elements = new ArrayList<>(6);
if (minimumLocalLevel != null)
{
elements.add(new ASN1Enumerated(TYPE_MIN_LOCAL_LEVEL,
minimumLocalLevel.intValue()));
}
if (maximumLocalLevel != null)
{
elements.add(new ASN1Enumerated(TYPE_MAX_LOCAL_LEVEL,
maximumLocalLevel.intValue()));
}
if (minimumRemoteLevel != null)
{
elements.add(new ASN1Enumerated(TYPE_MIN_REMOTE_LEVEL,
minimumRemoteLevel.intValue()));
}
if (maximumRemoteLevel != null)
{
elements.add(new ASN1Enumerated(TYPE_MAX_REMOTE_LEVEL,
maximumRemoteLevel.intValue()));
}
if (sendResponseImmediately)
{
elements.add(new ASN1Boolean(TYPE_SEND_RESPONSE_IMMEDIATELY, true));
}
if (timeoutMillis != null)
{
elements.add(new ASN1Long(TYPE_TIMEOUT, timeoutMillis));
}
return new ASN1OctetString(new ASN1Sequence(elements).encode());
}
/**
* Retrieves the minimum desired replication level of assurance for local
* servers (i.e., servers in the same location as the server that originally
* received the change), if defined. This may be overridden by the server if
* the associated operation matches an assured replication criteria with a
* higher local assurance level.
*
* @return The minimum desired replication level of assurance for local
* servers, or {@code null} if the server should determine the
* minimum local assurance level for the operation.
*/
public AssuredReplicationLocalLevel getMinimumLocalLevel()
{
return minimumLocalLevel;
}
/**
* Retrieves the maximum desired replication level of assurance for local
* servers (i.e., servers in the same location as the server that originally
* received the change), if defined. This may override the server
* configuration if the operation matches an assured replication criteria that
* would have otherwise used a higher local assurance level.
*
* @return The maximum desired replication level of assurance for local
* servers, or {@code null} if the server should determine the
* maximum local assurance level for the operation.
*/
public AssuredReplicationLocalLevel getMaximumLocalLevel()
{
return maximumLocalLevel;
}
/**
* Retrieves the minimum desired replication level of assurance for remote
* servers (i.e., servers in locations different from the server that
* originally received the change), if defined. This may be overridden by the
* server if the associated operation matches an assured replication
* criteria with a higher remote assurance level.
*
* @return The minimum desired replication level of assurance for remote
* servers, or {@code null} if the server should determine the
* minimum remote assurance level for the operation.
*/
public AssuredReplicationRemoteLevel getMinimumRemoteLevel()
{
return minimumRemoteLevel;
}
/**
* Retrieves the maximum desired replication level of assurance for remote
* servers (i.e., servers in locations different from the server that
* originally received the change), if defined. This may override the server
* configuration if the operation matches an assured replication criteria that
* would have otherwise used a higher remote assurance level.
*
* @return The maximum desired replication level of assurance for remote
* servers, or {@code null} if the server should determine the
* maximum remote assurance level for the operation.
*/
public AssuredReplicationRemoteLevel getMaximumRemoteLevel()
{
return maximumRemoteLevel;
}
/**
* Indicates whether the server that originally received the change should
* return the operation result immediately, without waiting for the requested
* assurance processing to complete.
*
* @return {@code false} if the server should wait to return the operation
* result until the desired assurance has been attained or a timeout
* has occurred, or {@code true} if the server should return the
* result immediately.
*/
public boolean sendResponseImmediately()
{
return sendResponseImmediately;
}
/**
* Retrieves the maximum length of time in milliseconds that the operation
* response should be delayed while waiting for the desired level of
* assurance to be attained.
*
* @return The maximum length of time in milliseconds that the operation
* response should be delayed while waiting for the desired level of
* assurance to be attained.
*/
public Long getTimeoutMillis()
{
return timeoutMillis;
}
/**
* {@inheritDoc}
*/
@Override()
public String getControlName()
{
return INFO_CONTROL_NAME_ASSURED_REPLICATION_REQUEST.get();
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(final StringBuilder buffer)
{
buffer.append("AssuredReplicationRequestControl(isCritical=");
buffer.append(isCritical());
if (minimumLocalLevel != null)
{
buffer.append(", minimumLocalLevel=");
buffer.append(minimumLocalLevel.name());
}
if (maximumLocalLevel != null)
{
buffer.append(", maximumLocalLevel=");
buffer.append(maximumLocalLevel.name());
}
if (minimumRemoteLevel != null)
{
buffer.append(", minimumRemoteLevel=");
buffer.append(minimumRemoteLevel.name());
}
if (maximumRemoteLevel != null)
{
buffer.append(", maximumRemoteLevel=");
buffer.append(maximumRemoteLevel.name());
}
buffer.append(", sendResponseImmediately=");
buffer.append(sendResponseImmediately);
if (timeoutMillis != null)
{
buffer.append(", timeoutMillis=");
buffer.append(timeoutMillis);
}
buffer.append(')');
}
}