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 com.unboundid.ldap.sdk.unboundidds.logs.AccessLogOperationType;
041import com.unboundid.ldap.sdk.unboundidds.logs.BindRequestAuthenticationType;
042import com.unboundid.ldap.sdk.unboundidds.logs.LogException;
043import com.unboundid.ldap.sdk.unboundidds.logs.v2.BindRequestAccessLogMessage;
044import com.unboundid.util.NotExtensible;
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 bind 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 JSONBindRequestAccessLogMessage
072       extends JSONRequestAccessLogMessage
073       implements BindRequestAccessLogMessage
074{
075  /**
076   * The serial version UID for this serializable class.
077   */
078  private static final long serialVersionUID = 6983414352725940767L;
079
080
081
082  // The authentication type for the bind request.
083  @Nullable private final BindRequestAuthenticationType authenticationType;
084
085  // The bind DN for the bind request.
086  @Nullable private final String dn;
087
088  // The protocol version for the bind request.
089  @Nullable private final String protocolVersion;
090
091  // The SASL mechanism name for the bind request.
092  @Nullable private final String saslMechanismName;
093
094
095
096  /**
097   * Creates a new JSON bind request access log message from the provided
098   * JSON object.
099   *
100   * @param  jsonObject  The JSON object that contains an encoded representation
101   *                     of this log message.  It must not be {@code null}.
102   *
103   * @throws  LogException  If the provided JSON object cannot be parsed as a
104   *                        valid log message.
105   */
106  public JSONBindRequestAccessLogMessage(@NotNull final JSONObject jsonObject)
107         throws LogException
108  {
109    super(jsonObject);
110
111    dn = getString(JSONFormattedAccessLogFields.BIND_DN);
112    protocolVersion =
113         getString(JSONFormattedAccessLogFields.BIND_PROTOCOL_VERSION);
114    saslMechanismName =
115         getString(JSONFormattedAccessLogFields.BIND_SASL_MECHANISM);
116
117    final String authType =
118         getString(JSONFormattedAccessLogFields.BIND_AUTHENTICATION_TYPE);
119    if (authType == null)
120    {
121      authenticationType = null;
122    }
123    else
124    {
125      authenticationType = BindRequestAuthenticationType.forName(authType);
126    }
127  }
128
129
130
131  /**
132   * {@inheritDoc}
133   */
134  @Override()
135  @NotNull()
136  public final AccessLogOperationType getOperationType()
137  {
138    return AccessLogOperationType.BIND;
139  }
140
141
142
143  /**
144   * {@inheritDoc}
145   */
146  @Override()
147  @Nullable()
148  public final BindRequestAuthenticationType getAuthenticationType()
149  {
150    return authenticationType;
151  }
152
153
154
155  /**
156   * {@inheritDoc}
157   */
158  @Override()
159  @Nullable()
160  public final String getDN()
161  {
162    return dn;
163  }
164
165
166
167  /**
168   * {@inheritDoc}
169   */
170  @Override()
171  @Nullable()
172  public final String getProtocolVersion()
173  {
174    return protocolVersion;
175  }
176
177
178
179  /**
180   * {@inheritDoc}
181   */
182  @Override()
183  @Nullable()
184  public final String getSASLMechanismName()
185  {
186    return saslMechanismName;
187  }
188}