org.apache.directory.server.core.shared

Class ReferralManagerImpl

java.lang.Object

org.apache.directory.server.core.shared.ReferralManagerImpl

All Implemented Interfaces:

ReferralManager

public class ReferralManagerImpl
extends Object
implements ReferralManager

Implement a referral Manager, handling the requests from the LDAP protocol.
Referrals are stored in a tree, where leaves are the referrals. We are using the very same structure than for the partition manager.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
ReferralManagerImpl(DirectoryService directoryService) Creates a new instance of ReferralManagerImpl.

Method Summary

Modifier and Type	Method and Description
void	addReferral(org.apache.directory.api.ldap.model.entry.Entry entry) Add a referral to the manager.
org.apache.directory.api.ldap.model.entry.Entry	getParentReferral(org.apache.directory.api.ldap.model.name.Dn dn) Get the Dn of the parent referral for a specific Dn
boolean	hasParentReferral(org.apache.directory.api.ldap.model.name.Dn dn) Tells if this Dn has a parent which is a referral.
void	init(DirectoryService directoryService, String... suffixes) Initialize the manager, reading all the referrals from the base.
boolean	isReferral(org.apache.directory.api.ldap.model.name.Dn dn) Tells if a Dn is a referral (its associated entry contains the Referral ObjectClass).
void	lockRead() Get a read-lock on the referralManager.
void	lockWrite() Get a write-lock on the referralManager.
void	remove(DirectoryService directoryService, org.apache.directory.api.ldap.model.name.Dn suffix) Remove a partition from the manager, reading all the referrals from the base.
void	removeReferral(org.apache.directory.api.ldap.model.entry.Entry entry) Remove a referral from the manager.
void	unlock() Release the read-write lock on the referralManager.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferralManagerImpl

public ReferralManagerImpl(DirectoryService directoryService)
                    throws org.apache.directory.api.ldap.model.exception.LdapException

Creates a new instance of ReferralManagerImpl.

Parameters:

directoryService - The directory service

Throws:

Exception - If we can't initialize the manager

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

Method Detail

lockRead

public void lockRead()

Get a read-lock on the referralManager. No read operation can be done on the referralManager if this method is not called before.

Specified by:

lockRead in interface ReferralManager

lockWrite

public void lockWrite()

Get a write-lock on the referralManager. No write operation can be done on the referralManager if this method is not called before.

Specified by:

lockWrite in interface ReferralManager

unlock

public void unlock()

Release the read-write lock on the referralManager. This method must be called after having read or modified the ReferralManager

Specified by:

unlock in interface ReferralManager

addReferral

public void addReferral(org.apache.directory.api.ldap.model.entry.Entry entry)

Add a referral to the manager.

Specified by:

addReferral in interface ReferralManager

init

public void init(DirectoryService directoryService,
                 String... suffixes)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Initialize the manager, reading all the referrals from the base. The manager will search for every entries having a Referral ObjectClass.

Specified by:

init in interface ReferralManager

Parameters:

directoryService - The associated LDAP service

suffixes - The partition list

Throws:

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

remove

public void remove(DirectoryService directoryService,
                   org.apache.directory.api.ldap.model.name.Dn suffix)
            throws Exception

Remove a partition from the manager, reading all the referrals from the base. The manager will search for every entries having a Referral ObjectClass, and will remove them from the referrals table.

Specified by:

remove in interface ReferralManager

Parameters:

directoryService - The associated LDAP service

Throws:

Exception

hasParentReferral

public boolean hasParentReferral(org.apache.directory.api.ldap.model.name.Dn dn)

Tells if this Dn has a parent which is a referral.
For instance, if cn=example, dc=acme, dc=org is the Dn to check, and if dc=acme, dc=org is a referral, this this method will return true.

Specified by:

hasParentReferral in interface ReferralManager

Parameters:

dn - The Dn we want to check for a referral in its partents

Returns:

true if there is a parent referral

getParentReferral

public org.apache.directory.api.ldap.model.entry.Entry getParentReferral(org.apache.directory.api.ldap.model.name.Dn dn)

Get the Dn of the parent referral for a specific Dn

Specified by:

getParentReferral in interface ReferralManager

Parameters:

dn - The Dn from which we want to get the parent referral

Returns:

The parent referral of null if none is found

isReferral

public boolean isReferral(org.apache.directory.api.ldap.model.name.Dn dn)

Tells if a Dn is a referral (its associated entry contains the Referral ObjectClass). It does not check that the associated entry inherits from a referral.

Specified by:

isReferral in interface ReferralManager

Parameters:

dn - The entry's Dn we want to check

Returns:

true if the Dn is associated with a referral

removeReferral

public void removeReferral(org.apache.directory.api.ldap.model.entry.Entry entry)
                    throws org.apache.directory.api.ldap.model.exception.LdapException

Remove a referral from the manager.

Specified by:

removeReferral in interface ReferralManager

Throws:

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