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.LogException;
041import com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage;
042import com.unboundid.util.NotExtensible;
043import com.unboundid.util.NotNull;
044import com.unboundid.util.Nullable;
045import com.unboundid.util.ThreadSafety;
046import com.unboundid.util.ThreadSafetyLevel;
047import com.unboundid.util.json.JSONObject;
048
049
050
051/**
052 * This class provides a data structure that holds information about a
053 * JSON-formatted access log message.
054 * <BR>
055 * <BLOCKQUOTE>
056 *   <B>NOTE:</B>  This class, and other classes within the
057 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
058 *   supported for use against Ping Identity, UnboundID, and
059 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
060 *   for proprietary functionality or for external specifications that are not
061 *   considered stable or mature enough to be guaranteed to work in an
062 *   interoperable way with other types of LDAP servers.
063 * </BLOCKQUOTE>
064 */
065@NotExtensible()
066@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
067public abstract class JSONAccessLogMessage
068       extends JSONLogMessage
069       implements AccessLogMessage
070{
071  /**
072   * The serial version UID for this serializable class.
073   */
074  private static final long serialVersionUID = 8694184933366259453L;
075
076
077
078  // The connection ID value from the log message.
079  @Nullable private final Long connectionID;
080
081  // The thread ID value from the log message.
082  @Nullable private final Long threadID;
083
084  // The instance name value from the log message.
085  @Nullable private final String instanceName;
086
087  // The product name value from the log message.
088  @Nullable private final String productName;
089
090  // The startup ID value from the log message.
091  @Nullable private final String startupID;
092
093
094
095  /**
096   * Creates a new JSON access log message from the provided JSON object.
097   *
098   * @param  jsonObject  The JSON object that contains an encoded representation
099   *                     of this log message.  It must not be {@code null}.
100   *
101   * @throws  LogException  If the provided JSON object cannot be parsed as a
102   *                        valid log message.
103   */
104  protected JSONAccessLogMessage(@NotNull final JSONObject jsonObject)
105            throws LogException
106  {
107    super(jsonObject);
108
109    instanceName = getString(JSONFormattedAccessLogFields.INSTANCE_NAME);
110    productName = getString(JSONFormattedAccessLogFields.PRODUCT_NAME);
111    startupID = getString(JSONFormattedAccessLogFields.STARTUP_ID);
112    threadID = getLongNoThrow(JSONFormattedAccessLogFields.THREAD_ID);
113    connectionID =
114         getLongNoThrow(JSONFormattedAccessLogFields.CONNECTION_ID);
115  }
116
117
118
119  /**
120   * {@inheritDoc}
121   */
122  @Override()
123  @Nullable()
124  public final String getProductName()
125  {
126    return productName;
127  }
128
129
130
131  /**
132   * {@inheritDoc}
133   */
134  @Override()
135  @Nullable()
136  public final String getInstanceName()
137  {
138    return instanceName;
139  }
140
141
142
143  /**
144   * {@inheritDoc}
145   */
146  @Override()
147  @Nullable()
148  public final String getStartupID()
149  {
150    return startupID;
151  }
152
153
154
155  /**
156   * {@inheritDoc}
157   */
158  @Override()
159  @Nullable()
160  public final Long getThreadID()
161  {
162    return threadID;
163  }
164
165
166
167  /**
168   * {@inheritDoc}
169   */
170  @Override()
171  @Nullable
172  public final Long getConnectionID()
173  {
174    return connectionID;
175  }
176}