ReferralException by providing a
getReferralContext() method that accepts request controls.
LdapReferralException is an abstract class. Concrete implementations of it
determine its synchronization and serialization properties.
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.
| Modifier and Type | Field and Description |
|---|---|
| private static final long |
| Access | Constructor and Description |
|---|---|
| protected | LdapReferralException(String
Additional detail about this exception. Can be null. explanation)Constructs a new instance of LdapReferralException using the explanation supplied. |
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public abstract Context | Returns: The non-null context at which to continue the method.Implements abstract javax. Retrieves the context at which to continue the method using the context's environment and no controls. |
| public abstract Context | Returns: The non-null context at which to continue the method.The possibly null environment to use when retrieving the
referral context. If null, no environment properties will be used. env)Implements abstract javax. Retrieves the context at which to continue the method using environment properties and no controls. |
| public abstract Context | Returns: The non-null context at which to continue the method.The possibly null environment properties to use when
for the new context. If null, the context is initialized with no environment
properties. env, Control[] The possibly null request controls to use for the new context.
If null or the empty array means use no request controls. reqCtls)Retrieves the context at which to continue the method using request controls and environment properties. |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| LdapReferralException | back to summary |
|---|---|
| protected LdapReferralException(String explanation) Constructs a new instance of LdapReferralException using the explanation supplied. All other fields are set to null.
| |
| LdapReferralException | back to summary |
|---|---|
| protected LdapReferralException() Constructs a new instance of LdapReferralException. All fields are set to null. | |
| getReferralContext | back to summary |
|---|---|
| public abstract Context getReferralContext() throws NamingException Implements abstract javax. Retrieves the context at which to continue the method using the
context's environment and no controls.
The referral context is created using the environment properties of
the context that threw the This method is equivalent to wheregetReferralContext(ctx.getEnvironment(), null); ctx is the context that threw the ReferralException.
It is overridden in this class for documentation purposes only.
See
| |
| getReferralContext | back to summary |
|---|---|
| public abstract Context getReferralContext(Hashtable<?, ?> env) throws NamingException Implements abstract javax. Retrieves the context at which to continue the method using
environment properties and no controls.
The referral context is created using This method is equivalent to getReferralContext(env, null);
It is overridden in this class for documentation purposes only.
See
| |
| getReferralContext | back to summary |
|---|---|
| public abstract Context getReferralContext(Hashtable<?, ?> env, Control[] reqCtls) throws NamingException Retrieves the context at which to continue the method using request controls and environment properties. Regardless of whether a referral is encountered directly during a context operation, or indirectly, for example, during a search enumeration, the referral exception should provide a context at which to continue the operation. To continue the operation, the client program should re-invoke the method using the same arguments as the original invocation.
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
| |