001/* 002 * Copyright 2012-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2012-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) 2012-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.NotMutable; 042import com.unboundid.util.ThreadSafety; 043import com.unboundid.util.ThreadSafetyLevel; 044 045 046 047/** 048 * This class defines an exception that can be thrown if the server sends a bind 049 * response with a result code of {@link ResultCode#SASL_BIND_IN_PROGRESS}, 050 * which indicates that SASL bind processing has not yet completed. This is not 051 * an error, but neither does it indicate that bind processing has completed. 052 * This exception provides access to the bind result and the server SASL 053 * credentials that it may optionally contain so that this information may be 054 * used to continue bind processing. 055 */ 056@NotMutable() 057@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 058public final class SASLBindInProgressException 059 extends LDAPBindException 060{ 061 /** 062 * The serial version UID for this serializable class. 063 */ 064 private static final long serialVersionUID = -2483660992461709721L; 065 066 067 068 /** 069 * Creates a new SASL bind in progress exception from the provided bind 070 * result. 071 * 072 * @param bindResult The bind result to use to create this exception. 073 */ 074 SASLBindInProgressException(final BindResult bindResult) 075 { 076 super(bindResult); 077 } 078 079 080 081 /** 082 * {@inheritDoc} 083 */ 084 @Override() 085 public BindResult getBindResult() 086 { 087 return super.getBindResult(); 088 } 089 090 091 092 /** 093 * {@inheritDoc} 094 */ 095 @Override() 096 public ASN1OctetString getServerSASLCredentials() 097 { 098 return super.getServerSASLCredentials(); 099 } 100}