001/*
002 * Copyright 2015-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2015-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) 2015-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;
037
038
039
040import com.unboundid.asn1.ASN1OctetString;
041import com.unboundid.util.NotExtensible;
042import com.unboundid.util.NotMutable;
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 defines an exception that can be thrown if the server sends a bind
052 * response with a result code other than {@link ResultCode#SUCCESS}, which
053 * indicates that the bind operation did not complete successfully.  This may be
054 * used to obtain access to any server SASL credentials contained in the
055 * non-successful bind result.
056 */
057@NotExtensible()
058@NotMutable()
059@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
060public class LDAPBindException
061       extends LDAPException
062{
063  /**
064   * The serial version UID for this serializable class.
065   */
066  private static final long serialVersionUID = 6545956074186731236L;
067
068
069
070  // The bind result for this exception.
071  @NotNull private final BindResult bindResult;
072
073
074
075  /**
076   * Creates a new LDAP bind exception from the provided bind result.
077   *
078   * @param  bindResult  The bind result to use to create this exception.
079   */
080  public LDAPBindException(@NotNull final BindResult bindResult)
081  {
082    super(bindResult);
083
084    this.bindResult = bindResult;
085  }
086
087
088
089  /**
090   * {@inheritDoc}
091   */
092  @Override()
093  @NotNull()
094  public LDAPResult toLDAPResult()
095  {
096    return bindResult;
097  }
098
099
100
101  /**
102   * Retrieves the bind result that was returned by the server.
103   *
104   * @return  The bind result that was returned by the server.
105   */
106  @NotNull()
107  public BindResult getBindResult()
108  {
109    return bindResult;
110  }
111
112
113
114  /**
115   * Retrieves the server SASL credentials included in the bind result, if any.
116   *
117   * @return  The server SASL credentials included in the bind result, or
118   *          {@code null} if the bind result did not include any server SASL
119   *          credentials.
120   */
121  @Nullable()
122  public ASN1OctetString getServerSASLCredentials()
123  {
124    return bindResult.getServerSASLCredentials();
125  }
126}