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 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;
050
051
052
053/**
054 * This class provides a data structure that holds information about a
055 * text-formatted bind request 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@NotExtensible()
068@NotMutable()
069@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
070public class TextFormattedBindRequestAccessLogMessage
071       extends TextFormattedRequestAccessLogMessage
072       implements BindRequestAccessLogMessage
073{
074  /**
075   * The serial version UID for this serializable class.
076   */
077  private static final long serialVersionUID = 8084301781864176576L;
078
079
080
081  // The authentication type for the bind request.
082  @Nullable private final BindRequestAuthenticationType authenticationType;
083
084  // The bind DN for the bind request.
085  @Nullable private final String dn;
086
087  // The protocol version for the bind request.
088  @Nullable private final String protocolVersion;
089
090  // The SASL mechanism name for the bind request.
091  @Nullable private final String saslMechanismName;
092
093
094
095  /**
096   * Creates a new text-formatted bind request access log message from the
097   * provided message string.
098   *
099   * @param  logMessageString  The string representation of this log message.
100   *                           It must not be {@code null}.
101   *
102   * @throws  LogException  If the provided string cannot be parsed as a valid
103   *                        log message.
104   */
105  public TextFormattedBindRequestAccessLogMessage(
106              @NotNull final String logMessageString)
107         throws LogException
108  {
109    this(new TextFormattedLogMessage(logMessageString));
110  }
111
112
113
114  /**
115   * Creates a new text-formatted bind request access log message from the
116   * provided message.
117   *
118   * @param  logMessage  The log message to use to create this bind request
119   *                     access log message.  It must not be {@code null}.
120   */
121
122  TextFormattedBindRequestAccessLogMessage(
123       @NotNull final TextFormattedLogMessage logMessage)
124  {
125    super(logMessage);
126
127    dn = getString(TextFormattedAccessLogFields.BIND_DN);
128    protocolVersion =
129         getString(TextFormattedAccessLogFields.BIND_PROTOCOL_VERSION);
130    saslMechanismName =
131         getString(TextFormattedAccessLogFields.BIND_SASL_MECHANISM);
132
133    final String authType =
134         getString(TextFormattedAccessLogFields.BIND_AUTHENTICATION_TYPE);
135    if (authType == null)
136    {
137      authenticationType = null;
138    }
139    else
140    {
141      authenticationType = BindRequestAuthenticationType.forName(authType);
142    }
143  }
144
145
146
147  /**
148   * {@inheritDoc}
149   */
150  @Override()
151  @NotNull()
152  public final AccessLogOperationType getOperationType()
153  {
154    return AccessLogOperationType.BIND;
155  }
156
157
158
159  /**
160   * {@inheritDoc}
161   */
162  @Override()
163  @Nullable()
164  public final BindRequestAuthenticationType getAuthenticationType()
165  {
166    return authenticationType;
167  }
168
169
170
171  /**
172   * {@inheritDoc}
173   */
174  @Override()
175  @Nullable()
176  public final String getDN()
177  {
178    return dn;
179  }
180
181
182
183  /**
184   * {@inheritDoc}
185   */
186  @Override()
187  @Nullable()
188  public final String getProtocolVersion()
189  {
190    return protocolVersion;
191  }
192
193
194
195  /**
196   * {@inheritDoc}
197   */
198  @Override()
199  @Nullable()
200  public final String getSASLMechanismName()
201  {
202    return saslMechanismName;
203  }
204}