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
051 * connection that has been closed.
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 DisconnectAccessLogMessage
066       extends AccessLogMessage
067{
068  /**
069   * The serial version UID for this serializable class.
070   */
071  private static final long serialVersionUID = -6224280874144845557L;
072
073
074
075  // The message providing additional information about the disconnect.
076  @Nullable private final String message;
077
078  // The reason for the disconnect.
079  @Nullable private final String reason;
080
081
082
083  /**
084   * Creates a new disconnect access log message from the provided message
085   * string.
086   *
087   * @param  s  The string to be parsed as a disconnect access log message.
088   *
089   * @throws  LogException  If the provided string cannot be parsed as a valid
090   *                        log message.
091   */
092  public DisconnectAccessLogMessage(@NotNull final String s)
093         throws LogException
094  {
095    this(new LogMessage(s));
096  }
097
098
099
100  /**
101   * Creates a new disconnect access log message from the provided log message.
102   *
103   * @param  m  The log message to be parsed as a disconnect access log message.
104   */
105  public DisconnectAccessLogMessage(@NotNull final LogMessage m)
106  {
107    super(m);
108
109    reason  = getNamedValue("reason");
110    message = getNamedValue("msg");
111  }
112
113
114
115  /**
116   * Retrieves the disconnect reason for the log message.
117   *
118   * @return  The disconnect reason for the log message, or {@code null} if it
119   *          is not included in the log message.
120   */
121  @Nullable()
122  public String getDisconnectReason()
123  {
124    return reason;
125  }
126
127
128
129  /**
130   * Retrieves a message with additional information about the disconnect.
131   *
132   * @return  A message with additional information about the disconnect, or
133   *          {@code null} if it is not included in the log message.
134   */
135  @Nullable()
136  public String getMessage()
137  {
138    return message;
139  }
140
141
142
143  /**
144   * {@inheritDoc}
145   */
146  @Override()
147  @NotNull()
148  public AccessLogMessageType getMessageType()
149  {
150    return AccessLogMessageType.DISCONNECT;
151  }
152}