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