001/*
002 * Copyright 2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 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) 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.v2;
037
038
039
040import com.unboundid.ldap.sdk.unboundidds.logs.AccessLogMessageType;
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 an access
051 * 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 interface AccessLogMessage
066       extends LogMessage
067{
068  /**
069   * Retrieves the server product name for this access log message.
070   *
071   * @return  The server product name for this access log message, or
072   *          {@code null} if it is not included in the log message.
073   */
074  @Nullable()
075  String getProductName();
076
077
078
079  /**
080   * Retrieves the Directory Server instance name for this access log message.
081   *
082   * @return  The Directory Server instance name for this access log message, or
083   *          {@code null} if it is not included in the log message.
084   */
085  @Nullable()
086  String getInstanceName();
087
088
089
090  /**
091   * Retrieves the Directory Server startup ID for this access log message.
092   *
093   * @return  The Directory Server startup ID for this access log message, or
094   *          {@code null} if it is not included in the log message.
095   */
096  @Nullable()
097  String getStartupID();
098
099
100
101  /**
102   * Retrieves the thread ID for the server thread that generated this access
103   * log message.
104   *
105   * @return  The Directory Server thread ID for this access log message, or
106   *          {@code null} if it is not included in the log message.
107   */
108  @Nullable()
109  Long getThreadID();
110
111
112
113  /**
114   * Retrieves the connection ID for the connection with which this access log
115   * message is associated.
116   *
117   * @return  The connection ID for the connection with which this access log
118   *          message is associated, or {@code null} if it is not included in
119   *          the log message.
120   */
121  @Nullable
122  Long getConnectionID();
123
124
125
126  /**
127   * Retrieves the message type for this access log message.
128   *
129   * @return  The message type for this access log message.
130   */
131  @NotNull()
132  AccessLogMessageType getMessageType();
133}