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