001/*
002 * Copyright 2009-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-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) 2009-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;
037
038
039
040import com.unboundid.util.NotExtensible;
041import com.unboundid.util.NotMutable;
042import com.unboundid.util.NotNull;
043import com.unboundid.util.Nullable;
044import com.unboundid.util.ThreadSafety;
045import com.unboundid.util.ThreadSafetyLevel;
046
047
048
049/**
050 * This class provides a data structure that holds information about a log
051 * message that may appear in the Directory Server access log about a modify DN
052 * request received from a client.
053 * <BR>
054 * <BLOCKQUOTE>
055 *   <B>NOTE:</B>  This class, and other classes within the
056 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
057 *   supported for use against Ping Identity, UnboundID, and
058 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
059 *   for proprietary functionality or for external specifications that are not
060 *   considered stable or mature enough to be guaranteed to work in an
061 *   interoperable way with other types of LDAP servers.
062 * </BLOCKQUOTE>
063 */
064@NotExtensible()
065@NotMutable()
066@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
067public class ModifyDNRequestAccessLogMessage
068       extends OperationRequestAccessLogMessage
069{
070  /**
071   * The serial version UID for this serializable class.
072   */
073  private static final long serialVersionUID = -1968625384801993253L;
074
075
076
077  // Indicates whether to delete the old RDN value(s).
078  @Nullable private final Boolean deleteOldRDN;
079
080  // The DN of the entry to rename.
081  @Nullable private final String dn;
082
083  // The new RDN to use for the entry.
084  @Nullable private final String newRDN;
085
086  // The new superior DN for the entry.
087  @Nullable private final String newSuperiorDN;
088
089
090
091  /**
092   * Creates a new modify DN request access log message from the provided
093   * message string.
094   *
095   * @param  s  The string to be parsed as a modify DN request access log
096   *            message.
097   *
098   * @throws  LogException  If the provided string cannot be parsed as a valid
099   *                        log message.
100   */
101  public ModifyDNRequestAccessLogMessage(@NotNull final String s)
102         throws LogException
103  {
104    this(new LogMessage(s));
105  }
106
107
108
109  /**
110   * Creates a new modify DN request access log message from the provided log
111   * message.
112   *
113   * @param  m  The log message to be parsed as a modify DN request access log
114   *            message.
115   */
116  public ModifyDNRequestAccessLogMessage(@NotNull final LogMessage m)
117  {
118    super(m);
119
120    dn            = getNamedValue("dn");
121    newRDN        = getNamedValue("newRDN");
122    deleteOldRDN  = getNamedValueAsBoolean("deleteOldRDN");
123    newSuperiorDN = getNamedValue("newSuperior");
124  }
125
126
127
128  /**
129   * Retrieves the DN of the entry to rename.
130   *
131   * @return  The DN of the entry to rename, or {@code null} if it is not
132   *          included in the log message.
133   */
134  @Nullable()
135  public final String getDN()
136  {
137    return dn;
138  }
139
140
141
142  /**
143   * Retrieves the new RDN to use for the entry.
144   *
145   * @return  The new RDN to use for the entry, or {@code null} if it is not
146   *          included in the log message.
147   */
148  @Nullable()
149  public final String getNewRDN()
150  {
151    return newRDN;
152  }
153
154
155
156  /**
157   * Indicates whether the old RDN value(s) should be removed from the entry.
158   *
159   * @return  {@code Boolean.TRUE} if the old RDN value(s) should be removed
160   *          from the entry, {@code Boolean.FALSE} if the old RDN value(s)
161   *          should be kept in the entry, or {@code null} if it is not included
162   *          in the log message.
163   */
164  @Nullable()
165  public final Boolean deleteOldRDN()
166  {
167    return deleteOldRDN;
168  }
169
170
171
172  /**
173   * Retrieves the new superior DN to use for the entry.
174   *
175   * @return  The new superior DN to use for the entry, or {@code null} if it is
176   *          not included in the log message.
177   */
178  @Nullable()
179  public final String getNewSuperiorDN()
180  {
181    return newSuperiorDN;
182  }
183
184
185
186  /**
187   * {@inheritDoc}
188   */
189  @Override()
190  @NotNull()
191  public final AccessLogOperationType getOperationType()
192  {
193    return AccessLogOperationType.MODDN;
194  }
195}