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

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.apache.directory.shared.ldap.exception.LdapException
              extended by org.apache.directory.shared.ldap.exception.LdapOperationException
                  extended by org.apache.directory.shared.ldap.exception.AbstractLdapReferralException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
LdapPartialResultException, LdapReferralException

public class AbstractLdapReferralException
extends LdapOperationException

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

Version:
$Rev: 923448 $
Author:
Apache Directory Project
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.directory.shared.ldap.exception.LdapOperationException
resolvedDn, resultCode
 
Constructor Summary
AbstractLdapReferralException(java.lang.String explanation)
           
 
Method Summary
 javax.naming.Context getReferralContext()
           
 javax.naming.Context getReferralContext(java.util.Hashtable<?,?> arg)
           
 DN getRemainingDn()
           
 java.lang.Object getResolvedObject()
           
 ResultCodeEnum getResultCode()
          Always returns ResultCodeEnum.REFERRAL
 void retryReferral()
           
 void setRemainingDn(DN remainingDn)
           
 void setResolvedObject(java.lang.Object resolvedObject)
           
 
Methods inherited from class org.apache.directory.shared.ldap.exception.LdapOperationException
getResolvedDn, setResolvedDn
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbstractLdapReferralException

public AbstractLdapReferralException(java.lang.String explanation)
See Also:
ReferralException.ReferralException(java.lang.String)
Method Detail

getResultCode

public ResultCodeEnum getResultCode()
Always returns ResultCodeEnum.REFERRAL

Overrides:
getResultCode in class LdapOperationException
Returns:
the LDAP result code corresponding to this exception type.
See Also:
LdapException#getResultCode()

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

retryReferral

public void retryReferral()

getRemainingDn

public DN getRemainingDn()
Returns:
the remainingDn

setRemainingDn

public void setRemainingDn(DN remainingDn)
Parameters:
remainingDn - the remainingName to set

getResolvedObject

public java.lang.Object getResolvedObject()
Returns:
the resolvedObject

setResolvedObject

public void setResolvedObject(java.lang.Object resolvedObject)
Parameters:
resolvedObject - the resolvedObject to set


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