001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * docs/licenses/cddl.txt
011 * or http://www.opensource.org/licenses/cddl1.php.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * docs/licenses/cddl.txt.  If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 *      Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 *      Copyright 2013-2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.types;
028
029
030
031import java.util.Collection;
032
033import com.unboundid.ldap.sdk.unboundidds.controls.
034            AssuredReplicationServerResult;
035import com.unboundid.util.NotExtensible;
036import com.unboundid.util.ThreadSafety;
037import com.unboundid.util.ThreadSafetyLevel;
038
039
040
041/**
042 * This interface may be used to obtain information about the result of
043 * replication assurance processing for an operation.
044 */
045@NotExtensible()
046@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
047public interface AssuredReplicationResult
048{
049  /**
050   * Indicates whether the local assurance level was satisfied for the
051   * operation.
052   *
053   * @return  {@code true} if the local assurance level was satisfied, or
054   *          {@code false} if not.
055   */
056  boolean isLocalAssuranceSatisfied();
057
058
059
060  /**
061   * Indicates whether the remote assurance level was satisfied for the
062   * operation.
063   *
064   * @return  {@code true} if the remote assurance level was satisfied, or
065   *          {@code false} if not.
066   */
067  boolean isRemoteAssuranceSatisfied();
068
069
070
071  /**
072   * Retrieves a collection with results about individual servers involved in
073   * replication assurance processing.
074   *
075   * @return  A collection with results about individual servers involved in
076   *          replication assurance processing.
077   */
078  Collection<AssuredReplicationServerResult> getServerResults();
079}