Class LdapReferralException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- org.apache.directory.api.ldap.model.exception.LdapException
-
- org.apache.directory.api.ldap.model.exception.LdapOperationException
-
- org.apache.directory.api.ldap.model.exception.AbstractLdapReferralException
-
- org.apache.directory.api.ldap.model.exception.LdapReferralException
-
- All Implemented Interfaces:
Serializable
public class LdapReferralException extends AbstractLdapReferralException
ALdapOperationException
which associates a resultCode namely theResultCodeEnum.REFERRAL
resultCode with the exception.- Author:
- Apache Directory Project
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description LdapReferralException(Collection<String> refs)
Creates a new instance of LdapReferralException.LdapReferralException(Collection<String> refs, String explanation)
Creates a new instance of LdapReferralException.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Context
getReferralContext()
Not yet implementedContext
getReferralContext(Map<?,?> arg)
Not yet implementedString
getReferralInfo()
Dn
getRemainingDn()
Object
getResolvedObject()
ResultCodeEnum
getResultCode()
Always returnsResultCodeEnum.REFERRAL
void
retryReferral()
Retry.void
setRemainingDn(Dn remainingDn)
void
setResolvedObject(Object resolvedObject)
boolean
skipReferral()
Move to the next referral-
Methods inherited from class org.apache.directory.api.ldap.model.exception.LdapOperationException
getResolvedDn, setResolvedDn
-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
Constructor Detail
-
LdapReferralException
public LdapReferralException(Collection<String> refs)
Creates a new instance of LdapReferralException.- Parameters:
refs
- The list of referrals
-
LdapReferralException
public LdapReferralException(Collection<String> refs, String explanation)
Creates a new instance of LdapReferralException.- Parameters:
refs
- The list of referralsexplanation
- The associated error message
-
-
Method Detail
-
getResultCode
public ResultCodeEnum getResultCode()
Always returnsResultCodeEnum.REFERRAL
- Overrides:
getResultCode
in classAbstractLdapReferralException
- Returns:
- The ResultCode
-
getReferralInfo
public String getReferralInfo()
- Returns:
- The current Referral
-
getReferralContext
public Context getReferralContext() throws NamingException
Not yet implemented- Overrides:
getReferralContext
in classAbstractLdapReferralException
- Returns:
- The Referral Context
- Throws:
NamingException
- If the operation failed
-
getReferralContext
public Context getReferralContext(Map<?,?> arg) throws NamingException
Not yet implemented- Overrides:
getReferralContext
in classAbstractLdapReferralException
- Parameters:
arg
- The arguments- Returns:
- The referral context
- Throws:
NamingException
- If the operation failed
-
skipReferral
public boolean skipReferral()
Move to the next referral- Returns:
- true if there is some next referral
-
retryReferral
public void retryReferral()
Retry. Not yet implemented- Overrides:
retryReferral
in classAbstractLdapReferralException
-
getRemainingDn
public Dn getRemainingDn()
- Overrides:
getRemainingDn
in classAbstractLdapReferralException
- Returns:
- the remainingDn
-
setRemainingDn
public void setRemainingDn(Dn remainingDn)
- Overrides:
setRemainingDn
in classAbstractLdapReferralException
- Parameters:
remainingDn
- the remainingName to set
-
getResolvedObject
public Object getResolvedObject()
- Overrides:
getResolvedObject
in classAbstractLdapReferralException
- Returns:
- the resolvedObject
-
setResolvedObject
public void setResolvedObject(Object resolvedObject)
- Overrides:
setResolvedObject
in classAbstractLdapReferralException
- Parameters:
resolvedObject
- the resolvedObject to set
-
-