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

Class AbstractLdapReferralException

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

All Implemented Interfaces:

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.

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Dn	remainingDn The remaining Dn
private Object	resolvedObject the resolvedObject
(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
AbstractLdapReferralException(String explanation) Creates a new instance of AbstractLdapReferralException.

Method Summary

Modifier and Type	Method and Description
Context	getReferralContext() Not yet implemented
Context	getReferralContext(Map<?,?> arg) Not yet implemented
Dn	getRemainingDn()
Object	getResolvedObject()
ResultCodeEnum	getResultCode() Always returns ResultCodeEnum.REFERRAL
void	retryReferral() Retry.
void	setRemainingDn(Dn remainingDn)
void	setResolvedObject(Object resolvedObject)

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

remainingDn

private Dn remainingDn

The remaining Dn

resolvedObject

private Object resolvedObject

the resolvedObject

Constructor Detail

AbstractLdapReferralException

public AbstractLdapReferralException(String explanation)

Creates a new instance of AbstractLdapReferralException.

Parameters:

explanation - The associated message

Method Detail

getResultCode

public ResultCodeEnum getResultCode()

Always returns ResultCodeEnum.REFERRAL

Overrides:

getResultCode in class LdapOperationException

Returns:

The interned ResultCode

getReferralContext

public Context getReferralContext()
                           throws NamingException

Not yet implemented

Returns:

The Referral Context

Throws:

NamingException - If the operation failed

getReferralContext

public Context getReferralContext(Map<?,?> arg)
                           throws NamingException

Not yet implemented

Parameters:

arg - The arguments

Returns:

The referral context

Throws:

NamingException - If the operation failed

retryReferral

public void retryReferral()

Retry. Not yet implemented

getRemainingDn

public Dn getRemainingDn()

Returns:

the remainingDn

setRemainingDn

public void setRemainingDn(Dn remainingDn)

Parameters:

remainingDn - the remainingName to set

getResolvedObject

public Object getResolvedObject()

Returns:

the resolvedObject

setResolvedObject

public void setResolvedObject(Object resolvedObject)

Parameters:

resolvedObject - the resolvedObject to set