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