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.NotExtensible; 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. 049 * <BR> 050 * <BLOCKQUOTE> 051 * <B>NOTE:</B> This class, and other classes within the 052 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 053 * supported for use against Ping Identity, UnboundID, and 054 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 055 * for proprietary functionality or for external specifications that are not 056 * considered stable or mature enough to be guaranteed to work in an 057 * interoperable way with other types of LDAP servers. 058 * </BLOCKQUOTE> 059 */ 060@NotExtensible() 061@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 062public abstract class AccessLogMessage 063 extends LogMessage 064{ 065 /** 066 * The serial version UID for this serializable class. 067 */ 068 private static final long serialVersionUID = 111497572975341652L; 069 070 071 072 // The connection ID for this access log message. 073 private final Long connectionID; 074 075 // The Directory Server instance name for this access log message. 076 private final String instanceName; 077 078 // The server product name for this access log message. 079 private final String productName; 080 081 // The startup ID for this access log message; 082 private final String startupID; 083 084 085 086 /** 087 * Creates a new access log message from the provided log message. 088 * 089 * @param m The log message to be parsed as an access log message. 090 */ 091 protected AccessLogMessage(final LogMessage m) 092 { 093 super(m); 094 095 productName = getNamedValue("product"); 096 instanceName = getNamedValue("instanceName"); 097 startupID = getNamedValue("startupID"); 098 connectionID = getNamedValueAsLong("conn"); 099 } 100 101 102 103 /** 104 * Parses the provided string as an access log message. 105 * 106 * @param s The string to parse as an access log message. 107 * 108 * @return The parsed access log message. 109 * 110 * @throws LogException If an error occurs while trying to parse the log 111 * message. 112 */ 113 public static AccessLogMessage parse(final String s) 114 throws LogException 115 { 116 return AccessLogReader.parse(s); 117 } 118 119 120 121 /** 122 * Retrieves the server product name for this access log message. 123 * 124 * @return The server product name for this access log message, or 125 * {@code null} if it is not included in the log message. 126 */ 127 public final String getProductName() 128 { 129 return productName; 130 } 131 132 133 134 /** 135 * Retrieves the Directory Server instance name for this access log message. 136 * 137 * @return The Directory Server instance name for this access log message, or 138 * {@code null} if it is not included in the log message. 139 */ 140 public final String getInstanceName() 141 { 142 return instanceName; 143 } 144 145 146 147 /** 148 * Retrieves the Directory Server startup ID for this access log message. 149 * 150 * @return The Directory Server startup ID for this access log message, or 151 * {@code null} if it is not included in the log message. 152 */ 153 public final String getStartupID() 154 { 155 return startupID; 156 } 157 158 159 160 /** 161 * Retrieves the connection ID for the connection with which this access log 162 * message is associated. 163 * 164 * @return The connection ID for the connection with which this access log 165 * message is associated, or {@code null} if it is not included in 166 * the log message. 167 */ 168 public final Long getConnectionID() 169 { 170 return connectionID; 171 } 172 173 174 175 /** 176 * Retrieves the message type for this access log message. 177 * 178 * @return The message type for this access log message. 179 */ 180 public abstract AccessLogMessageType getMessageType(); 181}