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.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;
050import com.unboundid.util.json.JSONObject;
051
052
053
054/**
055 * This class provides a data structure that holds information about a
056 * JSON-formatted search entry 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@NotMutable()
069@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
070public final class JSONSearchEntryAccessLogMessage
071       extends JSONSearchRequestAccessLogMessage
072       implements SearchEntryAccessLogMessage
073{
074  /**
075   * The serial version UID for this serializable class.
076   */
077  private static final long serialVersionUID = 198085732170528719L;
078
079
080
081  // The set of attributes returned for this log message.
082  @NotNull private final Set<String> attributesReturned;
083
084  // The set of response control OIDs for this log message.
085  @NotNull private final Set<String> responseControlOIDs;
086
087  // The entry DN for this log message.
088  @Nullable private final String dn;
089
090
091
092  /**
093   * Creates a new JSON search result access log message from the provided JSON
094   * object.
095   *
096   * @param  jsonObject  The JSON object that contains an encoded representation
097   *                     of this log message.  It must not be {@code null}.
098   *
099   * @throws  LogException  If the provided JSON object cannot be parsed as a
100   *                        valid log message.
101   */
102  public JSONSearchEntryAccessLogMessage(@NotNull final JSONObject jsonObject)
103         throws LogException
104  {
105    super(jsonObject);
106
107    dn = getString(JSONFormattedAccessLogFields.SEARCH_RESULT_ENTRY_DN);
108    attributesReturned = getStringSet(
109         JSONFormattedAccessLogFields.SEARCH_RESULT_ENTRY_ATTRIBUTES);
110    responseControlOIDs = getStringSet(
111         JSONFormattedAccessLogFields.RESPONSE_CONTROL_OIDS);
112  }
113
114
115
116  /**
117   * {@inheritDoc}
118   */
119  @Override()
120  @NotNull()
121  public AccessLogMessageType getMessageType()
122  {
123    return AccessLogMessageType.ENTRY;
124  }
125
126
127
128  /**
129   * {@inheritDoc}
130   */
131  @Override()
132  @Nullable()
133  public String getDN()
134  {
135    return dn;
136  }
137
138
139
140  /**
141   * {@inheritDoc}
142   */
143  @Override()
144  @NotNull()
145  public Set<String> getAttributesReturned()
146  {
147    return attributesReturned;
148  }
149
150
151
152  /**
153   * {@inheritDoc}
154   */
155  @Override()
156  @NotNull()
157  public Set<String> getResponseControlOIDs()
158  {
159    return responseControlOIDs;
160  }
161}