001/*
002 * Copyright 2009-2020 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-2020 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) 2015-2020 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.ThreadSafety;
048import com.unboundid.util.ThreadSafetyLevel;
049
050
051
052/**
053 * This class provides a data structure that holds information about a log
054 * message that may appear in the Directory Server access log about an add
055 * request received from a client.
056 * <BR>
057 * <BLOCKQUOTE>
058 *   <B>NOTE:</B>  This class, and other classes within the
059 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
060 *   supported for use against Ping Identity, UnboundID, and
061 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
062 *   for proprietary functionality or for external specifications that are not
063 *   considered stable or mature enough to be guaranteed to work in an
064 *   interoperable way with other types of LDAP servers.
065 * </BLOCKQUOTE>
066 */
067@NotExtensible()
068@NotMutable()
069@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
070public class AddRequestAccessLogMessage
071       extends OperationRequestAccessLogMessage
072{
073  /**
074   * The serial version UID for this serializable class.
075   */
076  private static final long serialVersionUID = -1234543653722421757L;
077
078
079
080  // The list of attributes included in the entry.
081  private final List<String> attributeNames;
082
083  // The DN of the entry to add.
084  private final String dn;
085
086
087
088  /**
089   * Creates a new add request access log message from the provided message
090   * string.
091   *
092   * @param  s  The string to be parsed as an add request access log message.
093   *
094   * @throws  LogException  If the provided string cannot be parsed as a valid
095   *                        log message.
096   */
097  public AddRequestAccessLogMessage(final String s)
098         throws LogException
099  {
100    this(new LogMessage(s));
101  }
102
103
104
105  /**
106   * Creates a new add request access log message from the provided message
107   * string.
108   *
109   * @param  m  The log message to be parsed as an add request access log
110   *            message.
111   */
112  public AddRequestAccessLogMessage(final LogMessage m)
113  {
114    super(m);
115
116    dn = getNamedValue("dn");
117
118    final String attrs = getNamedValue("attrs");
119    if (attrs == null)
120    {
121      attributeNames = null;
122    }
123    else
124    {
125      final ArrayList<String> l = new ArrayList<>(10);
126      final StringTokenizer tokenizer = new StringTokenizer(attrs, ",");
127      while (tokenizer.hasMoreTokens())
128      {
129        l.add(tokenizer.nextToken());
130      }
131
132      attributeNames = Collections.unmodifiableList(l);
133    }
134  }
135
136
137
138  /**
139   * Retrieves the DN of the entry to add.
140   *
141   * @return  The DN of the entry to add, or {@code null} if it is not included
142   *          in the log message.
143   */
144  public final String getDN()
145  {
146    return dn;
147  }
148
149
150
151  /**
152   * Retrieves the names of the attributes included in the add request.
153   *
154   * @return  The names of the attributes included in the add request, or
155   *          {@code null} if that is not included in the log message.
156   */
157  public final List<String> getAttributeNames()
158  {
159    return attributeNames;
160  }
161
162
163
164  /**
165   * {@inheritDoc}
166   */
167  @Override()
168  public final AccessLogOperationType getOperationType()
169  {
170    return AccessLogOperationType.ADD;
171  }
172}