com.unboundid.ldap.sdk.SASLBindInProgressException Maven / Gradle / Ivy
/*
* Copyright 2012-2019 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright (C) 2012-2019 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.util.NotMutable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* This class defines an exception that can be thrown if the server sends a bind
* response with a result code of {@link ResultCode#SASL_BIND_IN_PROGRESS},
* which indicates that SASL bind processing has not yet completed. This is not
* an error, but neither does it indicate that bind processing has completed.
* This exception provides access to the bind result and the server SASL
* credentials that it may optionally contain so that this information may be
* used to continue bind processing.
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class SASLBindInProgressException
extends LDAPBindException
{
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -2483660992461709721L;
/**
* Creates a new SASL bind in progress exception from the provided bind
* result.
*
* @param bindResult The bind result to use to create this exception.
*/
SASLBindInProgressException(final BindResult bindResult)
{
super(bindResult);
}
/**
* {@inheritDoc}
*/
@Override()
public BindResult getBindResult()
{
return super.getBindResult();
}
/**
* {@inheritDoc}
*/
@Override()
public ASN1OctetString getServerSASLCredentials()
{
return super.getServerSASLCredentials();
}
}