javax.naming
Class ReferralException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--javax.naming.NamingException
                    |
                    +--javax.naming.ReferralException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

LdapReferralException

public abstract class ReferralException

extends NamingException

This abstract class is used to represent a referral exception, which is generated in response to a referral such as that returned by LDAP v3 servers.

A service provider provides a subclass of ReferralException by providing implementations for getReferralInfo() and getReferralContext() (and appropriate constructors and/or corresponding "set" methods).

The following code sample shows how ReferralException can be used.

	while (true) {
	    try {
		bindings = ctx.listBindings(name);
		while (bindings.hasMore()) {
		    b = bindings.next();
		    ...
		}
		break;
	    } catch (ReferralException e) {
		ctx = e.getReferralContext();
	    }
	}
 

ReferralException is an abstract class. Concrete implementations determine its synchronization and serialization properties.

An environment parameter passed to the getReferralContext() method is owned by the caller. The service provider will not modify the object or keep a reference to it, but may keep a reference to a clone of it.

Since:

1.3

See Also:

Serialized Form

Field Summary

 

Fields inherited from class javax.naming.NamingException

remainingName, resolvedName, resolvedObj, rootException

 

Constructor Summary
protected	ReferralException()     Constructs a new instance of ReferralException.
protected	ReferralException(String explanation)     Constructs a new instance of ReferralException using the explanation supplied.

 

Method Summary
abstract  Context	getReferralContext()     Retrieves the context at which to continue the method.
abstract  Context	getReferralContext(Hashtable env)     Retrieves the context at which to continue the method using environment properties.
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.

 

Methods inherited from class javax.naming.NamingException

appendRemainingComponent, appendRemainingName, getExplanation, getRemainingName, getResolvedName,