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.json; 037 038 039 040import com.unboundid.ldap.sdk.ResultCode; 041import com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessageType; 042import com.unboundid.ldap.sdk.unboundidds.logs.LogException; 043import com.unboundid.ldap.sdk.unboundidds.logs.v2. 044 EntryRebalancingResultAccessLogMessage; 045import com.unboundid.util.NotMutable; 046import com.unboundid.util.NotNull; 047import com.unboundid.util.Nullable; 048import com.unboundid.util.ThreadSafety; 049import com.unboundid.util.ThreadSafetyLevel; 050import com.unboundid.util.json.JSONObject; 051 052 053 054/** 055 * This class provides a data structure that holds information about a 056 * JSON-formatted entry rebalancing result access log message. 057 * <BR> 058 * <BLOCKQUOTE> 059 * <B>NOTE:</B> This class, and other classes within the 060 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 061 * supported for use against Ping Identity, UnboundID, and 062 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 063 * for proprietary functionality or for external specifications that are not 064 * considered stable or mature enough to be guaranteed to work in an 065 * interoperable way with other types of LDAP servers. 066 * </BLOCKQUOTE> 067 */ 068@NotMutable() 069@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 070public final class JSONEntryRebalancingResultAccessLogMessage 071 extends JSONEntryRebalancingRequestAccessLogMessage 072 implements EntryRebalancingResultAccessLogMessage 073{ 074 /** 075 * The serial version UID for this serializable class. 076 */ 077 private static final long serialVersionUID = 144849488576686304L; 078 079 080 081 // Indicates whether the source server was altered in the course of 082 // processing. 083 @Nullable private final Boolean sourceAltered; 084 085 // Indicates whether the target server was altered in the course of 086 // processing. 087 @Nullable private final Boolean targetAltered; 088 089 // The number of entries added to the target server. 090 @Nullable private final Integer entriesAddedToTarget; 091 092 // The number of entries deleted from the source server. 093 @Nullable private final Integer entriesDeletedFromSource; 094 095 // The number of entries read from the source server. 096 @Nullable private final Integer entriesReadFromSource; 097 098 // The result code for this log message. 099 @Nullable private final ResultCode resultCode; 100 101 // The admin action message for this log message. 102 @Nullable private final String adminActionMessage; 103 104 // The error message for this log message. 105 @Nullable private final String errorMessage; 106 107 108 109 /** 110 * Creates a new JSON entry rebalancing request access log message from the 111 * provided JSON object. 112 * 113 * @param jsonObject The JSON object that contains an encoded representation 114 * of this log message. It must not be {@code null}. 115 * 116 * @throws LogException If the provided JSON object cannot be parsed as a 117 * valid log message. 118 */ 119 public JSONEntryRebalancingResultAccessLogMessage( 120 @NotNull final JSONObject jsonObject) 121 throws LogException 122 { 123 super(jsonObject); 124 125 errorMessage = getString( 126 JSONFormattedAccessLogFields.ENTRY_REBALANCING_ERROR_MESSAGE); 127 adminActionMessage = getString( 128 JSONFormattedAccessLogFields.ENTRY_REBALANCING_ADMIN_ACTION_MESSAGE); 129 sourceAltered = getBooleanNoThrow( 130 JSONFormattedAccessLogFields.ENTRY_REBALANCING_SOURCE_SERVER_ALTERED); 131 targetAltered = getBooleanNoThrow( 132 JSONFormattedAccessLogFields.ENTRY_REBALANCING_TARGET_SERVER_ALTERED); 133 entriesReadFromSource = getIntegerNoThrow(JSONFormattedAccessLogFields. 134 ENTRY_REBALANCING_ENTRIES_READ_FROM_SOURCE); 135 entriesAddedToTarget = getIntegerNoThrow(JSONFormattedAccessLogFields. 136 ENTRY_REBALANCING_ENTRIES_ADDED_TO_TARGET); 137 entriesDeletedFromSource = getIntegerNoThrow(JSONFormattedAccessLogFields. 138 ENTRY_REBALANCING_ENTRIES_DELETED_FROM_SOURCE); 139 140 final Integer resultCodeValue = getIntegerNoThrow( 141 JSONFormattedAccessLogFields.RESULT_CODE_VALUE); 142 if (resultCodeValue == null) 143 { 144 resultCode = null; 145 } 146 else 147 { 148 resultCode = ResultCode.valueOf(resultCodeValue); 149 } 150 } 151 152 153 154 /** 155 * {@inheritDoc} 156 */ 157 @Override() 158 @NotNull() 159 public AccessLogMessageType getMessageType() 160 { 161 return AccessLogMessageType.ENTRY_REBALANCING_RESULT; 162 } 163 164 165 166 /** 167 * {@inheritDoc} 168 */ 169 @Override() 170 @Nullable() 171 public ResultCode getResultCode() 172 { 173 return resultCode; 174 } 175 176 177 178 /** 179 * {@inheritDoc} 180 */ 181 @Override() 182 @Nullable() 183 public String getErrorMessage() 184 { 185 return errorMessage; 186 } 187 188 189 190 /** 191 * {@inheritDoc} 192 */ 193 @Override() 194 @Nullable() 195 public String getAdminActionMessage() 196 { 197 return adminActionMessage; 198 } 199 200 201 202 /** 203 * {@inheritDoc} 204 */ 205 @Override() 206 @Nullable() 207 public Boolean getSourceServerAltered() 208 { 209 return sourceAltered; 210 } 211 212 213 214 /** 215 * {@inheritDoc} 216 */ 217 @Override() 218 @Nullable() 219 public Boolean getTargetServerAltered() 220 { 221 return targetAltered; 222 } 223 224 225 226 /** 227 * {@inheritDoc} 228 */ 229 @Override() 230 @Nullable() 231 public Integer getEntriesReadFromSource() 232 { 233 return entriesReadFromSource; 234 } 235 236 237 238 /** 239 * {@inheritDoc} 240 */ 241 @Override() 242 @Nullable() 243 public Integer getEntriesAddedToTarget() 244 { 245 return entriesAddedToTarget; 246 } 247 248 249 250 /** 251 * {@inheritDoc} 252 */ 253 @Override() 254 @Nullable() 255 public Integer getEntriesDeletedFromSource() 256 { 257 return entriesDeletedFromSource; 258 } 259}