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