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 com.unboundid.util.NotExtensible;
041import com.unboundid.util.Nullable;
042import com.unboundid.util.ThreadSafety;
043import com.unboundid.util.ThreadSafetyLevel;
044
045
046
047/**
048 * This class provides a data structure that holds information about a bind
049 * operation result access log message.
050 * <BR>
051 * <BLOCKQUOTE>
052 *   <B>NOTE:</B>  This class, and other classes within the
053 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
054 *   supported for use against Ping Identity, UnboundID, and
055 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
056 *   for proprietary functionality or for external specifications that are not
057 *   considered stable or mature enough to be guaranteed to work in an
058 *   interoperable way with other types of LDAP servers.
059 * </BLOCKQUOTE>
060 */
061@NotExtensible()
062@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
063public interface BindResultAccessLogMessage
064       extends OperationResultAccessLogMessage,
065               BindForwardAccessLogMessage
066{
067  /**
068   * Retrieves the DN of the user authenticated by the bind operation.
069   *
070   * @return  The DN of the user authenticated by the bind operation, or
071   *          {@code null} if it is not included in the log message.
072   */
073  @Nullable()
074  String getAuthenticationDN();
075
076
077
078  /**
079   * Retrieves the DN of the alternate authorization identity for the bind
080   * operation.
081   *
082   * @return  The DN of the alternate authorization identity for the bind
083   *          operation, or {@code null} if it is not included in the log
084   *          message.
085   */
086  @Nullable()
087  String getAuthorizationDN();
088
089
090
091  /**
092   * Retrieves the numeric identifier for the authentication failure reason.
093   *
094   * @return  The numeric identifier for the authentication failure reason, or
095   *          {@code null} if it is not included in the log message.
096   */
097  @Nullable()
098  Long getAuthenticationFailureID();
099
100
101
102  /**
103   * Retrieves the name for the authentication failure reason.
104   *
105   * @return  The name for the authentication failure reason, or {@code null} if
106   *          it is not included in the log message.
107   */
108  @Nullable()
109  String getAuthenticationFailureName();
110
111
112
113  /**
114   * Retrieves a message with information about the reason that the
115   * authentication attempt failed.
116   *
117   * @return  A message with information about the reason that the
118   *          authentication attempt failed, or {@code null} if it is not
119   *          included in the log message.
120   */
121  @Nullable()
122  String getAuthenticationFailureMessage();
123
124
125
126  /**
127   * Indicates whether a retired password was used in the course of processing
128   * the bind.
129   *
130   * @return  {@code true} if a retired password was used in the course of
131   *          processing the bind, {@code false} if a retired password was not
132   *          used in the course of processing the bind, or {@code null} if
133   *          this was not included in the log message (and a retired password
134   *          was likely not used in the course of processing the operation).
135   */
136  @Nullable()
137  Boolean getRetiredPasswordUsed();
138
139
140
141  /**
142   * Retrieves the name of the client connection policy that was selected for
143   * the client connection.
144   *
145   * @return  The name of the client connection policy that was selected for the
146   *          client connection, or {@code null} if it is not included in the
147   *          log message.
148   */
149  @Nullable()
150  String getClientConnectionPolicy();
151}