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.AccessLogMessageType;
041import com.unboundid.ldap.sdk.unboundidds.logs.LogException;
042import com.unboundid.ldap.sdk.unboundidds.logs.v2.
043            SecurityNegotiationAccessLogMessage;
044import com.unboundid.util.NotMutable;
045import com.unboundid.util.NotNull;
046import com.unboundid.util.Nullable;
047import com.unboundid.util.ThreadSafety;
048import com.unboundid.util.ThreadSafetyLevel;
049
050
051
052/**
053 * This class provides a data structure that holds information about a
054 * text-formatted security negotiation access log message.
055 * <BR>
056 * <BLOCKQUOTE>
057 *   <B>NOTE:</B>  This class, and other classes within the
058 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
059 *   supported for use against Ping Identity, UnboundID, and
060 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
061 *   for proprietary functionality or for external specifications that are not
062 *   considered stable or mature enough to be guaranteed to work in an
063 *   interoperable way with other types of LDAP servers.
064 * </BLOCKQUOTE>
065 */
066@NotMutable()
067@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
068public final class TextFormattedSecurityNegotiationAccessLogMessage
069       extends TextFormattedAccessLogMessage
070       implements SecurityNegotiationAccessLogMessage
071{
072  /**
073   * The serial version UID for this serializable class.
074   */
075  private static final long serialVersionUID = 1270244499313685235L;
076
077
078
079  // The cipher for this log message.
080  @Nullable private final String cipher;
081
082  // The protocol for this log message.
083  @Nullable private final String protocol;
084
085
086
087  /**
088   * Creates a new text-formatted security negotiation access log message from
089   * the provided message.
090   *
091   * @param  logMessageString  The string representation of this log message.
092   *                           It must not be {@code null}.
093   *
094   * @throws  LogException  If the provided string cannot be parsed as a valid
095   *                        log message.
096   */
097  public TextFormattedSecurityNegotiationAccessLogMessage(
098              @NotNull final String logMessageString)
099         throws LogException
100  {
101    this(new TextFormattedLogMessage(logMessageString));
102  }
103
104
105
106  /**
107   * Creates a new text-formatted security negotiation access log message from
108   * the provided message string.
109   *
110   * @param  logMessage  The log message to use to create this security
111   *                     negotiation access log message.  It must not be
112   *                     {@code null}.
113   */
114  TextFormattedSecurityNegotiationAccessLogMessage(
115       @NotNull final TextFormattedLogMessage logMessage)
116  {
117    super(logMessage);
118
119    protocol = getString(TextFormattedAccessLogFields.PROTOCOL);
120    cipher = getString(TextFormattedAccessLogFields.CIPHER);
121  }
122
123
124
125  /**
126   * {@inheritDoc}
127   */
128  @Override()
129  @NotNull()
130  public AccessLogMessageType getMessageType()
131  {
132    return AccessLogMessageType.SECURITY_NEGOTIATION;
133  }
134
135
136
137  /**
138   * {@inheritDoc}
139   */
140  @Override()
141  @Nullable()
142  public String getProtocol()
143  {
144    return protocol;
145  }
146
147
148
149  /**
150   * {@inheritDoc}
151   */
152  @Override()
153  @Nullable()
154  public String getCipher()
155  {
156    return cipher;
157  }
158}