Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2007-2023 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2007-2023 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2007-2023 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.util.Debug;
import com.unboundid.util.LDAPSDKException;
import com.unboundid.util.NotExtensible;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* This class defines an exception that can be thrown if a problem occurs while
* performing LDAP-related processing. An LDAP exception can include all of
* the elements of an {@link LDAPResult}, so that all of the response elements
* will be available.
*/
@NotExtensible()
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public class LDAPException
extends LDAPSDKException
{
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -4257171063946350327L;
/**
* An empty array that will be used when no controls were provided.
*/
@NotNull protected static final Control[] NO_CONTROLS =
StaticUtils.NO_CONTROLS;
/**
* An empty array that will be used when no referrals were provided.
*/
@NotNull protected static final String[] NO_REFERRALS =
StaticUtils.NO_STRINGS;
// The set of response controls for this LDAP exception.
@NotNull private final Control[] responseControls;
// The result code for this LDAP exception.
@NotNull private final ResultCode resultCode;
// The set of referral URLs for this LDAP exception.
@NotNull private final String[] referralURLs;
// The diagnostic message returned by the directory server.
@Nullable private final String diagnosticMessage;
// The matched DN for this LDAP exception.
@Nullable private final String matchedDN;
/**
* Creates a new LDAP exception with the provided result code. A default
* message (based on the result code) will be used.
*
* @param resultCode The result code for this LDAP exception.
*/
public LDAPException(@NotNull final ResultCode resultCode)
{
super(resultCode.getName());
this.resultCode = resultCode;
matchedDN = null;
diagnosticMessage = null;
referralURLs = NO_REFERRALS;
responseControls = NO_CONTROLS;
}
/**
* Creates a new LDAP exception with the provided result code. A default
* message (based on the result code) will be used.
*
* @param resultCode The result code for this LDAP exception.
* @param cause The underlying exception that triggered this exception.
*/
public LDAPException(@NotNull final ResultCode resultCode,
@Nullable final Throwable cause)
{
super(resultCode.getName(), cause);
this.resultCode = resultCode;
matchedDN = null;
diagnosticMessage = null;
referralURLs = NO_REFERRALS;
responseControls = NO_CONTROLS;
}
/**
* Creates a new LDAP exception with the provided result code and message.
*
* @param resultCode The result code for this LDAP exception.
* @param errorMessage The error message for this LDAP exception.
*/
public LDAPException(@NotNull final ResultCode resultCode,
@NotNull final String errorMessage)
{
super(errorMessage);
this.resultCode = resultCode;
matchedDN = null;
diagnosticMessage = null;
referralURLs = NO_REFERRALS;
responseControls = NO_CONTROLS;
}
/**
* Creates a new LDAP exception with the provided result code and message.
*
* @param resultCode The result code for this LDAP exception.
* @param errorMessage The error message for this LDAP exception.
* @param cause The underlying exception that triggered this
* exception.
*/
public LDAPException(@NotNull final ResultCode resultCode,
@NotNull final String errorMessage,
@Nullable final Throwable cause)
{
super(errorMessage, cause);
this.resultCode = resultCode;
matchedDN = null;
diagnosticMessage = null;
referralURLs = NO_REFERRALS;
responseControls = NO_CONTROLS;
}
/**
* Creates a new LDAP exception with the provided information.
*
* @param resultCode The result code for this LDAP exception.
* @param errorMessage The error message for this LDAP exception.
* @param matchedDN The matched DN for this LDAP exception.
* @param referralURLs The set of referral URLs for this LDAP exception.
*/
public LDAPException(@NotNull final ResultCode resultCode,
@NotNull final String errorMessage,
@Nullable final String matchedDN,
@Nullable final String[] referralURLs)
{
super(errorMessage);
this.resultCode = resultCode;
this.matchedDN = matchedDN;
if (referralURLs == null)
{
this.referralURLs = NO_REFERRALS;
}
else
{
this.referralURLs = referralURLs;
}
diagnosticMessage = null;
responseControls = NO_CONTROLS;
}
/**
* Creates a new LDAP exception with the provided information.
*
* @param resultCode The result code for this LDAP exception.
* @param errorMessage The error message for this LDAP exception.
* @param matchedDN The matched DN for this LDAP exception.
* @param referralURLs The set of referral URLs for this LDAP exception.
* @param cause The underlying exception that triggered this
* exception.
*/
public LDAPException(@NotNull final ResultCode resultCode,
@NotNull final String errorMessage,
@Nullable final String matchedDN,
@Nullable final String[] referralURLs,
@Nullable final Throwable cause)
{
super(errorMessage, cause);
this.resultCode = resultCode;
this.matchedDN = matchedDN;
if (referralURLs == null)
{
this.referralURLs = NO_REFERRALS;
}
else
{
this.referralURLs = referralURLs;
}
diagnosticMessage = null;
responseControls = NO_CONTROLS;
}
/**
* Creates a new LDAP exception with the provided information.
*
* @param resultCode The result code for this LDAP exception.
* @param errorMessage The error message for this LDAP exception.
* @param matchedDN The matched DN for this LDAP exception.
* @param referralURLs The set of referral URLs for this LDAP exception.
* @param controls The set of response controls for this LDAP exception.
*/
public LDAPException(@NotNull final ResultCode resultCode,
@NotNull final String errorMessage,
@Nullable final String matchedDN,
@Nullable final String[] referralURLs,
@Nullable final Control[] controls)
{
super(errorMessage);
this.resultCode = resultCode;
this.matchedDN = matchedDN;
diagnosticMessage = null;
if (referralURLs == null)
{
this.referralURLs = NO_REFERRALS;
}
else
{
this.referralURLs = referralURLs;
}
if (controls == null)
{
responseControls = NO_CONTROLS;
}
else
{
responseControls = controls;
}
}
/**
* Creates a new LDAP exception with the provided information.
*
* @param resultCode The result code for this LDAP exception.
* @param errorMessage The error message for this LDAP exception.
* @param matchedDN The matched DN for this LDAP exception.
* @param referralURLs The set of referral URLs for this LDAP exception.
* @param controls The set of response controls for this LDAP exception.
* @param cause The underlying exception that triggered this
* exception.
*/
public LDAPException(@NotNull final ResultCode resultCode,
@NotNull final String errorMessage,
@Nullable final String matchedDN,
@Nullable final String[] referralURLs,
@Nullable final Control[] controls,
@Nullable final Throwable cause)
{
super(errorMessage, cause);
this.resultCode = resultCode;
this.matchedDN = matchedDN;
diagnosticMessage = null;
if (referralURLs == null)
{
this.referralURLs = NO_REFERRALS;
}
else
{
this.referralURLs = referralURLs;
}
if (controls == null)
{
responseControls = NO_CONTROLS;
}
else
{
responseControls = controls;
}
}
/**
* Creates a new LDAP exception using the information contained in the
* provided LDAP result object.
*
* @param ldapResult The LDAP result object containing the information to
* use for this LDAP exception.
*/
public LDAPException(@NotNull final LDAPResult ldapResult)
{
super((ldapResult.getDiagnosticMessage() == null)
? ldapResult.getResultCode().getName()
: ldapResult.getDiagnosticMessage());
resultCode = ldapResult.getResultCode();
matchedDN = ldapResult.getMatchedDN();
diagnosticMessage = ldapResult.getDiagnosticMessage();
referralURLs = ldapResult.getReferralURLs();
responseControls = ldapResult.getResponseControls();
}
/**
* Creates a new LDAP exception using the information contained in the
* provided LDAP result object.
*
* @param ldapResult The LDAP result object containing the information to
* use for this LDAP exception.
* @param cause The underlying exception that triggered this exception.
*/
public LDAPException(@NotNull final LDAPResult ldapResult,
@Nullable final Throwable cause)
{
super(((ldapResult.getDiagnosticMessage() == null)
? ldapResult.getResultCode().getName()
: ldapResult.getDiagnosticMessage()),
cause);
resultCode = ldapResult.getResultCode();
matchedDN = ldapResult.getMatchedDN();
diagnosticMessage = ldapResult.getDiagnosticMessage();
referralURLs = ldapResult.getReferralURLs();
responseControls = ldapResult.getResponseControls();
}
/**
* Creates a new LDAP exception using the information contained in the
* provided LDAP exception.
*
* @param e The LDAP exception to use to create this exception.
*/
public LDAPException(@NotNull final LDAPException e)
{
super(e.getMessage(), e.getCause());
resultCode = e.getResultCode();
matchedDN = e.getMatchedDN();
diagnosticMessage = e.getDiagnosticMessage();
referralURLs = e.getReferralURLs();
responseControls = e.getResponseControls();
}
/**
* Retrieves the result code for this LDAP exception.
*
* @return The result code for this LDAP exception.
*/
@NotNull()
public final ResultCode getResultCode()
{
return resultCode;
}
/**
* Retrieves the matched DN for this LDAP exception.
*
* @return The matched DN for this LDAP exception, or {@code null} if there
* is none.
*/
@Nullable()
public final String getMatchedDN()
{
return matchedDN;
}
/**
* Retrieves the diagnostic message returned by the directory server.
*
* @return The diagnostic message returned by the directory server, or
* {@code null} if there is none.
*/
@Nullable()
public final String getDiagnosticMessage()
{
return diagnosticMessage;
}
/**
* Retrieves the set of referral URLs for this LDAP exception.
*
* @return The set of referral URLs for this LDAP exception, or an empty
* array if there are none.
*/
@NotNull()
public final String[] getReferralURLs()
{
return referralURLs;
}
/**
* Indicates whether this result contains at least one control.
*
* @return {@code true} if this result contains at least one control, or
* {@code false} if not.
*/
public final boolean hasResponseControl()
{
return (responseControls.length > 0);
}
/**
* Indicates whether this result contains at least one control with the
* specified OID.
*
* @param oid The object identifier for which to make the determination. It
* must not be {@code null}.
*
* @return {@code true} if this result contains at least one control with
* the specified OID, or {@code false} if not.
*/
public final boolean hasResponseControl(@NotNull final String oid)
{
for (final Control c : responseControls)
{
if (c.getOID().equals(oid))
{
return true;
}
}
return false;
}
/**
* Retrieves the set of response controls for this LDAP exception.
* Individual response controls of a specific type may be retrieved and
* decoded using the {@code get} method in the response control class, using
* the {@link #toLDAPResult()} method to convert this exception to an
* {@link LDAPResult}.
*
* @return The set of response controls for this LDAP exception, or an empty
* array if there are none.
*/
@NotNull()
public final Control[] getResponseControls()
{
return responseControls;
}
/**
* Retrieves the response control with the specified OID.
*
* @param oid The OID of the control to retrieve.
*
* @return The response control with the specified OID, or {@code null} if
* there is no such control.
*/
@Nullable()
public final Control getResponseControl(@NotNull final String oid)
{
for (final Control c : responseControls)
{
if (c.getOID().equals(oid))
{
return c;
}
}
return null;
}
/**
* Creates a new {@code LDAPResult} object from this exception.
*
* @return The {@code LDAPResult} object created from this exception.
*/
@NotNull()
public LDAPResult toLDAPResult()
{
if ((diagnosticMessage == null) && (getMessage() != null))
{
return new LDAPResult(-1, resultCode, getMessage(), matchedDN,
referralURLs, responseControls);
}
else
{
return new LDAPResult(-1, resultCode, diagnosticMessage, matchedDN,
referralURLs, responseControls);
}
}
/**
* Retrieves a string representation of this LDAP result, consisting of
* the result code, diagnostic message (if present), matched DN (if present),
* and referral URLs (if present).
*
* @return A string representation of this LDAP result.
*/
@NotNull()
public String getResultString()
{
final StringBuilder buffer = new StringBuilder();
buffer.append("result code='");
buffer.append(resultCode);
buffer.append('\'');
if ((diagnosticMessage != null) && (! diagnosticMessage.isEmpty()))
{
buffer.append(" diagnostic message='");
buffer.append(diagnosticMessage);
buffer.append('\'');
}
if ((matchedDN != null) && (! matchedDN.isEmpty()))
{
buffer.append(" matched DN='");
buffer.append(matchedDN);
buffer.append('\'');
}
if ((referralURLs != null) && (referralURLs.length > 0))
{
buffer.append(" referral URLs={");
for (int i=0; i < referralURLs.length; i++)
{
if (i > 0)
{
buffer.append(", ");
}
buffer.append('\'');
buffer.append(referralURLs[i]);
buffer.append('\'');
}
buffer.append('}');
}
return buffer.toString();
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
final boolean includeCause =
Boolean.getBoolean(Debug.PROPERTY_INCLUDE_CAUSE_IN_EXCEPTION_MESSAGES);
final boolean includeStackTrace = Boolean.getBoolean(
Debug.PROPERTY_INCLUDE_STACK_TRACE_IN_EXCEPTION_MESSAGES);
toString(buffer, includeCause, includeStackTrace);
}
/**
* Appends a string representation of this {@code LDAPException} to the
* provided buffer.
*
* @param buffer The buffer to which the information should be
* appended. This must not be {@code null}.
* @param includeCause Indicates whether to include information about
* the cause (if any) in the exception message.
* @param includeStackTrace Indicates whether to include a condensed
* representation of the stack trace in the
* exception message. If a stack trace is
* included, then the cause (if any) will
* automatically be included, regardless of the
* value of the {@code includeCause} argument.
*/
public void toString(@NotNull final StringBuilder buffer,
final boolean includeCause,
final boolean includeStackTrace)
{
buffer.append("LDAPException(resultCode=");
buffer.append(resultCode);
final String errorMessage = getMessage();
if ((errorMessage != null) && (! errorMessage.equals(diagnosticMessage)))
{
buffer.append(", errorMessage='");
buffer.append(errorMessage);
buffer.append('\'');
}
if (diagnosticMessage != null)
{
buffer.append(", diagnosticMessage='");
buffer.append(diagnosticMessage);
buffer.append('\'');
}
if (matchedDN != null)
{
buffer.append(", matchedDN='");
buffer.append(matchedDN);
buffer.append('\'');
}
if (referralURLs.length > 0)
{
buffer.append(", referralURLs={");
for (int i=0; i < referralURLs.length; i++)
{
if (i > 0)
{
buffer.append(", ");
}
buffer.append('\'');
buffer.append(referralURLs[i]);
buffer.append('\'');
}
buffer.append('}');
}
if (responseControls.length > 0)
{
buffer.append(", responseControls={");
for (int i=0; i < responseControls.length; i++)
{
if (i > 0)
{
buffer.append(", ");
}
buffer.append(responseControls[i]);
}
buffer.append('}');
}
if (includeStackTrace)
{
buffer.append(", trace='");
StaticUtils.getStackTrace(getStackTrace(), buffer);
buffer.append('\'');
}
if (includeCause || includeStackTrace)
{
final Throwable cause = getCause();
if (cause != null)
{
buffer.append(", cause=");
buffer.append(StaticUtils.getExceptionMessage(cause, true,
includeStackTrace));
}
}
final String ldapSDKVersionString = ", ldapSDKVersion=" +
Version.NUMERIC_VERSION_STRING + ", revision=" + Version.REVISION_ID;
if (buffer.indexOf(ldapSDKVersionString) < 0)
{
buffer.append(ldapSDKVersionString);
}
buffer.append(')');
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public final String getExceptionMessage()
{
return toString();
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public final String getExceptionMessage(final boolean includeCause,
final boolean includeStackTrace)
{
final StringBuilder buffer = new StringBuilder();
toString(buffer, includeCause, includeStackTrace);
return buffer.toString();
}
}
