org.apache.directory.api.ldap.model.exception

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:

java.io.Serializable

public class LdapReferralException
extends AbstractLdapReferralException

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private int	index The current index in the list of referrals
private java.util.List<java.lang.String>	refs The list of referrals
private Dn	remainingDn The remaining Dn
private java.lang.Object	resolvedObject TODO
(package private) static long	serialVersionUID The serial version UUID

Fields inherited from class org.apache.directory.api.ldap.model.exception.LdapOperationException

resolvedDn, resultCode

Constructor Summary

Constructors

Constructor and Description
LdapReferralException(java.util.Collection<java.lang.String> refs) Creates a new instance of LdapReferralException.
LdapReferralException(java.util.Collection<java.lang.String> refs, java.lang.String explanation) Creates a new instance of LdapReferralException.

Method Summary

Modifier and Type	Method and Description
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() 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

static final long serialVersionUID

The serial version UUID

See Also:

Constant Field Values

refs

private final java.util.List<java.lang.String> refs

The list of referrals

index

private int index

The current index in the list of referrals

remainingDn

private Dn remainingDn

The remaining Dn

resolvedObject

private java.lang.Object resolvedObject

TODO

Constructor Detail

LdapReferralException

public LdapReferralException(java.util.Collection<java.lang.String> refs)

Creates a new instance of LdapReferralException.

Parameters:

refs - The list of referrals

LdapReferralException

public LdapReferralException(java.util.Collection<java.lang.String> refs,
                             java.lang.String explanation)

Creates a new instance of LdapReferralException.

Parameters:

refs - The list of referrals

explanation - The associated error message

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()

Returns:

The current Referral

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()

Move to the next referral

Returns:

true if there is some next referral

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