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.NotMutable; 041import com.unboundid.util.ThreadSafety; 042import com.unboundid.util.ThreadSafetyLevel; 043 044 045 046/** 047 * This class defines an exception that may be thrown if a search result 048 * reference is received from the directory server while using the 049 * {@link EntrySource} API (e.g., an {@link LDAPEntrySource} object). 050 */ 051@NotMutable() 052@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 053public final class SearchResultReferenceEntrySourceException 054 extends EntrySourceException 055{ 056 /** 057 * The serial version UID for this serializable class. 058 */ 059 private static final long serialVersionUID = 4389660042011914324L; 060 061 062 063 // The search result reference returned from the server. 064 private final SearchResultReference searchReference; 065 066 067 068 /** 069 * Creates a new search result reference entry source exception with the 070 * provided search result reference. 071 * 072 * @param searchReference The search result reference returned by the 073 * directory server. It must not be {@code null}. 074 */ 075 public SearchResultReferenceEntrySourceException( 076 final SearchResultReference searchReference) 077 { 078 super(true, new LDAPException(ResultCode.REFERRAL, null, null, 079 searchReference.getReferralURLs(), searchReference.getControls(), 080 null)); 081 082 this.searchReference = searchReference; 083 } 084 085 086 087 /** 088 * Retrieves the search result reference for this entry source exception. 089 * 090 * @return The search result reference for this entry source exception. 091 */ 092 public SearchResultReference getSearchReference() 093 { 094 return searchReference; 095 } 096 097 098 099 /** 100 * {@inheritDoc} 101 */ 102 @Override() 103 public void toString(final StringBuilder buffer) 104 { 105 buffer.append("SearchResultReferenceEntrySourceException(searchReference="); 106 searchReference.toString(buffer); 107 buffer.append("')"); 108 } 109}