Package com.netscape.cmscore.dbs

Class LDAPDatabase<E extends IDBObj>

java.lang.Object

com.netscape.cmscore.dbs.Database<E>

com.netscape.cmscore.dbs.LDAPDatabase<E>

public abstract class LDAPDatabase<E extends IDBObj>
extends Database<E>

This class implements LDAP database.

Author:

Endi S. Dewata

Field Summary

Fields

Modifier and Type	Field	Description
String	baseDN
DBSubsystem	dbSubsystem
static org.slf4j.Logger	logger
Class<E>	recordType

Fields inherited from class com.netscape.cmscore.dbs.Database

DEFAULT_SIZE, name, records

Constructor Summary

Constructors

Constructor	Description
LDAPDatabase(String name, DBSubsystem dbSubsystem, String baseDN, Class<E> recordType)

Method Summary

Modifier and Type	Method	Description
void	addRecord(String id, E record)
abstract String	createDN(String id)
void	createFilter(StringBuilder sb, Map<String,String> attributes)
abstract String	createFilter(String keyword, Map<String,String> attributes)
DBAttrMapper	createMapper(Class<?> attrType, DBAttribute dbAttribute)
Collection<E>	findRecords(String keyword)	Find records matching filter
Collection<E>	findRecords(String keyword, Map<String,String> attributes)	Search for LDAP records with the specified keyword and attributes.
IDBVirtualList<E>	findRecords(String keyword, Map<String,String> attributes, String[] sortKeys, int pageSize)
E	getRecord(String id)
void	register(Class<E> recordType)
void	removeRecord(String id)
void	updateRecord(String id, E record)

Methods inherited from class java.lang.Object

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

Field Details

logger

public static org.slf4j.Logger logger

dbSubsystem

public DBSubsystem dbSubsystem

baseDN

public String baseDN

recordType

public Class<E extends IDBObj> recordType

Constructor Details

LDAPDatabase

public LDAPDatabase(String name,
 DBSubsystem dbSubsystem,
 String baseDN,
 Class<E> recordType)
             throws EBaseException

Throws:

EBaseException

Method Details

createMapper

public DBAttrMapper createMapper(Class<?> attrType,
 DBAttribute dbAttribute)
                          throws EBaseException

Throws:

EBaseException

register

public void register(Class<E> recordType)
              throws EBaseException

Throws:

EBaseException

createDN

public abstract String createDN(String id)

createFilter

public abstract String createFilter(String keyword,
 Map<String,String> attributes)

createFilter

public void createFilter(StringBuilder sb,
 Map<String,String> attributes)

findRecords

public Collection<E> findRecords(String keyword)
                          throws Exception

Description copied from class: Database

Find records matching filter

Overrides:

findRecords in class Database<E extends IDBObj>

Throws:

Exception

findRecords

public Collection<E> findRecords(String keyword,
 Map<String,String> attributes)
                          throws Exception

Search for LDAP records with the specified keyword and attributes. The keyword parameter will be used to search with wildcards on certain attributes. The attributes parameter will be used to find exact matches of the specified attributes.

Throws:

Exception

findRecords

public IDBVirtualList<E> findRecords(String keyword,
 Map<String,String> attributes,
 String[] sortKeys,
 int pageSize)
                              throws Exception

Throws:

Exception

getRecord

public E getRecord(String id)
            throws Exception

Overrides:

getRecord in class Database<E extends IDBObj>

Throws:

Exception

addRecord

public void addRecord(String id,
 E record)
               throws Exception

Overrides:

addRecord in class Database<E extends IDBObj>

Throws:

Exception

updateRecord

public void updateRecord(String id,
 E record)
                  throws Exception

Overrides:

updateRecord in class Database<E extends IDBObj>

Throws:

Exception

removeRecord

public void removeRecord(String id)
                  throws Exception

Overrides:

removeRecord in class Database<E extends IDBObj>

Throws:

Exception