001/*
002 * Copyright 2009-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-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) 2009-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;
037
038
039
040import com.unboundid.util.NotMutable;
041import com.unboundid.util.NotNull;
042import com.unboundid.util.Nullable;
043import com.unboundid.util.ThreadSafety;
044import com.unboundid.util.ThreadSafetyLevel;
045
046
047
048/**
049 * This class provides a data structure that holds information about a log
050 * message that may appear in the Directory Server access log about a client
051 * certificate that has been presented to the server.
052 * <BR>
053 * <BLOCKQUOTE>
054 *   <B>NOTE:</B>  This class, and other classes within the
055 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
056 *   supported for use against Ping Identity, UnboundID, and
057 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
058 *   for proprietary functionality or for external specifications that are not
059 *   considered stable or mature enough to be guaranteed to work in an
060 *   interoperable way with other types of LDAP servers.
061 * </BLOCKQUOTE>
062 */
063@NotMutable()
064@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
065public final class ClientCertificateAccessLogMessage
066       extends AccessLogMessage
067{
068  /**
069   * The serial version UID for this serializable class.
070   */
071  private static final long serialVersionUID = -2585979292882352926L;
072
073
074
075  // The subject DN for the issuer certificate.
076  @Nullable private final String issuerSubject;
077
078  // The subject DN for the client certificate.
079  @Nullable private final String peerSubject;
080
081
082
083  /**
084   * Creates a new client certificate access log message from the provided
085   * message string.
086   *
087   * @param  s  The string to be parsed as a client certificate access log
088   *            message.
089   *
090   * @throws  LogException  If the provided string cannot be parsed as a valid
091   *                        log message.
092   */
093  public ClientCertificateAccessLogMessage(@NotNull final String s)
094         throws LogException
095  {
096    this(new LogMessage(s));
097  }
098
099
100
101  /**
102   * Creates a new connect access log message from the provided log message.
103   *
104   * @param  m  The log message to be parsed as a connect access log message.
105   */
106  public ClientCertificateAccessLogMessage(@NotNull final LogMessage m)
107  {
108    super(m);
109
110    peerSubject   = getNamedValue("peerSubject");
111    issuerSubject = getNamedValue("issuerSubject");
112  }
113
114
115
116  /**
117   * Retrieves the subject of the peer certificate.
118   *
119   * @return  The subject of the peer certificate, or {@code null} if it is not
120   *          included in the log message.
121   */
122  @Nullable()
123  public String getPeerSubject()
124  {
125    return peerSubject;
126  }
127
128
129
130  /**
131   * Retrieves the subject of the issuer certificate.
132   *
133   * @return  The subject of the issuer certificate, or {@code null} if it is
134   *          not included in the log message.
135   */
136  @Nullable()
137  public String getIssuerSubject()
138  {
139    return issuerSubject;
140  }
141
142
143
144  /**
145   * {@inheritDoc}
146   */
147  @Override()
148  @NotNull()
149  public AccessLogMessageType getMessageType()
150  {
151    return AccessLogMessageType.CLIENT_CERTIFICATE;
152  }
153}