| java.lang.Object java.lang.Throwable java.lang.Exception javax.naming.NamingException javax.naming.ReferralException javax.naming.ldap.LdapReferralException com.sun.jndi.ldap.LdapReferralException
LdapReferralException | final public class LdapReferralException extends javax.naming.ldap.LdapReferralException (Code) | | 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.
author: Vincent Ryan |
LdapReferralException | LdapReferralException(Name resolvedName, Object resolvedObj, Name remainingName, String explanation, Hashtable envprops, String nextName, int handleReferrals, Control[] reqCtls)(Code) | | Constructs a new instance of LdapReferralException.
Parameters: resolvedName - The part of the name that has been successfullyresolved. Parameters: resolvedObj - The object to which resolution was successful. Parameters: remainingName - The remaining unresolved portion of the name. Parameters: explanation - Additional detail about this exception. |
appendUnprocessedReferrals | LdapReferralException appendUnprocessedReferrals(LdapReferralException back)(Code) | | Appends the supplied (chain of) referral exception onto the end of
the current (chain of) referral exception. Spent referral exceptions
are trimmed off.
|
dump | void dump()(Code) | | Display the state of each element in a chain of LdapReferralException
objects.
|
getNamingException | NamingException getNamingException()(Code) | | Gets the exception generated while processing a referral.
|
getNextReferral | String getNextReferral() throws ReferralException(Code) | | Gets the next referral. When the current set of referrals have
been exhausted then the next referral exception is thrown, if available.
|
getReferralContext | public Context getReferralContext() throws NamingException(Code) | | Gets a context at which to continue processing.
The current environment properties are re-used.
|
getReferralContext | public Context getReferralContext(Hashtable, ?> newProps) throws NamingException(Code) | | Gets a context at which to continue processing.
The supplied environment properties are used.
|
getReferralContext | public Context getReferralContext(Hashtable, ?> newProps, Control[] connCtls) throws NamingException(Code) | | Gets a context at which to continue processing.
The supplied environment properties and connection controls are used.
|
getReferralInfo | public Object getReferralInfo()(Code) | | Gets referral information.
|
hasMoreReferralExceptions | boolean hasMoreReferralExceptions()(Code) | | Tests if there are any referral exceptions remaining to be processed.
|
hasMoreReferrals | boolean hasMoreReferrals()(Code) | | Tests if there are any referrals remaining to be processed.
If name resolution has already completed then any remaining
referrals (in the current referral exception) will be ignored.
|
retryReferral | public void retryReferral()(Code) | | Marks the current referral as one to be retried.
|
setHopCount | void setHopCount(int hopCount)(Code) | | Sets the counter which records the number of hops that result
from following a sequence of referrals.
|
setNameResolved | void setNameResolved(boolean resolved)(Code) | | Sets the flag to indicate that the target name has been resolved.
|
setNamingException | void setNamingException(NamingException e)(Code) | | Sets the exception generated while processing a referral.
Only the first exception is recorded.
|
setNewRdn | void setNewRdn(String newRdn)(Code) | | Sets the new RDN name so that the rename operation can be completed
(when a referral is being followed).
|
setReferralInfo | void setReferralInfo(Vector referrals, boolean continuationRef)(Code) | | Sets referral information.
|
skipReferral | public boolean skipReferral()(Code) | | Marks the current referral as one to be ignored.
Returns false when there are no referrals remaining to be processed.
|
|
|