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

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byjavax.naming.NamingException
              extended byjavax.naming.ReferralException
                  extended byorg.apache.directory.shared.ldap.exception.LdapReferralException
All Implemented Interfaces:
LdapException, java.io.Serializable

public class LdapReferralException
extends javax.naming.ReferralException
implements LdapException

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

Version:
$Rev: 379008 $
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(java.util.Collection refs)
           
LdapReferralException(java.util.Collection refs, java.lang.String explanation)
           
 
Method Summary
 javax.naming.Context getReferralContext()
           
 javax.naming.Context getReferralContext(java.util.Hashtable arg)
           
 java.lang.Object 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(java.util.Collection refs)
See Also:
ReferralException.ReferralException()

LdapReferralException

public LdapReferralException(java.util.Collection refs,
                             java.lang.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 java.lang.Object getReferralInfo()

getReferralContext

public javax.naming.Context getReferralContext()
                                        throws javax.naming.NamingException
Throws:
javax.naming.NamingException

getReferralContext

public javax.naming.Context getReferralContext(java.util.Hashtable arg)
                                        throws javax.naming.NamingException
Throws:
javax.naming.NamingException

skipReferral

public boolean skipReferral()

retryReferral

public void retryReferral()


Copyright © 2003-2006 . All Rights Reserved.