001/*
002 * Copyright 2011-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2011-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) 2011-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;
037
038
039
040import java.util.List;
041
042import com.unboundid.ldap.sdk.ResultCode;
043import com.unboundid.util.NotExtensible;
044import com.unboundid.util.NotNull;
045import com.unboundid.util.Nullable;
046import com.unboundid.util.ThreadSafety;
047import com.unboundid.util.ThreadSafetyLevel;
048
049
050
051/**
052 * This interface defines a number of methods common to all types of operation
053 * result access log messages.
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 interface MinimalOperationResultAccessLogMessage
068{
069  /**
070   * Retrieves the result code for the operation.
071   *
072   * @return  The result code for the operation, or {@code null} if it is not
073   *          included in the log message.
074   */
075  @Nullable()
076  ResultCode getResultCode();
077
078
079
080  /**
081   * Retrieves the diagnostic message for the operation.
082   *
083   * @return  The diagnostic message for the operation, or {@code null} if it is
084   *          not included in the log message.
085   */
086  @Nullable()
087  String getDiagnosticMessage();
088
089
090
091  /**
092   * Retrieves a message with additional information about the result of the
093   * operation.
094   *
095   * @return  A message with additional information about the result of the
096   *          operation, or {@code null} if it is not included in the log
097   *          message.
098   */
099  @Nullable()
100  String getAdditionalInformation();
101
102
103
104  /**
105   * Retrieves the matched DN for the operation.
106   *
107   * @return  The matched DN for the operation, or {@code null} if it is not
108   *          included in the log message.
109   */
110  @Nullable()
111  String getMatchedDN();
112
113
114
115  /**
116   * Retrieves the list of referral URLs for the operation.
117   *
118   * @return  The list of referral URLs for the operation, or an empty list if
119   *          it is not included in the log message.
120   */
121  @NotNull()
122  List<String> getReferralURLs();
123
124
125
126  /**
127   * Retrieves the length of time in milliseconds required to process the
128   * operation.
129   *
130   * @return  The length of time in milliseconds required to process the
131   *          operation, or {@code null} if it is not included in the log
132   *          message.
133   */
134  @Nullable()
135  Double getProcessingTimeMillis();
136
137
138
139  /**
140   * Retrieves the length of time in milliseconds the operation was required to
141   * wait on the work queue.
142   *
143   * @return  The length of time in milliseconds the operation was required to
144   *          wait on the work queue, or {@code null} if it is not included in
145   *          the log message.
146   */
147  @Nullable()
148  Double getQueueTimeMillis();
149}