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