001/*
002 * Copyright 2011-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2011-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) 2011-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;
037
038
039
040import java.util.List;
041
042import com.unboundid.util.NotExtensible;
043import com.unboundid.util.NotNull;
044import com.unboundid.util.Nullable;
045import com.unboundid.util.ThreadSafety;
046import com.unboundid.util.ThreadSafetyLevel;
047
048
049
050/**
051 * This interface defines a number of methods common to all types of operation
052 * result access log messages.
053 * <BR>
054 * <BLOCKQUOTE>
055 *   <B>NOTE:</B>  This class, and other classes within the
056 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
057 *   supported for use against Ping Identity, UnboundID, and
058 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
059 *   for proprietary functionality or for external specifications that are not
060 *   considered stable or mature enough to be guaranteed to work in an
061 *   interoperable way with other types of LDAP servers.
062 * </BLOCKQUOTE>
063 */
064@NotExtensible()
065@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
066public interface OperationResultAccessLogMessage
067       extends MinimalOperationResultAccessLogMessage
068{
069  /**
070   * Retrieves the number of intermediate response messages returned in the
071   * course of processing the operation.
072   *
073   * @return  The number of intermediate response messages returned to the
074   *          client in the course of processing the operation, or {@code null}
075   *          if it is not included in the log message.
076   */
077  @Nullable()
078  Long getIntermediateResponsesReturned();
079
080
081
082  /**
083   * Retrieves the OIDs of any response controls contained in the log message.
084   *
085   * @return  The OIDs of any response controls contained in the log message, or
086   *          an empty list if it is not included in the log message.
087   */
088  @NotNull()
089  List<String> getResponseControlOIDs();
090
091
092
093  /**
094   * Retrieves a list of the additional servers that were accessed in the course
095   * of processing the operation.  For example, if the access log message is
096   * from a Directory Proxy Server instance, then this may contain a list of the
097   * backend servers used to process the operation.
098   *
099   * @return  A list of the additional servers that were accessed in the course
100   *          of processing the operation, or an empty list if it is not
101   *          included in the log message.
102   */
103  @NotNull()
104  List<String> getServersAccessed();
105
106
107
108  /**
109   * Retrieves the content of the intermediate client result for the
110   * operation.
111   *
112   * @return  The content of the intermediate client result for the operation,
113   *          or {@code null} if it is not included in the log message.
114   */
115  @Nullable()
116  String getIntermediateClientResult();
117}