public abstract class LdapReferralException extends ReferralException
A Control[] array passed as a parameter to the getReferralContext() method is owned by the caller. The service provider will not modify the array or keep a reference to it, although it may keep references to the individual Control objects in the array.
remainingName, resolvedName, resolvedObj, rootException| Modifier | Constructor and Description |
|---|---|
protected |
LdapReferralException()
Constructs a new instance of LdapReferralException.
|
protected |
LdapReferralException(String explanation)
Constructs a new instance of LdapReferralException using the
explanation supplied.
|
| Modifier and Type | Method and Description |
|---|---|
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)
Retrieves the context at which to continue the method using
environment properties 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.
|
getReferralInfo, retryReferral, skipReferralappendRemainingComponent, appendRemainingName, getCause, getExplanation, getRemainingName, getResolvedName, getResolvedObj, getRootCause, initCause, setRemainingName, setResolvedName, setResolvedObj, setRootCause, toString, toStringaddSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTraceprotected LdapReferralException(String explanation)
explanation - Additional detail about this exception. Can be null.Throwable.getMessage()protected LdapReferralException()
public abstract Context getReferralContext() throws NamingException
This method is equivalent to
where ctx is the context that threw the ReferralException.getReferralContext(ctx.getEnvironment(), null);
It is overridden in this class for documentation purposes only. See ReferralException for how to use this method.
getReferralContext in class ReferralExceptionNamingException - If a naming exception was encountered.
Call either retryReferral() or skipReferral()
to continue processing referrals.public abstract Context getReferralContext(Hashtable<?,?> env) throws NamingException
This method is equivalent to
getReferralContext(env, null);
It is overridden in this class for documentation purposes only. See ReferralException for how to use this method.
getReferralContext in class ReferralExceptionenv - The possibly null environment to use when retrieving the
referral context. If null, no environment properties will be used.NamingException - If a naming exception was encountered.
Call either retryReferral() or skipReferral()
to continue processing referrals.public abstract Context getReferralContext(Hashtable<?,?> env, Control[] reqCtls) throws NamingException
reqCtls is used when creating the connection to the referred server. These controls will be used as the connection request controls for the context and context instances derived from the context. reqCtls will also be the context's request controls for subsequent context operations. See the LdapContext class description for details.
This method should be used instead of the other two overloaded forms when the caller needs to supply request controls for creating the referral context. It might need to do this, for example, when it needs to supply special controls relating to authentication.
Service provider implementors should read the "Service Provider" section in the LdapContext class description for implementation details.
reqCtls - The possibly null request controls to use for the new context.
If null or the empty array means use no request controls.env - The possibly null environment properties to use when
for the new context. If null, the context is initialized with no environment
properties.NamingException - If a naming exception was encountered.
Call either retryReferral() or skipReferral()
to continue processing referrals. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.