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