org.apache.directory.server.core.referral
Class ReferralLut

java.lang.Object
  org.apache.directory.server.core.referral.ReferralLut

public class ReferralLut
extends java.lang.Object

A simple lookup table of normalized referral distinguished names.

Version:

$Rev: 507138 $

Author:

Apache Directory Project

Constructor Summary

ReferralLut()

Method Summary

org.apache.directory.shared.ldap.name.LdapDN	getFarthestReferralAncestor(org.apache.directory.shared.ldap.name.LdapDN dn) Gets the normalized name of the farthest ancestor that is a referral.
org.apache.directory.shared.ldap.name.LdapDN	getNearestReferralAncestor(org.apache.directory.shared.ldap.name.LdapDN dn) Gets the normalized name of the nearest ancestor that is a referral.
boolean	isReferral(org.apache.directory.shared.ldap.name.LdapDN dn) Checks if a the entry at a name is a referral.
boolean	isReferral(java.lang.String dn) Checks if a the entry at a name is a referral.
void	referralAdded(org.apache.directory.shared.ldap.name.LdapDN dn) Called to add an entry to the LUT when a referral is added.
void	referralAdded(java.lang.String dn) Called to add an entry to the LUT when a referral is added.
void	referralChanged(org.apache.directory.shared.ldap.name.LdapDN oldDn, org.apache.directory.shared.ldap.name.LdapDN newDn) Called to update the LUT when the name of the referral changes due to a rename or move in the DIT.
void	referralChanged(org.apache.directory.shared.ldap.name.LdapDN oldDn, java.lang.String newDn) Called to update the LUT when the name of the referral changes due to a rename or move in the DIT.
void	referralChanged(java.lang.String oldDn, org.apache.directory.shared.ldap.name.LdapDN newDn) Called to update the LUT when the name of the referral changes due to a rename or move in the DIT.
void	referralChanged(java.lang.String oldDn, java.lang.String newDn) Called to update the LUT when the name of the referral changes due to a rename or move in the DIT.
void	referralDeleted(org.apache.directory.shared.ldap.name.LdapDN dn) Called delete an entry from the LUT when a referral is deleted.
void	referralDeleted(java.lang.String dn) Called delete an entry from the LUT when a referral is deleted.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferralLut

public ReferralLut()

Method Detail

isReferral

public boolean isReferral(org.apache.directory.shared.ldap.name.LdapDN dn)

Checks if a the entry at a name is a referral.

Parameters:

dn - the normalized name of the referral

isReferral

public boolean isReferral(java.lang.String dn)

Checks if a the entry at a name is a referral.

Parameters:

dn - the normalized name of the referral

getFarthestReferralAncestor

public org.apache.directory.shared.ldap.name.LdapDN getFarthestReferralAncestor(org.apache.directory.shared.ldap.name.LdapDN dn)

Gets the normalized name of the farthest ancestor that is a referral. If the argument is a referral it will not be returned. Only ancestor's (includes parent) are considered.

Parameters:

dn - the name to get the farthest ancestor referral name for

Returns:

the farthest referral ancestor

getNearestReferralAncestor

public org.apache.directory.shared.ldap.name.LdapDN getNearestReferralAncestor(org.apache.directory.shared.ldap.name.LdapDN dn)

Gets the normalized name of the nearest ancestor that is a referral. If the argument is a referral it will not be returned. Only ancestor's (includes parent) are considered.

Parameters:

dn - the name to get the nearest ancestor referral name for

Returns:

the nearest referral ancestor or null if one does not exist

referralAdded

public void referralAdded(org.apache.directory.shared.ldap.name.LdapDN dn)

Called to add an entry to the LUT when a referral is added.

Parameters:

dn - the normalized name of the added referral

referralAdded

public void referralAdded(java.lang.String dn)

Called to add an entry to the LUT when a referral is added.

Parameters:

dn - the normalized name of the added referral

referralDeleted

public void referralDeleted(org.apache.directory.shared.ldap.name.LdapDN dn)

Called delete an entry from the LUT when a referral is deleted.

Parameters:

dn - the normalized name of the deleted referral

referralDeleted

public void referralDeleted(java.lang.String dn)

Called delete an entry from the LUT when a referral is deleted.

Parameters:

dn - the normalized name of the deleted referral

referralChanged

public void referralChanged(org.apache.directory.shared.ldap.name.LdapDN oldDn,
                            org.apache.directory.shared.ldap.name.LdapDN newDn)

Called to update the LUT when the name of the referral changes due to a rename or move in the DIT.

Parameters:

oldDn - the normalized old name for the referral

newDn - the normalized new name for the referral

referralChanged

public void referralChanged(java.lang.String oldDn,
                            java.lang.String newDn)

Called to update the LUT when the name of the referral changes due to a rename or move in the DIT.

Parameters:

oldDn - the normalized old name for the referral

newDn - the normalized new name for the referral

referralChanged

public void referralChanged(org.apache.directory.shared.ldap.name.LdapDN oldDn,
                            java.lang.String newDn)

Called to update the LUT when the name of the referral changes due to a rename or move in the DIT.

Parameters:

oldDn - the normalized old name for the referral

newDn - the normalized new name for the referral

referralChanged

public void referralChanged(java.lang.String oldDn,
                            org.apache.directory.shared.ldap.name.LdapDN newDn)

Called to update the LUT when the name of the referral changes due to a rename or move in the DIT.

Parameters:

oldDn - the normalized old name for the referral

newDn - the normalized new name for the referral