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

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
                      extended by org.apache.directory.shared.ldap.exception.LdapReferralException
All Implemented Interfaces:
java.io.Serializable

public class LdapReferralException
extends AbstractLdapReferralException

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

Version:
$Rev: 925499 $
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
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()
           
 DN getRemainingDn()
           
 java.lang.Object getResolvedObject()
           
 ResultCodeEnum getResultCode()
          Always returns ResultCodeEnum.REFERRAL
 void retryReferral()
           
 void setRemainingDn(DN remainingDn)
           
 void setResolvedObject(java.lang.Object resolvedObject)
           
 boolean skipReferral()
           
 
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

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

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

getReferralInfo

public java.lang.String getReferralInfo()

getReferralContext

public javax.naming.Context getReferralContext()
                                        throws javax.naming.NamingException
Overrides:
getReferralContext in class AbstractLdapReferralException
Throws:
javax.naming.NamingException

getReferralContext

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

skipReferral

public boolean skipReferral()

retryReferral

public void retryReferral()
Overrides:
retryReferral in class AbstractLdapReferralException

getRemainingDn

public DN getRemainingDn()
Overrides:
getRemainingDn in class AbstractLdapReferralException
Returns:
the remainingDn

setRemainingDn

public void setRemainingDn(DN remainingDn)
Overrides:
setRemainingDn in class AbstractLdapReferralException
Parameters:
remainingDn - the remainingName to set

getResolvedObject

public java.lang.Object getResolvedObject()
Overrides:
getResolvedObject in class AbstractLdapReferralException
Returns:
the resolvedObject

setResolvedObject

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


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