org.apache.directory.server.protocol.shared

Class DirectoryBackedService

java.lang.Object

org.apache.directory.server.protocol.shared.AbstractProtocolService

org.apache.directory.server.protocol.shared.DirectoryBackedService

All Implemented Interfaces:

ProtocolService

Direct Known Subclasses:

ChangePasswordServer, DnsServer, KdcServer, LdapServer

public abstract class DirectoryBackedService
extends AbstractProtocolService

Base class shared by all protocol providers for configuration.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	catelogBased determines if the search base is pointer to a catalog or a single entry point
private DirectoryService	directoryService directory service core where protocol data is backed
private java.lang.String	searchBaseDn The single location where entries are stored.

Fields inherited from class org.apache.directory.server.protocol.shared.AbstractProtocolService

transports

Constructor Summary

Constructors

Constructor and Description
DirectoryBackedService()

Method Summary

Modifier and Type	Method and Description
DirectoryService	getDirectoryService()
java.lang.String	getSearchBaseDn() Returns the search base Dn.
boolean	isCatelogBased() Gets true if this service uses a catalog for searching different regions of the DIT for its data.
void	setCatelogBased(boolean catelogBased) Set true if this service uses a catalog for searching different regions of the DIT for its data.
void	setDirectoryService(DirectoryService directoryService)
void	setSearchBaseDn(java.lang.String searchBaseDn)

Methods inherited from class org.apache.directory.server.protocol.shared.AbstractProtocolService

addTransports, getDatagramAcceptor, getServiceId, getServiceName, getSocketAcceptor, getTransports, isEnabled, isStarted, setEnabled, setServiceId, setServiceName, setStarted, setTransports

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.server.protocol.shared.ProtocolService

start, stop

Field Detail

searchBaseDn

private java.lang.String searchBaseDn

The single location where entries are stored. If this service is catalog based the store will search the system partition configuration for catalog entries. Otherwise it will use this search base as a single point of searching the DIT.

catelogBased

private boolean catelogBased

determines if the search base is pointer to a catalog or a single entry point

directoryService

private DirectoryService directoryService

directory service core where protocol data is backed

Constructor Detail

DirectoryBackedService

public DirectoryBackedService()

Method Detail

getDirectoryService

public DirectoryService getDirectoryService()

setDirectoryService

public void setDirectoryService(DirectoryService directoryService)

getSearchBaseDn

public java.lang.String getSearchBaseDn()

Returns the search base Dn.

Returns:

The search base Dn.

setSearchBaseDn

public void setSearchBaseDn(java.lang.String searchBaseDn)

Parameters:

searchBaseDn - The searchBaseDn to set.

isCatelogBased

public boolean isCatelogBased()

Gets true if this service uses a catalog for searching different regions of the DIT for its data.

Returns:

true if the search base dn is for a catalog, false otherwise

setCatelogBased

public void setCatelogBased(boolean catelogBased)

Set true if this service uses a catalog for searching different regions of the DIT for its data.

Parameters:

catelogBased - if the search base dn is for a catalog, false otherwise