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.text;
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;
051
052
053
054/**
055 * This class provides a data structure that holds information about a
056 * text-formatted modify 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 TextFormattedModifyRequestAccessLogMessage
072       extends TextFormattedRequestAccessLogMessage
073       implements ModifyRequestAccessLogMessage
074{
075  /**
076   * The serial version UID for this serializable class.
077   */
078  private static final long serialVersionUID = 1169078016226018473L;
079
080
081
082  // The set of attributes to modify.
083  @NotNull private final Set<String> attributeNames;
084
085  // The DN of the entry to modify.
086  @Nullable private final String dn;
087
088
089
090  /**
091   * Creates a new text-formatted modify request access log message from the
092   * provided message string.
093   *
094   * @param  logMessageString  The string representation of this log message.
095   *                           It must not be {@code null}.
096   *
097   * @throws  LogException  If the provided string cannot be parsed as a valid
098   *                        log message.
099   */
100  public TextFormattedModifyRequestAccessLogMessage(
101              @NotNull final String logMessageString)
102         throws LogException
103  {
104    this(new TextFormattedLogMessage(logMessageString));
105  }
106
107
108
109  /**
110   * Creates a new text-formatted modify request access log message from the
111   * provided message.
112   *
113   * @param  logMessage  The log message to use to create this modify request
114   *                     access log message.  It must not be {@code null}.
115   */
116  TextFormattedModifyRequestAccessLogMessage(
117       @NotNull final TextFormattedLogMessage logMessage)
118  {
119    super(logMessage);
120
121    dn = getString(TextFormattedAccessLogFields.MODIFY_ENTRY_DN);
122    attributeNames = getCommaDelimitedStringSet(
123         TextFormattedAccessLogFields.MODIFY_ATTRIBUTES);
124  }
125
126
127
128  /**
129   * {@inheritDoc}
130   */
131  @Override()
132  @NotNull()
133  public final AccessLogOperationType getOperationType()
134  {
135    return AccessLogOperationType.MODIFY;
136  }
137
138
139
140  /**
141   * {@inheritDoc}
142   */
143  @Override()
144  @Nullable()
145  public final String getDN()
146  {
147    return dn;
148  }
149
150
151
152  /**
153   * {@inheritDoc}
154   */
155  @Override()
156  @NotNull()
157  public final Set<String> getAttributeNames()
158  {
159    return attributeNames;
160  }
161}