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.Collections;
041import java.util.List;
042
043import com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessageType;
044import com.unboundid.ldap.sdk.unboundidds.logs.LogException;
045import com.unboundid.ldap.sdk.unboundidds.logs.v2.
046            ClientCertificateAccessLogMessage;
047import com.unboundid.util.NotMutable;
048import com.unboundid.util.NotNull;
049import com.unboundid.util.Nullable;
050import com.unboundid.util.ThreadSafety;
051import com.unboundid.util.ThreadSafetyLevel;
052
053
054
055/**
056 * This class provides a data structure that holds information about a
057 * text-formatted client certificate access log message.
058 * <BR>
059 * <BLOCKQUOTE>
060 *   <B>NOTE:</B>  This class, and other classes within the
061 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
062 *   supported for use against Ping Identity, UnboundID, and
063 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
064 *   for proprietary functionality or for external specifications that are not
065 *   considered stable or mature enough to be guaranteed to work in an
066 *   interoperable way with other types of LDAP servers.
067 * </BLOCKQUOTE>
068 */
069@NotMutable()
070@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
071public final class TextFormattedClientCertificateAccessLogMessage
072       extends TextFormattedAccessLogMessage
073       implements ClientCertificateAccessLogMessage
074{
075  /**
076   * The serial version UID for this serializable class.
077   */
078  private static final long serialVersionUID = 4303971125611290508L;
079
080
081
082  // The list of subject DNs for the issuer certificates.
083  @NotNull private final List<String> issuerSubjectDNs;
084
085  // The auto-authenticated as DN for this log message.
086  @Nullable private final String autoAuthenticatedAsDN;
087
088  // The subject DN for the peer certificate
089  @Nullable private final String peerSubjectDN;
090
091
092
093  /**
094   * Creates a new text-formatted client certificate access log message from the
095   * provided message string.
096   *
097   * @param  logMessageString  The string representation of this log message.
098   *                           It must not be {@code null}.
099   *
100   * @throws  LogException  If the provided string cannot be parsed as a valid
101   *                        log message.
102   */
103  public TextFormattedClientCertificateAccessLogMessage(
104              @NotNull final String logMessageString)
105         throws LogException
106  {
107    this(new TextFormattedLogMessage(logMessageString));
108  }
109
110
111
112  /**
113   * Creates a new text-formatted client certificate access log message from the
114   * provided message.
115   *
116   * @param  logMessage  The log message to use to create this client
117   *                     certificate access log message.  It must not be
118   *                     {@code null}.
119   */
120  TextFormattedClientCertificateAccessLogMessage(
121       @NotNull final TextFormattedLogMessage logMessage)
122  {
123    super(logMessage);
124
125    peerSubjectDN =
126         getString(TextFormattedAccessLogFields.PEER_CERTIFICATE_SUBJECT_DN);
127    autoAuthenticatedAsDN =
128         getString(TextFormattedAccessLogFields.AUTO_AUTHENTICATED_AS);
129
130    final List<String> issuerDNs = getFields().get(TextFormattedAccessLogFields.
131         ISSUER_CERTIFICATE_SUBJECT_DN.getFieldName());
132    if (issuerDNs == null)
133    {
134      issuerSubjectDNs = Collections.emptyList();
135    }
136    else
137    {
138      issuerSubjectDNs = issuerDNs;
139    }
140  }
141
142
143
144  /**
145   * {@inheritDoc}
146   */
147  @Override()
148  @NotNull()
149  public AccessLogMessageType getMessageType()
150  {
151    return AccessLogMessageType.CLIENT_CERTIFICATE;
152  }
153
154
155
156  /**
157   * {@inheritDoc}
158   */
159  @Override()
160  @Nullable()
161  public String getPeerSubjectDN()
162  {
163    return peerSubjectDN;
164  }
165
166
167
168  /**
169   * {@inheritDoc}
170   */
171  @Override()
172  @NotNull()
173  public List<String> getIssuerSubjectDNs()
174  {
175    return issuerSubjectDNs;
176  }
177
178
179
180  /**
181   * {@inheritDoc}
182   */
183  @Override()
184  @Nullable()
185  public String getAutoAuthenticatedAsDN()
186  {
187    return autoAuthenticatedAsDN;
188  }
189}