ReferralException Class Reference

Inherits javax::naming::NamingException.

Detailed Description

A ReferralException is an abstract class used by service providers when dealing with referral exceptions.


Public Member Functions
abstract Context	getReferralContext () throws NamingException
	Returns the `Context` where the method should be resumed following a referral exception.
abstract Context	getReferralContext (Hashtable<?,?> h) throws NamingException
	The same as `getReferralContext()` except that a `Hashtable` containing environment properties can be taken to override the environment properties associated with the context that threw this referral exception.
abstract Object	getReferralInfo ()
	Returns the information relating to the exception.
abstract boolean	skipReferral ()
	Returns true when further referral processing is outstanding.
abstract void	retryReferral ()
	Retry this referral.
Protected Member Functions
	ReferralException ()
	Constructs a `ReferralException` instance with all data initialized to null.
	ReferralException (String s)
	Constructs a `ReferralException` instance with the specified message.
Static Private Attributes
static final long	serialVersionUID = -2881363844695698876L

Constructor & Destructor Documentation

ReferralException ( ) [protected]

Constructs a ReferralException instance with all data initialized to null.

ReferralException ( String s ) [protected]

Constructs a ReferralException instance with the specified message.

All other fields are initialized to null.

Parameters:

s

The detail message for this exception. It may be null.

Member Function Documentation

abstract Context getReferralContext ( ) throws NamingException [pure virtual]

Returns the Context where the method should be resumed following a referral exception.

This should not return null.

Returns:: the Context where the method should be resumed following a referral exception. This should not return null.

Exceptions:

NamingException

Implemented in LdapReferralException, and ReferralExceptionImpl.

abstract Context getReferralContext ( Hashtable<?,?> h ) throws NamingException [pure virtual]

The same as getReferralContext() except that a Hashtable containing environment properties can be taken to override the environment properties associated with the context that threw this referral exception.

This should not return null.

Parameters:

h the environment properties. It may be null and then behaves the same as getReferralContext().