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