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.migrate.ldapjdk; 037 038 039 040import com.unboundid.ldap.sdk.SearchResultReference; 041import com.unboundid.util.NotExtensible; 042import com.unboundid.util.NotMutable; 043import com.unboundid.util.ThreadSafety; 044import com.unboundid.util.ThreadSafetyLevel; 045 046 047 048/** 049 * This class provides an exception that may be returned if a referral is 050 * returned in response for an operation. 051 * <BR><BR> 052 * This class is primarily intended to be used in the process of updating 053 * applications which use the Netscape Directory SDK for Java to switch to or 054 * coexist with the UnboundID LDAP SDK for Java. For applications not written 055 * using the Netscape Directory SDK for Java, the 056 * {@link com.unboundid.ldap.sdk.LDAPException} class should be used instead. 057 */ 058@NotExtensible() 059@NotMutable() 060@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 061public class LDAPReferralException 062 extends LDAPException 063{ 064 /** 065 * The serial version UID for this serializable class. 066 */ 067 private static final long serialVersionUID = 7867903105944011998L; 068 069 070 071 // The referral URLs for this exception. 072 private final String[] referralURLs; 073 074 075 076 /** 077 * Creates a new LDAP referral exception with no information. 078 */ 079 public LDAPReferralException() 080 { 081 super(null, REFERRAL); 082 083 referralURLs = new String[0]; 084 } 085 086 087 088 /** 089 * Creates a new LDAP referral exception with the provided information. 090 * 091 * @param message The message for this LDAP referral exception. 092 * @param resultCode The result code for this LDAP referral 093 * exception. 094 * @param serverErrorMessage The error message returned from the server. 095 */ 096 public LDAPReferralException(final String message, final int resultCode, 097 final String serverErrorMessage) 098 { 099 super(message, resultCode, serverErrorMessage, null); 100 101 referralURLs = new String[0]; 102 } 103 104 105 106 /** 107 * Creates a new LDAP referral exception with the provided information. 108 * 109 * @param message The message for this LDAP referral exception. 110 * @param resultCode The result code for this LDAP referral exception. 111 * @param referrals The set of referrals for this exception. 112 */ 113 public LDAPReferralException(final String message, final int resultCode, 114 final String[] referrals) 115 { 116 super(message, resultCode, null, null); 117 118 referralURLs = referrals; 119 } 120 121 122 123 /** 124 * Creates a new LDAP referral exception from the provided 125 * {@link com.unboundid.ldap.sdk.LDAPException} object. 126 * 127 * @param ldapException The {@code LDAPException} object to use for this 128 * LDAP interrupted exception. 129 */ 130 public LDAPReferralException( 131 final com.unboundid.ldap.sdk.LDAPException ldapException) 132 { 133 super(ldapException); 134 135 referralURLs = ldapException.getReferralURLs(); 136 } 137 138 139 140 /** 141 * Creates a new LDAP referral exception from the provided 142 * {@link SearchResultReference} object. 143 * 144 * @param reference The {@code SearchResultReference} object to use to 145 * create this exception. 146 */ 147 public LDAPReferralException(final SearchResultReference reference) 148 { 149 super(null, REFERRAL); 150 151 referralURLs = reference.getReferralURLs(); 152 } 153 154 155 156 /** 157 * Retrieves the set of referral URLs for this exception. 158 * 159 * @return The set of referral URLs for this exception. 160 */ 161 public String[] getURLs() 162 { 163 return referralURLs; 164 } 165}