LdapReferralException

Class Overview

This exception is raised when a referral to an alternative context is encountered.

An LdapReferralException object contains one or more referrals. Each referral is an alternative location for the same target entry. For example, a referral may be an LDAP URL. The referrals are attempted in sequence until one is successful or all have failed. In the case of the latter then the exception generated by the final referral is recorded and presented later.

A referral may be skipped or may be retried. For example, in the case of an authentication error, a referral may be retried with different environment properties.

An LdapReferralException object may also contain a reference to a chain of unprocessed LdapReferralException objects. Once the current set of referrals have been exhausted and unprocessed LdapReferralException objects remain, then the LdapReferralException object referenced by the current object is thrown and the cycle continues.

If new LdapReferralException objects are generated while following an existing referral then these new objects are appended to the end of the chain of unprocessed LdapReferralException objects.

If an exception was recorded while processing a chain of LdapReferralException objects then is is throw once processing has completed.

Summary

[Expand] Inherited Fields

From class javax.naming.NamingException protected Name remainingName Contains the remaining name that has not been resolved yet. protected Name resolvedName Contains the part of the name that has been successfully resolved. protected Object resolvedObj Contains the object to which resolution of the part of the name was successful. protected Throwable rootException Contains the original exception that caused this NamingException to be thrown.

[Expand] Inherited Methods
From class javax.naming.ldap.LdapReferralException abstract Context getReferralContext(Hashtable<?, ?> env) Retrieves the context at which to continue the method using environment properties and no controls. abstract Context getReferralContext() Retrieves the context at which to continue the method using the context's environment and no controls. abstract Context getReferralContext(Hashtable<?, ?> env, Control[] reqCtls) Retrieves the context at which to continue the method using request controls and environment properties.
From class javax.naming.ReferralException abstract Context getReferralContext(Hashtable<?, ?> env) Retrieves the context at which to continue the method using environment properties. abstract Context getReferralContext() Retrieves the context at which to continue the method. abstract Object getReferralInfo() Retrieves information (such as URLs) related to this referral. abstract void retryReferral() Retries the referral currently being processed. abstract boolean skipReferral() Discards the referral about to be processed.
From class javax.naming.NamingException void appendRemainingComponent(String name) Add name as the last component in remaining name. void appendRemainingName(Name name) Add components from 'name' as the last components in remaining name. Throwable getCause() Returns the cause of this exception. String getExplanation() Retrieves the explanation associated with this exception. Name getRemainingName() Retrieves the remaining unresolved portion of the name. Name getResolvedName() Retrieves the leading portion of the name that was resolved successfully. Object getResolvedObj() Retrieves the object to which resolution was successful. Throwable getRootCause() Retrieves the root cause of this NamingException, if any. Throwable initCause(Throwable cause) Initializes the cause of this exception to the specified value. void setRemainingName(Name name) Sets the remaining name field of this exception. void setResolvedName(Name name) Sets the resolved name field of this exception. void setResolvedObj(Object obj) Sets the resolved object field of this exception. void setRootCause(Throwable e) Records the root cause of this NamingException. String toString(boolean detail) Generates the string representation in more detail. String toString() Generates the string representation of this exception.
From class java.lang.Throwable synchronized Throwable fillInStackTrace() Fills in the execution stack trace. Throwable getCause() Returns the cause of this throwable or null if the cause is nonexistent or unknown. String getLocalizedMessage() Creates a localized description of this throwable. String getMessage() Returns the detail message string of this throwable. StackTraceElement[] getStackTrace() Provides programmatic access to the stack trace information printed by printStackTrace(). synchronized Throwable initCause(Throwable cause) Initializes the cause of this throwable to the specified value. void printStackTrace(PrintWriter s) Prints this throwable and its backtrace to the specified print writer. void printStackTrace(PrintStream s) Prints this throwable and its backtrace to the specified print stream. void printStackTrace() Prints this throwable and its backtrace to the standard error stream. void setStackTrace(StackTraceElement[] stackTrace) Sets the stack trace elements that will be returned by getStackTrace() and printed by printStackTrace() and related methods. String toString() Returns a short description of this throwable.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait() Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object. final void wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long timeout) Causes the current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed.