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.json;
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;
048import com.unboundid.util.json.JSONObject;
049
050
051
052/**
053 * This class provides a data structure that holds information about a
054 * JSON-formatted disconnect 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 JSONDisconnectAccessLogMessage
069       extends JSONAccessLogMessage
070       implements DisconnectAccessLogMessage
071{
072  /**
073   * The serial version UID for this serializable class.
074   */
075  private static final long serialVersionUID = 5958813974621309677L;
076
077
078
079  // The disconnect reason for this log message.
080  @Nullable private final String disconnectReason;
081
082  // The disconnect reason for this log message.
083  @Nullable private final String disconnectMessage;
084
085  // The requester IP address for this log message.
086  @Nullable private final String requesterIPAddress;
087
088
089
090  /**
091   * Creates a new JSON disconnect access log message from the provided JSON
092   * object.
093   *
094   * @param  jsonObject  The JSON object that contains an encoded representation
095   *                     of this log message.  It must not be {@code null}.
096   *
097   * @throws  LogException  If the provided JSON object cannot be parsed as a
098   *                        valid log message.
099   */
100  public JSONDisconnectAccessLogMessage(@NotNull final JSONObject jsonObject)
101         throws LogException
102  {
103    super(jsonObject);
104
105    disconnectReason =
106         getString(JSONFormattedAccessLogFields.DISCONNECT_REASON);
107    disconnectMessage =
108         getString(JSONFormattedAccessLogFields.DISCONNECT_MESSAGE);
109    requesterIPAddress =
110         getString(JSONFormattedAccessLogFields.REQUESTER_IP_ADDRESS);
111  }
112
113
114
115  /**
116   * {@inheritDoc}
117   */
118  @Override()
119  @NotNull()
120  public AccessLogMessageType getMessageType()
121  {
122    return AccessLogMessageType.DISCONNECT;
123  }
124
125
126
127  /**
128   * {@inheritDoc}
129   */
130  @Override()
131  @Nullable()
132  public String getDisconnectReason()
133  {
134    return disconnectReason;
135  }
136
137
138
139  /**
140   * {@inheritDoc}
141   */
142  @Override()
143  @Nullable()
144  public String getDisconnectMessage()
145  {
146    return disconnectMessage;
147  }
148
149
150
151  /**
152   * {@inheritDoc}
153   */
154  @Override()
155  @Nullable()
156  public String getRequesterIPAddress()
157  {
158    return requesterIPAddress;
159  }
160}