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