001/*
002 * Copyright 2009-2023 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-2023 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) 2009-2023 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.util.LDAPSDKException;
041import com.unboundid.util.NotExtensible;
042import com.unboundid.util.NotMutable;
043import com.unboundid.util.NotNull;
044import com.unboundid.util.Nullable;
045import com.unboundid.util.StaticUtils;
046import com.unboundid.util.ThreadSafety;
047import com.unboundid.util.ThreadSafetyLevel;
048import com.unboundid.util.Validator;
049
050
051
052/**
053 * This class defines an exception that may be thrown if a problem occurs while
054 * trying to access an entry in an entry source (e.g., because the entry source
055 * is no longer available, because an entry could not be parsed, or because the
056 * next element returned was a search result reference rather than a search
057 * result entry).
058 */
059@NotExtensible()
060@NotMutable()
061@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
062public class EntrySourceException
063       extends LDAPSDKException
064{
065  /**
066   * The serial version UID for this serializable class.
067   */
068  private static final long serialVersionUID = -9221149707074845318L;
069
070
071
072  // Indicates whether it is possible to continue attempting to iterate through
073  // subsequent entries.
074  private final boolean mayContinueReading;
075
076
077
078  /**
079   * Creates a new entry source exception with the provided information.
080   *
081   * @param  mayContinueReading  Indicates whether it is possible to continue
082   *                             attempting to iterate through subsequent
083   *                             entries in the entry source.
084   * @param  cause               The underlying exception that triggered this
085   *                             exception.  It must not be {@code null}.
086   */
087  public EntrySourceException(final boolean mayContinueReading,
088                              @Nullable final Throwable cause)
089  {
090    super(StaticUtils.getExceptionMessage(cause), cause);
091
092    Validator.ensureNotNull(cause);
093
094    this.mayContinueReading = mayContinueReading;
095  }
096
097
098
099  /**
100   * Creates a new entry source exception with the provided information.
101   *
102   * @param  mayContinueReading  Indicates whether it is possible to continue
103   *                             attempting to iterate through subsequent
104   *                             entries in the entry source.
105   * @param  message             A message explaining the problem that occurred.
106   *                             It must not be {@code null}.
107   * @param  cause               The underlying exception that triggered this
108   *                             exception.  It must not be {@code null}.
109   */
110  public EntrySourceException(final boolean mayContinueReading,
111                              @NotNull final String message,
112                              @Nullable final Throwable cause)
113  {
114    super(message, cause);
115
116    Validator.ensureNotNull(message, cause);
117
118    this.mayContinueReading = mayContinueReading;
119  }
120
121
122
123  /**
124   * Indicates whether it is possible to continue attempting to iterate through
125   * subsequent entries in the entry source.
126   *
127   * @return  {@code true} if it is possible to continue attempting to read from
128   *          the entry source, or {@code false} if it is not possible to
129   *          continue.
130   */
131  public final boolean mayContinueReading()
132  {
133    return mayContinueReading;
134  }
135
136
137
138  /**
139   * {@inheritDoc}
140   */
141  @Override()
142  public void toString(@NotNull final StringBuilder buffer)
143  {
144    buffer.append("EntrySourceException(message='");
145    buffer.append(getMessage());
146    buffer.append("', mayContinueReading=");
147    buffer.append(mayContinueReading);
148    buffer.append(", cause='");
149    buffer.append(StaticUtils.getExceptionMessage(getCause()));
150    buffer.append("')");
151  }
152}