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

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

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

LdapReferralException

public LdapReferralException(java.util.Collection<java.lang.String> 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.String getReferralInfo()
Specified by:
getReferralInfo in class javax.naming.ReferralException

getReferralContext

public javax.naming.Context getReferralContext()
                                        throws javax.naming.NamingException
Specified by:
getReferralContext in class javax.naming.ReferralException
Throws:
javax.naming.NamingException

getReferralContext

public javax.naming.Context getReferralContext(java.util.Hashtable<?,?> arg)
                                        throws javax.naming.NamingException
Specified by:
getReferralContext in class javax.naming.ReferralException
Throws:
javax.naming.NamingException

skipReferral

public boolean skipReferral()
Specified by:
skipReferral in class javax.naming.ReferralException

retryReferral

public void retryReferral()
Specified by:
retryReferral in class javax.naming.ReferralException


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.