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 com.unboundid.util.NotExtensible;
041import com.unboundid.util.Nullable;
042import com.unboundid.util.ThreadSafety;
043import com.unboundid.util.ThreadSafetyLevel;
044
045
046
047/**
048 * This class provides a data structure that holds information about an entry
049 * rebalancing request access log message.
050 * <BR>
051 * <BLOCKQUOTE>
052 *   <B>NOTE:</B>  This class, and other classes within the
053 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
054 *   supported for use against Ping Identity, UnboundID, and
055 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
056 *   for proprietary functionality or for external specifications that are not
057 *   considered stable or mature enough to be guaranteed to work in an
058 *   interoperable way with other types of LDAP servers.
059 * </BLOCKQUOTE>
060 */
061@NotExtensible()
062@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
063public interface EntryRebalancingRequestAccessLogMessage
064       extends AccessLogMessage
065{
066  /**
067   * Retrieves the unique identifier assigned to the entry rebalancing
068   * operation.
069   *
070   * @return  The unique identifier assigned to the entry rebalancing operation,
071   *          or {@code null} if it is not included in the log message.
072   */
073  @Nullable()
074  Long getRebalancingOperationID();
075
076
077
078  /**
079   * Retrieves the connection ID for the connection that performed an operation
080   * to trigger the entry rebalancing operation.
081   *
082   * @return  Retrieves the connection ID for the connection that performed an
083   *          operation to trigger the entry rebalancing operation, or
084   *          {@code null} if it is not included in the log message.
085   */
086  @Nullable()
087  Long getTriggeredByConnectionID();
088
089
090
091  /**
092   * Retrieves the operation ID for the operation that triggered the entry
093   * rebalancing operation.
094   *
095   * @return  Retrieves the operation ID for the operation that triggered the
096   *          entry rebalancing operation, or {@code null} if it is not included
097   *          in the log message.
098   */
099  @Nullable()
100  Long getTriggeredByOperationID();
101
102
103
104  /**
105   * Retrieves the base DN of the subtree that will be migrated during the entry
106   * rebalancing operation.
107   *
108   * @return  The base DN of the subtree that will be migrated during the entry
109   *          rebalancing operation, or {@code null} if it is not included in
110   *          the log message.
111   */
112  @Nullable()
113  String getSubtreeBaseDN();
114
115
116
117  /**
118   * Retrieves the maximum number of entries that may be contained in the
119   * subtree for it to be successfully migrated.
120   *
121   * @return  The maximum number of entries that may be contained in the subtree
122   *          for it to be successfully migrated, or {@code null} if it is not
123   *          included in the log message.
124   */
125  @Nullable()
126  Integer getSizeLimit();
127
128
129
130  /**
131   * Retrieves the name of the backend set containing the subtree to be
132   * migrated.
133   *
134   * @return  The name of the backend set containing the subtree to be migrated,
135   *          or {@code null} if it is not included in the log message.
136   */
137  @Nullable()
138  String getSourceBackendSetName();
139
140
141
142  /**
143   * The address and port of the backend server from which the subtree will be
144   * migrated.
145   *
146   * @return  The address and port of the backend server from which the subtree
147   *          will be migrated, or {@code null} if it is not included in the log
148   *          message.
149   */
150  @Nullable()
151  String getSourceBackendServer();
152
153
154
155  /**
156   * Retrieves the name of the backend set to which the subtree will be
157   * migrated.
158   *
159   * @return  The name of the backend set ot which the subtree will be migrated,
160   *          or {@code null} if it is not included in the log message.
161   */
162  @Nullable()
163  String getTargetBackendSetName();
164
165
166
167  /**
168   * Retrieves the address and port of the backend server to which the subtree
169   * will be migrated.
170   *
171   * @return  The address and port of the backend server to which the subtree
172   *          will be migrated, or {@code null} if it is not included in the log
173   *          message.
174   */
175  @Nullable()
176  String getTargetBackendServer();
177}