001/*
002 * Copyright 2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 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) 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.v2;
037
038
039
040import java.util.List;
041
042import com.unboundid.ldap.sdk.DereferencePolicy;
043import com.unboundid.ldap.sdk.SearchScope;
044import com.unboundid.util.NotExtensible;
045import com.unboundid.util.NotNull;
046import com.unboundid.util.Nullable;
047import com.unboundid.util.ThreadSafety;
048import com.unboundid.util.ThreadSafetyLevel;
049
050
051
052/**
053 * This class provides a data structure that holds information about a search
054 * request access log message.
055 * <BR>
056 * <BLOCKQUOTE>
057 *   <B>NOTE:</B>  This class, and other classes within the
058 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
059 *   supported for use against Ping Identity, UnboundID, and
060 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
061 *   for proprietary functionality or for external specifications that are not
062 *   considered stable or mature enough to be guaranteed to work in an
063 *   interoperable way with other types of LDAP servers.
064 * </BLOCKQUOTE>
065 */
066@NotExtensible()
067@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
068public interface SearchRequestAccessLogMessage
069       extends OperationRequestAccessLogMessage
070{
071  /**
072   * Retrieves the base DN for the search request.
073   *
074   * @return  The base DN for the search request, or {@code null} if it is not
075   *          included in the log message.
076   */
077  @Nullable()
078  String getBaseDN();
079
080
081
082  /**
083   * Retrieves the scope for the search request.
084   *
085   * @return  The scope for the search request, or {@code null} if it is not
086   *          included in the log message.
087   */
088  @Nullable()
089  SearchScope getScope();
090
091
092
093  /**
094   * Retrieves a string representation of the filter for the search request.
095   *
096   * @return  A string representation of the filter for the search request, or
097   *          {@code null} if it is not included in the log message.
098   */
099  @Nullable()
100  String getFilter();
101
102
103
104  /**
105   * Retrieves the dereference policy for the search request.
106   *
107   * @return  The dereference policy for the search request, or {@code null} if
108   *          it is not included in the log message or the value cannot be
109   *          parsed as a valid {@code DereferencePolicy} value.
110   */
111  @Nullable()
112  DereferencePolicy getDereferencePolicy();
113
114
115
116  /**
117   * Retrieves the size limit for the search request.
118   *
119   * @return  The size limit for the search request, or {@code null} if it is
120   *          not included in the log message or the value cannot be parsed as
121   *          an integer.
122   */
123  @Nullable()
124  Integer getSizeLimit();
125
126
127
128  /**
129   * Retrieves the time limit for the search request, in seconds.
130   *
131   * @return  The time limit for the search request, or {@code null} if it is
132   *          not included in the log message or the value cannot be parsed as
133   *          an integer.
134   */
135  @Nullable()
136  Integer getTimeLimitSeconds();
137
138
139
140  /**
141   * Retrieves the typesOnly value for the search request.
142   *
143   * @return  {@code true} if only attribute type names should be included in
144   *          entries that are returned, {@code false} if both attribute types
145   *          and values should be returned, or {@code null} if is not included
146   *          in the log message or cannot be parsed as a Boolean.
147   */
148  @Nullable()
149  Boolean getTypesOnly();
150
151
152
153  /**
154   * Retrieves the list of requested attributes for the search request.
155   *
156   * @return  The list of requested attributes for the search request, an empty
157   *          list if the client did not explicitly request any attributes, or
158   *          {@code null} if it is not included in the log message.
159   */
160  @NotNull()
161  List<String> getRequestedAttributes();
162}