001/*
002 * Copyright 2022-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2022-2024 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-2024 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 com.unboundid.ldap.sdk.ResultCode;
041import com.unboundid.util.NotExtensible;
042import com.unboundid.util.Nullable;
043import com.unboundid.util.ThreadSafety;
044import com.unboundid.util.ThreadSafetyLevel;
045
046
047
048/**
049 * This class provides a data structure that holds information about an entry
050 * rebalancing result access log message.
051 * <BR>
052 * <BLOCKQUOTE>
053 *   <B>NOTE:</B>  This class, and other classes within the
054 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
055 *   supported for use against Ping Identity, UnboundID, and
056 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
057 *   for proprietary functionality or for external specifications that are not
058 *   considered stable or mature enough to be guaranteed to work in an
059 *   interoperable way with other types of LDAP servers.
060 * </BLOCKQUOTE>
061 */
062@NotExtensible()
063@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
064public interface EntryRebalancingResultAccessLogMessage
065       extends EntryRebalancingRequestAccessLogMessage
066{
067  /**
068   * Retrieves the result code for the entry-rebalancing operation.
069   *
070   * @return  The result code for the entry-rebalancing operation, or
071   *          {@code null} if it is not included in the log message.
072   */
073  @Nullable()
074  ResultCode getResultCode();
075
076
077
078  /**
079   * Retrieves a message with information about any errors that were encountered
080   * during processing.
081   *
082   * @return  A message with information about any errors that were encountered
083   *          during processing, or {@code null} if no errors were encountered
084   *          or it is not included in the log message.
085   */
086  @Nullable()
087  String getErrorMessage();
088
089
090
091  /**
092   * Retrieves a message with information about any administrative action that
093   * may be required to bring the source and target servers back to a consistent
094   * state with regard to the migrated subtree.
095   *
096   * @return  A message with information about any administrative action that
097   *          may be required to bring the source and target servers back to a
098   *          consistent state with regard to the migrated subtree, or
099   *          {@code null} if no administrative action is required or it is not
100   *          included in the log message.
101   */
102  @Nullable()
103  String getAdminActionMessage();
104
105
106
107  /**
108   * Indicates whether data in the source server was altered as a result of
109   * processing for this entry-rebalancing operation.
110   *
111   * @return  {@code true} if data in the source server was altered as a result
112   *          of processing for this entry-rebalancing operation, {@code false}
113   *          if no data in the source server was altered as a result of
114   *          entry-rebalancing processing, or {@code null} if it is not
115   *          included in the log message.
116   */
117  @Nullable()
118  Boolean getSourceServerAltered();
119
120
121
122  /**
123   * Indicates whether data in the target server was altered as a result of
124   * processing for this entry-rebalancing operation.
125   *
126   * @return  {@code true} if data in the target server was altered as a result
127   *          of processing for this entry-rebalancing operation, {@code false}
128   *          if no data in the target server was altered as a result of
129   *          entry-rebalancing processing, or {@code null} if it is not
130   *          included in the log message.
131   */
132  @Nullable()
133  Boolean getTargetServerAltered();
134
135
136
137  /**
138   * Retrieves the number of entries that were read from the source server.
139   *
140   * @return  The number of entries that were read from the source server, or
141   *          {@code null} if it is not included in the log message.
142   */
143  @Nullable()
144  Integer getEntriesReadFromSource();
145
146
147
148  /**
149   * Retrieves the number of entries that were added to the target server.
150   *
151   * @return  The number of entries that were added to the target server, or
152   *          {@code null} if it is not included in the log message.
153   */
154  @Nullable()
155  Integer getEntriesAddedToTarget();
156
157
158
159  /**
160   * Retrieves the number of entries that were deleted from the source server.
161   *
162   * @return  The number of entries that were deleted from the source server, or
163   *          {@code null} if it is not included in the log message.
164   */
165  @Nullable()
166  Integer getEntriesDeletedFromSource();
167}