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