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.unboundidds.logs.AccessLogOperationType;
041import com.unboundid.ldap.sdk.unboundidds.logs.LogException;
042import com.unboundid.ldap.sdk.unboundidds.logs.v2.
043            ModifyDNRequestAccessLogMessage;
044import com.unboundid.util.NotExtensible;
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 modify DN request 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@NotExtensible()
069@NotMutable()
070@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
071public class JSONModifyDNRequestAccessLogMessage
072       extends JSONRequestAccessLogMessage
073       implements ModifyDNRequestAccessLogMessage
074{
075  /**
076   * The serial version UID for this serializable class.
077   */
078  private static final long serialVersionUID = 4129391735909212011L;
079
080
081
082  // Indicates whether to delete the old RDN values from the entry.
083  @Nullable private final Boolean deleteOldRDN;
084
085  // The current DN of the entry to rename.
086  @Nullable private final String dn;
087
088  // The new RDN to use for the entry.
089  @Nullable private final String newRDN;
090
091  // The new superior DN to use for the entry.
092  @Nullable private final String newSuperiorDN;
093
094
095
096  /**
097   * Creates a new JSON modify DN request access log message from the provided
098   * JSON object.
099   *
100   * @param  jsonObject  The JSON object that contains an encoded representation
101   *                     of this log message.  It must not be {@code null}.
102   *
103   * @throws  LogException  If the provided JSON object cannot be parsed as a
104   *                        valid log message.
105   */
106  public JSONModifyDNRequestAccessLogMessage(
107              @NotNull final JSONObject jsonObject)
108         throws LogException
109  {
110    super(jsonObject);
111
112    dn = getString(JSONFormattedAccessLogFields.MODDN_ENTRY_DN);
113    newRDN = getString(JSONFormattedAccessLogFields.MODDN_NEW_RDN);
114    deleteOldRDN =
115         getBooleanNoThrow(JSONFormattedAccessLogFields.MODDN_DELETE_OLD_RDN);
116    newSuperiorDN =
117         getString(JSONFormattedAccessLogFields.MODDN_NEW_SUPERIOR_DN);
118  }
119
120
121
122  /**
123   * {@inheritDoc}
124   */
125  @Override()
126  @NotNull()
127  public final AccessLogOperationType getOperationType()
128  {
129    return AccessLogOperationType.MODDN;
130  }
131
132
133
134  /**
135   * {@inheritDoc}
136   */
137  @Override()
138  @Nullable()
139  public final String getDN()
140  {
141    return dn;
142  }
143
144
145
146  /**
147   * {@inheritDoc}
148   */
149  @Override()
150  @Nullable()
151  public final String getNewRDN()
152  {
153    return newRDN;
154  }
155
156
157
158  /**
159   * {@inheritDoc}
160   */
161  @Override()
162  @Nullable()
163  public final Boolean getDeleteOldRDN()
164  {
165    return deleteOldRDN;
166  }
167
168
169
170  /**
171   * {@inheritDoc}
172   */
173  @Override()
174  @Nullable()
175  public final String getNewSuperiorDN()
176  {
177    return newSuperiorDN;
178  }
179}