Class DBDynAttrMapper

java.lang.Object

com.netscape.certsrv.dbs.DBAttrMapper

com.netscape.cmscore.request.DBDynAttrMapper

Direct Known Subclasses:

ExtAttrDynMapper

public class DBDynAttrMapper
extends DBAttrMapper

A class representing a dynamic attribute mapper. A dynamic mapper has knowledge on how to convert a set of dynamically assigned db attribute into zero or more dynamically assigned LDAP attributes, and vice versa.

Constructor Summary

Constructors

Constructor	Description
DBDynAttrMapper()

Method Summary

Modifier and Type	Method	Description
Enumeration<String>	getSupportedLDAPAttributeNames()	Retrieves a list of LDAP attributes that are used in the mapper.
void	mapLDAPAttributeSetToObject(netscape.ldap.LDAPAttributeSet attrs, String name, IDBObj parent)	Maps LDAP attributes into object, and puts the object into 'parent'.
void	mapObjectToLDAPAttributeSet(IDBObj parent, String name, Object obj, netscape.ldap.LDAPAttributeSet attrs)	Maps object attribute into LDAP attributes.
String	mapSearchFilter(String name, String op, String value)	Maps search filters into LDAP search filter.
boolean	supportsLDAPAttributeName(String attrName)	Returns true if the LDAP attribute can be mapped by this dynamic mapper.

Methods inherited from class java.lang.Object

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

Constructor Details

DBDynAttrMapper

public DBDynAttrMapper()

Method Details

supportsLDAPAttributeName

public boolean supportsLDAPAttributeName(String attrName)

Returns true if the LDAP attribute can be mapped by this dynamic mapper.

Parameters:

attrName - LDAP attribute name to check

Returns:

a list of supported attribute names

getSupportedLDAPAttributeNames

public Enumeration<String> getSupportedLDAPAttributeNames()

Description copied from class: DBAttrMapper

Retrieves a list of LDAP attributes that are used in the mapper. By having this, the framework can provide search on selective attributes.

Specified by:

getSupportedLDAPAttributeNames in class DBAttrMapper

Returns:

a list of supported attribute names

mapObjectToLDAPAttributeSet

public void mapObjectToLDAPAttributeSet(IDBObj parent,
 String name,
 Object obj,
 netscape.ldap.LDAPAttributeSet attrs)
                                 throws EBaseException

Description copied from class: DBAttrMapper

Maps object attribute into LDAP attributes.

Specified by:

mapObjectToLDAPAttributeSet in class DBAttrMapper

Parameters:

parent - parent object where the object comes from

name - name of db attribute

obj - object itself

attrs - LDAP attribute set where the result should be stored

Throws:

EBaseException - failed to map object

mapLDAPAttributeSetToObject

public void mapLDAPAttributeSetToObject(netscape.ldap.LDAPAttributeSet attrs,
 String name,
 IDBObj parent)
                                 throws EBaseException

Description copied from class: DBAttrMapper

Maps LDAP attributes into object, and puts the object into 'parent'.

Specified by:

mapLDAPAttributeSetToObject in class DBAttrMapper

Parameters:

attrs - LDAP attribute set

name - name of db attribute to be processed

parent - parent object where the object should be added

Throws:

EBaseException - failed to map object

mapSearchFilter

public String mapSearchFilter(String name,
 String op,
 String value)
                       throws EBaseException

Description copied from class: DBAttrMapper

Maps search filters into LDAP search filter.

Specified by:

mapSearchFilter in class DBAttrMapper

Parameters:

name - name of db attribute

op - filte operation (i.e. "=", ">=")

value - attribute value

Throws:

EBaseException - failed to map filter