com.unboundid.ldap.sdk.migrate.ldapjdk
Class LDAPReferralException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.unboundid.ldap.sdk.migrate.ldapjdk.LDAPException
              extended by com.unboundid.ldap.sdk.migrate.ldapjdk.LDAPReferralException
All Implemented Interfaces:
java.io.Serializable

@NotExtensible
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public class LDAPReferralException
extends LDAPException

This class provides an exception that may be returned if a referral is returned in response for an operation.

This class is primarily intended to be used in the process of updating applications which use the Netscape Directory SDK for Java to switch to or coexist with the UnboundID LDAP SDK for Java. For applications not written using the Netscape Directory SDK for Java, the LDAPException class should be used instead.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.unboundid.ldap.sdk.migrate.ldapjdk.LDAPException
ADMIN_LIMIT_EXCEEDED, AFFECTS_MULTIPLE_DSAS, ALIAS_DEREFERENCING_PROBLEM, ALIAS_PROBLEM, ATTRIBUTE_OR_VALUE_EXISTS, AUTH_METHOD_NOT_SUPPORTED, BUSY, CLIENT_LOOP, COMPARE_FALSE, COMPARE_TRUE, CONFIDENTIALITY_REQUIRED, CONNECT_ERROR, CONSTRAINT_VIOLATION, CONTROL_NOT_FOUND, ENTRY_ALREADY_EXISTS, INAPPROPRIATE_AUTHENTICATION, INAPPROPRIATE_MATCHING, INDEX_RANGE_ERROR, INSUFFICIENT_ACCESS_RIGHTS, INVALID_ATTRIBUTE_SYNTAX, INVALID_CREDENTIALS, INVALID_DN_SYNTAX, IS_LEAF, LDAP_NOT_SUPPORTED, LDAP_PARTIAL_RESULTS, LDAP_TIMEOUT, LOOP_DETECTED, MORE_RESULTS_TO_RETURN, NAMING_VIOLATION, NO_RESULTS_RETURNED, NO_SUCH_ATTRIBUTE, NO_SUCH_OBJECT, NOT_ALLOWED_ON_NONLEAF, NOT_ALLOWED_ON_RDN, OBJECT_CLASS_MODS_PROHIBITED, OBJECT_CLASS_VIOLATION, OPERATION_ERROR, OTHER, PARAM_ERROR, PROTOCOL_ERROR, REFERRAL, REFERRAL_LIMIT_EXCEEDED, SASL_BIND_IN_PROGRESS, SERVER_DOWN, SIZE_LIMIT_EXCEEDED, SORT_CONTROL_MISSING, STRONG_AUTH_REQUIRED, SUCCESS, TIME_LIMIT_EXCEEDED, UNAVAILABLE, UNAVAILABLE_CRITICAL_EXTENSION, UNDEFINED_ATTRIBUTE_TYPE, UNWILLING_TO_PERFORM
 
Constructor Summary
LDAPReferralException()
          Creates a new LDAP referral exception with no information.
LDAPReferralException(LDAPException ldapException)
          Creates a new LDAP referral exception from the provided LDAPException object.
LDAPReferralException(SearchResultReference reference)
          Creates a new LDAP referral exception from the provided SearchResultReference object.
LDAPReferralException(java.lang.String message, int resultCode, java.lang.String serverErrorMessage)
          Creates a new LDAP referral exception with the provided information.
LDAPReferralException(java.lang.String message, int resultCode, java.lang.String[] referrals)
          Creates a new LDAP referral exception with the provided information.
 
Method Summary
 java.lang.String[] getURLs()
          Retrieves the set of referral URLs for this exception.
 
Methods inherited from class com.unboundid.ldap.sdk.migrate.ldapjdk.LDAPException
errorCodeToString, errorCodeToString, errorCodeToString, errorCodeToString, getLDAPErrorMessage, getLDAPResultCode, getMatchedDN, toLDAPException, toString
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LDAPReferralException

public LDAPReferralException()
Creates a new LDAP referral exception with no information.


LDAPReferralException

public LDAPReferralException(java.lang.String message,
                             int resultCode,
                             java.lang.String serverErrorMessage)
Creates a new LDAP referral exception with the provided information.

Parameters:
message - The message for this LDAP referral exception.
resultCode - The result code for this LDAP referral exception.
serverErrorMessage - The error message returned from the server.

LDAPReferralException

public LDAPReferralException(java.lang.String message,
                             int resultCode,
                             java.lang.String[] referrals)
Creates a new LDAP referral exception with the provided information.

Parameters:
message - The message for this LDAP referral exception.
resultCode - The result code for this LDAP referral exception.
referrals - The set of referrals for this exception.

LDAPReferralException

public LDAPReferralException(LDAPException ldapException)
Creates a new LDAP referral exception from the provided LDAPException object.

Parameters:
ldapException - The LDAPException object to use for this LDAP interrupted exception.

LDAPReferralException

public LDAPReferralException(SearchResultReference reference)
Creates a new LDAP referral exception from the provided SearchResultReference object.

Parameters:
reference - The SearchResultReference object to use to create this exception.
Method Detail

getURLs

public java.lang.String[] getURLs()
Retrieves the set of referral URLs for this exception.

Returns:
The set of referral URLs for this exception.