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.text;
037
038
039
040import java.util.Set;
041
042import com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessageType;
043import com.unboundid.ldap.sdk.unboundidds.logs.LogException;
044import com.unboundid.ldap.sdk.unboundidds.logs.v2.SearchEntryAccessLogMessage;
045import com.unboundid.util.NotMutable;
046import com.unboundid.util.NotNull;
047import com.unboundid.util.Nullable;
048import com.unboundid.util.ThreadSafety;
049import com.unboundid.util.ThreadSafetyLevel;
050
051
052
053/**
054 * This class provides a data structure that holds information about a
055 * text-formatted search entry access log message.
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@NotMutable()
068@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
069public final class TextFormattedSearchEntryAccessLogMessage
070       extends TextFormattedSearchRequestAccessLogMessage
071       implements SearchEntryAccessLogMessage
072{
073  /**
074   * The serial version UID for this serializable class.
075   */
076  private static final long serialVersionUID = 7106446575112520912L;
077
078
079
080  // The set of attributes returned for this log message.
081  @NotNull private final Set<String> attributesReturned;
082
083  // The set of response control OIDs for this log message.
084  @NotNull private final Set<String> responseControlOIDs;
085
086  // The entry DN for this log message.
087  @Nullable private final String dn;
088
089
090
091  /**
092   * Creates a new text-formatted search result access log message from the
093   * provided message string.
094   *
095   * @param  logMessageString  The string representation of this log message.
096   *                           It must not be {@code null}.
097   *
098   * @throws  LogException  If the provided string cannot be parsed as a valid
099   *                        log message.
100   */
101  public TextFormattedSearchEntryAccessLogMessage(
102              @NotNull final String logMessageString)
103         throws LogException
104  {
105    this(new TextFormattedLogMessage(logMessageString));
106  }
107
108
109
110  /**
111   * Creates a new text-formatted search result access log message from the
112   * provided message.
113   *
114   * @param  logMessage  The log message to use to create this search entry
115   *                     access log message.  It must not be {@code null}.
116   */
117  TextFormattedSearchEntryAccessLogMessage(
118       @NotNull final TextFormattedLogMessage logMessage)
119  {
120    super(logMessage);
121
122    dn = getString(TextFormattedAccessLogFields.SEARCH_RESULT_ENTRY_DN);
123    attributesReturned = getCommaDelimitedStringSet(
124         TextFormattedAccessLogFields.SEARCH_RESULT_ENTRY_ATTRIBUTES);
125    responseControlOIDs = getCommaDelimitedStringSet(
126         TextFormattedAccessLogFields.RESPONSE_CONTROL_OIDS);
127  }
128
129
130
131  /**
132   * {@inheritDoc}
133   */
134  @Override()
135  @NotNull()
136  public AccessLogMessageType getMessageType()
137  {
138    return AccessLogMessageType.ENTRY;
139  }
140
141
142
143  /**
144   * {@inheritDoc}
145   */
146  @Override()
147  @Nullable()
148  public String getDN()
149  {
150    return dn;
151  }
152
153
154
155  /**
156   * {@inheritDoc}
157   */
158  @Override()
159  @NotNull()
160  public Set<String> getAttributesReturned()
161  {
162    return attributesReturned;
163  }
164
165
166
167  /**
168   * {@inheritDoc}
169   */
170  @Override()
171  @NotNull()
172  public Set<String> getResponseControlOIDs()
173  {
174    return responseControlOIDs;
175  }
176}