001/*
002 * Copyright 2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2022 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2022 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk.unboundidds.logs.v2;
037
038
039
040import java.util.Set;
041
042import com.unboundid.ldap.sdk.unboundidds.controls.AssuredReplicationLocalLevel;
043import com.unboundid.ldap.sdk.unboundidds.controls.
044            AssuredReplicationRemoteLevel;
045import com.unboundid.util.NotExtensible;
046import com.unboundid.util.NotNull;
047import com.unboundid.util.Nullable;
048import com.unboundid.util.ThreadSafety;
049import com.unboundid.util.ThreadSafetyLevel;
050
051
052
053/**
054 * This class provides a data structure that holds information about a modify
055 * operation result access log message.
056 * <BR>
057 * <BLOCKQUOTE>
058 *   <B>NOTE:</B>  This class, and other classes within the
059 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
060 *   supported for use against Ping Identity, UnboundID, and
061 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
062 *   for proprietary functionality or for external specifications that are not
063 *   considered stable or mature enough to be guaranteed to work in an
064 *   interoperable way with other types of LDAP servers.
065 * </BLOCKQUOTE>
066 */
067@NotExtensible()
068@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
069public interface ModifyResultAccessLogMessage
070       extends OperationResultAccessLogMessage,
071               ModifyForwardAccessLogMessage
072{
073  /**
074   * Retrieves the alternate authorization DN for the operation.
075   *
076   * @return  The alternate authorization DN for the operation, or {@code null}
077   *          if it is not included in the log message.
078   */
079  @Nullable()
080  String getAlternateAuthorizationDN();
081
082
083
084  /**
085   * Retrieves the replication change ID for the operation, if available.
086   *
087   * @return  The replication change ID for the operation, or {@code null} if it
088   *          is not included in the log message.
089   */
090  @Nullable()
091  String getReplicationChangeID();
092
093
094
095  /**
096   * Indicates whether the modify operation targeted a soft-deleted entry.
097   *
098   * @return  {@code true} if the modify operation was known to target a
099   *          soft-deleted entry, {@code false} if it was known to target a
100   *          non-soft-deleted entry, or {@code null} if it is not included in
101   *          the log message (and likely did not target a soft-deleted entry).
102   */
103  @Nullable()
104  Boolean getChangeToSoftDeletedEntry();
105
106
107
108  /**
109   * Retrieves the local level that will be used for assured replication
110   * processing, if available.
111   *
112   * @return  The local level that will be used for assured replication
113   *          processing, or {@code null} if this is not included in the log
114   *          message (e.g., because assured replication will not be performed
115   *          for the operation).
116   */
117  @Nullable()
118  AssuredReplicationLocalLevel getAssuredReplicationLocalLevel();
119
120
121
122  /**
123   * Retrieves the remote level that will be used for assured replication
124   * processing, if available.
125   *
126   * @return  The remote level that will be used for assured replication
127   *          processing, or {@code null} if this is not included in the log
128   *          message (e.g., because assured replication will not be performed
129   *          for the operation).
130   */
131  @Nullable()
132  AssuredReplicationRemoteLevel getAssuredReplicationRemoteLevel();
133
134
135
136  /**
137   * Retrieves the maximum length of time in milliseconds that the server will
138   * delay the response to the client while waiting for the replication
139   * assurance requirement to be satisfied.
140   *
141   * @return  The maximum length of time in milliseconds that the server will
142   *          delay the response to the client while waiting for the replication
143   *          assurance requirement to be satisfied, or {@code null} if this is
144   *          not included in the log message (e.g., because assured replication
145   *          will not be performed for the operation).
146   */
147  @Nullable()
148  Long getAssuredReplicationTimeoutMillis();
149
150
151
152  /**
153   * Indicates whether the operation response to the client will be delayed
154   * until replication assurance has been satisfied or the timeout has occurred.
155   *
156   * @return  {@code true} if the operation response to the client will be
157   *          delayed until replication assurance has been satisfied,
158   *          {@code false} if the response will not be delayed by assurance
159   *          processing, or {@code null} if this was not included in the
160   *          log message (e.g., because assured replication will not be
161   *          performed for the operation)
162   */
163  @Nullable()
164  Boolean getResponseDelayedByAssurance();
165
166
167
168  /**
169   * Retrieves the names of any indexes for which one or more keys near
170   * (typically, within 80% of) the index entry limit were accessed while
171   * processing the operation.
172   *
173   * @return  The names of any indexes for which one or more keys near the index
174   *          entry limit were accessed while processing the operation, or an
175   *          empty list if no such index keys were accessed, or if this is not
176   *          included in the log message.
177   */
178  @NotNull()
179  Set<String> getIndexesWithKeysAccessedNearEntryLimit();
180
181
182
183  /**
184   * Retrieves the names of any indexes for which one or more keys over the
185   * index entry limit were accessed while processing the operation.
186   *
187   * @return  The names of any indexes for which one or more keys over the index
188   *          entry limit were accessed while processing the operation, or an
189   *          empty list if no such index keys were accessed, or if this is not
190   *          included in the log message.
191   */
192  @NotNull()
193  Set<String> getIndexesWithKeysAccessedExceedingEntryLimit();
194}