org.apache.directory.shared.ldap.exception
Class LdapReferralException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          javax.naming.NamingException
              javax.naming.ReferralException
                  org.apache.directory.shared.ldap.exception.LdapReferralException

All Implemented Interfaces:

Serializable, LdapException

public class LdapReferralException
extends ReferralException
implements LdapException

A ReferralException which associates a resultCode namely the ResultCodeEnum.REFERRAL resultCode with the exception.

Version:

$Rev: 596222 $

Author:

Apache Directory Project

See Also:

LdapException, ReferralException, LDAP ResultCode to JNDI Exception Mappings, Serialized Form

Field Summary

Fields inherited from class javax.naming.NamingException

remainingName, resolvedName, resolvedObj, rootException

Constructor Summary

LdapReferralException(Collection<String> refs)

LdapReferralException(Collection<String> refs, String explanation)

Method Summary

Context	getReferralContext()
Context	getReferralContext(Hashtable<?,?> arg)
String	getReferralInfo()
ResultCodeEnum	getResultCode() Always returns ResultCodeEnum.REFERRAL
void	retryReferral()
boolean	skipReferral()

Methods inherited from class javax.naming.NamingException

appendRemainingComponent, appendRemainingName, getCause, getExplanation, getRemainingName, getResolvedName, getResolvedObj, getRootCause, initCause, setRemainingName, setResolvedName, setResolvedObj, setRootCause, toString, toString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LdapReferralException

public LdapReferralException(Collection<String> refs)

See Also:

ReferralException.ReferralException()

LdapReferralException

public LdapReferralException(Collection<String> refs,
                             String explanation)

See Also:

ReferralException.ReferralException(java.lang.String)

Method Detail

getResultCode

public ResultCodeEnum getResultCode()

Always returns ResultCodeEnum.REFERRAL

Specified by:

getResultCode in interface LdapException

Returns:

the LDAP result code corresponding to this exception type.

See Also:

LdapException.getResultCode()

getReferralInfo

public String getReferralInfo()

Specified by:

getReferralInfo in class ReferralException

getReferralContext

public Context getReferralContext()
                           throws NamingException

Specified by:

getReferralContext in class ReferralException

Throws:

NamingException

getReferralContext

public Context getReferralContext(Hashtable<?,?> arg)
                           throws NamingException

Specified by:

getReferralContext in class ReferralException

Throws:

NamingException

skipReferral

public boolean skipReferral()

Specified by:

skipReferral in class ReferralException

retryReferral

public void retryReferral()

Specified by:

retryReferral in class ReferralException