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.text;
037
038
039
040import com.unboundid.ldap.sdk.unboundidds.logs.v2.AccessLogMessage;
041import com.unboundid.util.NotExtensible;
042import com.unboundid.util.NotNull;
043import com.unboundid.util.Nullable;
044import com.unboundid.util.ThreadSafety;
045import com.unboundid.util.ThreadSafetyLevel;
046
047
048
049/**
050 * This class provides a data structure that holds information about a
051 * text-formatted access log message.
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@NotExtensible()
064@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
065public abstract class TextFormattedAccessLogMessage
066       extends TextFormattedLogMessage
067       implements AccessLogMessage
068{
069  /**
070   * The serial version UID for this serializable class.
071   */
072  private static final long serialVersionUID = 458413508863077700L;
073
074
075
076  // The connection ID value from the log message.
077  @Nullable private final Long connectionID;
078
079  // The thread ID value from the log message.
080  @Nullable private final Long threadID;
081
082  // The instance name value from the log message.
083  @Nullable private final String instanceName;
084
085  // The product name value from the log message.
086  @Nullable private final String productName;
087
088  // The startup ID value from the log message.
089  @Nullable private final String startupID;
090
091
092
093  /**
094   * Creates a new text-formatted access log message from the provided message.
095   *
096   * @param  logMessage  The log message to use to create this access log
097   *                     message.  It must not be {@code null}.
098   */
099  protected TextFormattedAccessLogMessage(
100                 @NotNull final TextFormattedLogMessage logMessage)
101  {
102    super(logMessage);
103
104    instanceName = getString(TextFormattedAccessLogFields.INSTANCE_NAME);
105    productName = getString(TextFormattedAccessLogFields.PRODUCT_NAME);
106    startupID = getString(TextFormattedAccessLogFields.STARTUP_ID);
107    threadID = getLongNoThrow(TextFormattedAccessLogFields.THREAD_ID);
108    connectionID =
109         getLongNoThrow(TextFormattedAccessLogFields.CONNECTION_ID);
110  }
111
112
113
114  /**
115   * {@inheritDoc}
116   */
117  @Override()
118  @Nullable()
119  public final String getProductName()
120  {
121    return productName;
122  }
123
124
125
126  /**
127   * {@inheritDoc}
128   */
129  @Override()
130  @Nullable()
131  public final String getInstanceName()
132  {
133    return instanceName;
134  }
135
136
137
138  /**
139   * {@inheritDoc}
140   */
141  @Override()
142  @Nullable()
143  public final String getStartupID()
144  {
145    return startupID;
146  }
147
148
149
150  /**
151   * {@inheritDoc}
152   */
153  @Override()
154  @Nullable()
155  public final Long getThreadID()
156  {
157    return threadID;
158  }
159
160
161
162  /**
163   * {@inheritDoc}
164   */
165  @Override()
166  @Nullable
167  public final Long getConnectionID()
168  {
169    return connectionID;
170  }
171}