Class CursorLdapReferralException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- org.apache.directory.api.ldap.model.cursor.CursorException
-
- org.apache.directory.api.ldap.model.cursor.CursorLdapReferralException
-
- All Implemented Interfaces:
Serializable
public class CursorLdapReferralException extends CursorException
A specific form of CursorException used when a referral is met- Author:
- Apache Directory Project
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static CursorLdapReferralException
INSTANCE
A static exception to be used by the monitor
-
Constructor Summary
Constructors Constructor Description CursorLdapReferralException(LdapReferralException ldapReferralException)
Creates a new instance of CursorClosedException.CursorLdapReferralException(LdapReferralException ldapReferralException, String message)
Creates a new instance of CursorClosedException.CursorLdapReferralException(LdapReferralException ldapReferralException, String message, Throwable cause)
Creates a new instance of CursorClosedException.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getReferralInfo()
Dn
getRemainingDn()
Object
getResolvedObject()
ResultCodeEnum
getResultCode()
Always returnsResultCodeEnum.REFERRAL
boolean
skipReferral()
Move to the next referral-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
Field Detail
-
INSTANCE
public static final CursorLdapReferralException INSTANCE
A static exception to be used by the monitor
-
-
Constructor Detail
-
CursorLdapReferralException
public CursorLdapReferralException(LdapReferralException ldapReferralException)
Creates a new instance of CursorClosedException.- Parameters:
ldapReferralException
- The associated exception
-
CursorLdapReferralException
public CursorLdapReferralException(LdapReferralException ldapReferralException, String message)
Creates a new instance of CursorClosedException.- Parameters:
ldapReferralException
- The associated exceptionmessage
- The associated message
-
CursorLdapReferralException
public CursorLdapReferralException(LdapReferralException ldapReferralException, String message, Throwable cause)
Creates a new instance of CursorClosedException.- Parameters:
ldapReferralException
- The associated exceptionmessage
- The associated messagecause
- The original cause
-
-
Method Detail
-
getResultCode
public ResultCodeEnum getResultCode()
Always returnsResultCodeEnum.REFERRAL
- Returns:
- the underlying LdapReferral result code, if any
- See Also:
LdapReferralException.getResultCode()
-
getReferralInfo
public String getReferralInfo()
- Returns:
- The current Referral
-
skipReferral
public boolean skipReferral()
Move to the next referral- Returns:
- true if there is some next referral
-
getRemainingDn
public Dn getRemainingDn()
- Returns:
- the remainingDn
-
getResolvedObject
public Object getResolvedObject()
- Returns:
- the resolvedObject
-
-