001/*
002 * Copyright 2009-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-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) 2009-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;
037
038
039
040import java.util.ArrayList;
041import java.util.Collections;
042import java.util.List;
043import java.util.StringTokenizer;
044
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 log
056 * message that may appear in the Directory Server access log about an add
057 * request received from a client.
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 AddRequestAccessLogMessage
073       extends OperationRequestAccessLogMessage
074{
075  /**
076   * The serial version UID for this serializable class.
077   */
078  private static final long serialVersionUID = -1234543653722421757L;
079
080
081
082  // The list of attributes included in the entry.
083  @Nullable private final List<String> attributeNames;
084
085  // The DN of the entry to add.
086  @Nullable private final String dn;
087
088
089
090  /**
091   * Creates a new add request access log message from the provided message
092   * string.
093   *
094   * @param  s  The string to be parsed as an add request access log message.
095   *
096   * @throws  LogException  If the provided string cannot be parsed as a valid
097   *                        log message.
098   */
099  public AddRequestAccessLogMessage(@NotNull final String s)
100         throws LogException
101  {
102    this(new LogMessage(s));
103  }
104
105
106
107  /**
108   * Creates a new add request access log message from the provided message
109   * string.
110   *
111   * @param  m  The log message to be parsed as an add request access log
112   *            message.
113   */
114  public AddRequestAccessLogMessage(@NotNull final LogMessage m)
115  {
116    super(m);
117
118    dn = getNamedValue("dn");
119
120    final String attrs = getNamedValue("attrs");
121    if (attrs == null)
122    {
123      attributeNames = null;
124    }
125    else
126    {
127      final ArrayList<String> l = new ArrayList<>(10);
128      final StringTokenizer tokenizer = new StringTokenizer(attrs, ",");
129      while (tokenizer.hasMoreTokens())
130      {
131        l.add(tokenizer.nextToken());
132      }
133
134      attributeNames = Collections.unmodifiableList(l);
135    }
136  }
137
138
139
140  /**
141   * Retrieves the DN of the entry to add.
142   *
143   * @return  The DN of the entry to add, or {@code null} if it is not included
144   *          in the log message.
145   */
146  @Nullable()
147  public final String getDN()
148  {
149    return dn;
150  }
151
152
153
154  /**
155   * Retrieves the names of the attributes included in the add request.
156   *
157   * @return  The names of the attributes included in the add request, or
158   *          {@code null} if that is not included in the log message.
159   */
160  @Nullable()
161  public final List<String> getAttributeNames()
162  {
163    return attributeNames;
164  }
165
166
167
168  /**
169   * {@inheritDoc}
170   */
171  @Override()
172  @NotNull()
173  public final AccessLogOperationType getOperationType()
174  {
175    return AccessLogOperationType.ADD;
176  }
177}