001/*
002 * Copyright 2022-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2022-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) 2022-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.v2;
037
038
039
040import java.util.Set;
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 class provides a data structure that holds information about a search
052 * operation result access log message.
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 SearchResultAccessLogMessage
067       extends OperationResultAccessLogMessage,
068               SearchForwardAccessLogMessage
069{
070  /**
071   * Retrieves the number of entries returned to the client.
072   *
073   * @return  The number of entries returned to the client, or {@code null} if
074   *          it is not included in the log message.
075   */
076  @Nullable()
077  Long getEntriesReturned();
078
079
080
081  /**
082   * Indicates whether the search was unindexed.
083   *
084   * @return  {@code Boolean.TRUE} if the search was unindexed,
085   *          {@code Boolean.FALSE} if it was not, or {@code null} if it is not
086   *          included in the log message.
087   */
088  @Nullable()
089  Boolean getUnindexed();
090
091
092
093  /**
094   * Retrieves the alternate authorization DN for the operation.
095   *
096   * @return  The alternate authorization DN for the operation, or {@code null}
097   *          if it is not included in the log message.
098   */
099  @Nullable()
100  String getAlternateAuthorizationDN();
101
102
103
104  /**
105   * Retrieves the names of any indexes for which one or more keys near
106   * (typically, within 80% of) the index entry limit were accessed while
107   * processing the operation.
108   *
109   * @return  The names of any indexes for which one or more keys near the index
110   *          entry limit were accessed while processing the operation, or an
111   *          empty list if no such index keys were accessed, or if this is not
112   *          included in the log message.
113   */
114  @NotNull()
115  Set<String> getIndexesWithKeysAccessedNearEntryLimit();
116
117
118
119  /**
120   * Retrieves the names of any indexes for which one or more keys over the
121   * index entry limit were accessed while processing the operation.
122   *
123   * @return  The names of any indexes for which one or more keys over the index
124   *          entry limit were accessed while processing the operation, or an
125   *          empty list if no such index keys were accessed, or if this is not
126   *          included in the log message.
127   */
128  @NotNull()
129  Set<String> getIndexesWithKeysAccessedExceedingEntryLimit();
130}