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 java.util.Set;
041
042import com.unboundid.ldap.sdk.unboundidds.logs.AccessLogOperationType;
043import com.unboundid.ldap.sdk.unboundidds.logs.LogException;
044import com.unboundid.ldap.sdk.unboundidds.logs.v2.ModifyRequestAccessLogMessage;
045import com.unboundid.util.NotExtensible;
046import com.unboundid.util.NotMutable;
047import com.unboundid.util.NotNull;
048import com.unboundid.util.Nullable;
049import com.unboundid.util.ThreadSafety;
050import com.unboundid.util.ThreadSafetyLevel;
051import com.unboundid.util.json.JSONObject;
052
053
054
055/**
056 * This class provides a data structure that holds information about a
057 * JSON-formatted modify request access log message.
058 * <BR>
059 * <BLOCKQUOTE>
060 *   <B>NOTE:</B>  This class, and other classes within the
061 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
062 *   supported for use against Ping Identity, UnboundID, and
063 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
064 *   for proprietary functionality or for external specifications that are not
065 *   considered stable or mature enough to be guaranteed to work in an
066 *   interoperable way with other types of LDAP servers.
067 * </BLOCKQUOTE>
068 */
069@NotExtensible()
070@NotMutable()
071@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
072public class JSONModifyRequestAccessLogMessage
073       extends JSONRequestAccessLogMessage
074       implements ModifyRequestAccessLogMessage
075{
076  /**
077   * The serial version UID for this serializable class.
078   */
079  private static final long serialVersionUID = -5294451900677670168L;
080
081
082
083  // The set of attributes to modify.
084  @NotNull private final Set<String> attributeNames;
085
086  // The DN of the entry to modify.
087  @Nullable private final String dn;
088
089
090
091  /**
092   * Creates a new JSON modify request access log message from the provided
093   * JSON object.
094   *
095   * @param  jsonObject  The JSON object that contains an encoded representation
096   *                     of this log message.  It must not be {@code null}.
097   *
098   * @throws  LogException  If the provided JSON object cannot be parsed as a
099   *                        valid log message.
100   */
101  public JSONModifyRequestAccessLogMessage(
102              @NotNull final JSONObject jsonObject)
103         throws LogException
104  {
105    super(jsonObject);
106
107    dn = getString(JSONFormattedAccessLogFields.MODIFY_ENTRY_DN);
108    attributeNames =
109         getStringSet(JSONFormattedAccessLogFields.MODIFY_ATTRIBUTES);
110  }
111
112
113
114  /**
115   * {@inheritDoc}
116   */
117  @Override()
118  @NotNull()
119  public final AccessLogOperationType getOperationType()
120  {
121    return AccessLogOperationType.MODIFY;
122  }
123
124
125
126  /**
127   * {@inheritDoc}
128   */
129  @Override()
130  @Nullable()
131  public final String getDN()
132  {
133    return dn;
134  }
135
136
137
138  /**
139   * {@inheritDoc}
140   */
141  @Override()
142  @NotNull()
143  public final Set<String> getAttributeNames()
144  {
145    return attributeNames;
146  }
147}