001/* 002 * Copyright 2011-2019 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright (C) 2015-2019 Ping Identity Corporation 007 * 008 * This program is free software; you can redistribute it and/or modify 009 * it under the terms of the GNU General Public License (GPLv2 only) 010 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only) 011 * as published by the Free Software Foundation. 012 * 013 * This program is distributed in the hope that it will be useful, 014 * but WITHOUT ANY WARRANTY; without even the implied warranty of 015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 016 * GNU General Public License for more details. 017 * 018 * You should have received a copy of the GNU General Public License 019 * along with this program; if not, see <http://www.gnu.org/licenses>. 020 */ 021package com.unboundid.ldap.sdk.unboundidds.logs; 022 023 024 025import java.util.List; 026 027import com.unboundid.ldap.sdk.ResultCode; 028import com.unboundid.util.NotExtensible; 029import com.unboundid.util.ThreadSafety; 030import com.unboundid.util.ThreadSafetyLevel; 031 032 033 034/** 035 * This interface defines a number of methods common to all types of operation 036 * result access log messages. 037 * <BR> 038 * <BLOCKQUOTE> 039 * <B>NOTE:</B> This class, and other classes within the 040 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 041 * supported for use against Ping Identity, UnboundID, and 042 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 043 * for proprietary functionality or for external specifications that are not 044 * considered stable or mature enough to be guaranteed to work in an 045 * interoperable way with other types of LDAP servers. 046 * </BLOCKQUOTE> 047 */ 048@NotExtensible() 049@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE) 050public interface MinimalOperationResultAccessLogMessage 051{ 052 /** 053 * Retrieves the result code for the operation. 054 * 055 * @return The result code for the operation, or {@code null} if it is not 056 * included in the log message. 057 */ 058 ResultCode getResultCode(); 059 060 061 062 /** 063 * Retrieves the diagnostic message for the operation. 064 * 065 * @return The diagnostic message for the operation, or {@code null} if it is 066 * not included in the log message. 067 */ 068 String getDiagnosticMessage(); 069 070 071 072 /** 073 * Retrieves a message with additional information about the result of the 074 * operation. 075 * 076 * @return A message with additional information about the result of the 077 * operation, or {@code null} if it is not included in the log 078 * message. 079 */ 080 String getAdditionalInformation(); 081 082 083 084 /** 085 * Retrieves the matched DN for the operation. 086 * 087 * @return The matched DN for the operation, or {@code null} if it is not 088 * included in the log message. 089 */ 090 String getMatchedDN(); 091 092 093 094 /** 095 * Retrieves the list of referral URLs for the operation. 096 * 097 * @return The list of referral URLs for the operation, or an empty list if 098 * it is not included in the log message. 099 */ 100 List<String> getReferralURLs(); 101 102 103 104 /** 105 * Retrieves the length of time in milliseconds required to process the 106 * operation. 107 * 108 * @return The length of time in milliseconds required to process the 109 * operation, or {@code null} if it is not included in the log 110 * message. 111 */ 112 Double getProcessingTimeMillis(); 113 114 115 116 /** 117 * Retrieves the length of time in milliseconds the operation was required to 118 * wait on the work queue. 119 * 120 * @return The length of time in milliseconds the operation was required to 121 * wait on the work queue, or {@code null} if it is not included in 122 * the log message. 123 */ 124 Double getQueueTimeMillis(); 125}