com.sun.jndi.ldap
Class LdapReferralException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          javax.naming.NamingException
              javax.naming.ReferralException
                  javax.naming.ldap.LdapReferralException
                      com.sun.jndi.ldap.LdapReferralException

All Implemented Interfaces:

Serializable

public final class LdapReferralException
extends LdapReferralException

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.

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.naming.NamingException

remainingName, resolvedName, resolvedObj, rootException

Method Summary

Context	getReferralContext() Gets a context at which to continue processing.
Context	getReferralContext(Hashtable<?,?> newProps) Gets a context at which to continue processing.
Context	getReferralContext(Hashtable<?,?> newProps, Control[] connCtls) Gets a context at which to continue processing.
Object	getReferralInfo() Gets referral information.
void	retryReferral() Marks the current referral as one to be retried.
boolean	skipReferral() Marks the current referral as one to be ignored.

Methods inherited from class javax.naming.ldap.LdapReferralException

getReferralContext, getReferralContext

Methods inherited from class javax.naming.NamingException

appendRemainingComponent, appendRemainingName, getExplanation, getRemainingName, getResolvedName, getResolvedObj, getRootCause, printStackTrace, printStackTrace, printStackTrace, setRemainingName, setResolvedName, setResolvedObj, setRootCause, toString, toString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getReferralContext

public Context getReferralContext()
                           throws NamingException

Gets a context at which to continue processing. The current environment properties are re-used.

Specified by:

getReferralContext in class LdapReferralException

Throws:

NamingException

getReferralContext

public Context getReferralContext(Hashtable<?,?> newProps)
                           throws NamingException

Gets a context at which to continue processing. The supplied environment properties are used.

Throws:

NamingException

getReferralContext

public Context getReferralContext(Hashtable<?,?> newProps,
                                  Control[] connCtls)
                           throws NamingException

Gets a context at which to continue processing. The supplied environment properties and connection controls are used.

Throws:

NamingException

getReferralInfo

public Object getReferralInfo()

Gets referral information.

Specified by:

getReferralInfo in class ReferralException

retryReferral

public void retryReferral()

Marks the current referral as one to be retried.

Specified by:

retryReferral in class ReferralException

skipReferral

public boolean skipReferral()

Marks the current referral as one to be ignored. Returns false when there are no referrals remaining to be processed.

Specified by:

skipReferral in class ReferralException