Class DBAttrMapper

java.lang.Object
com.netscape.certsrv.dbs.DBAttrMapper
Direct Known Subclasses:
BigIntegerMapper, ByteArrayMapper, DateArrayMapper, DateMapper, DBDynAttrMapper, IntegerMapper, KeyStateMapper, LongMapper, MetaInfoMapper, ObjectStreamMapper, PublicKeyMapper, RequestAttrsMapper, RequestIdMapper, RequestStateMapper, RevocationInfoMapper, StringMapper, StringVectorMapper, X500NameMapper, X509CertImplMapper

public abstract class DBAttrMapper extends Object
A class represents an attribute mapper. A mapper has knowledge on how to convert a db attribute into zero or more LDAP attribute, and vice versa.

Version:
$Revision$, $Date$
  • Constructor Details

    • DBAttrMapper

      public DBAttrMapper()
  • Method Details

    • getSupportedLDAPAttributeNames

      public abstract Enumeration<String> getSupportedLDAPAttributeNames()
      Retrieves a list of LDAP attributes that are used in the mapper. By having this, the framework can provide search on selective attributes.
      Returns:
      a list of supported attribute names
    • mapObjectToLDAPAttributeSet

      public abstract void mapObjectToLDAPAttributeSet(IDBObj parent, String name, Object obj, netscape.ldap.LDAPAttributeSet attrs) throws EBaseException
      Maps object attribute into LDAP attributes.
      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 abstract void mapLDAPAttributeSetToObject(netscape.ldap.LDAPAttributeSet attrs, String name, IDBObj parent) throws EBaseException
      Maps LDAP attributes into object, and puts the object into 'parent'.
      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 abstract String mapSearchFilter(String name, String op, String value) throws EBaseException
      Maps search filters into LDAP search filter.
      Parameters:
      name - name of db attribute
      op - filte operation (i.e. "=", ">=")
      value - attribute value
      Throws:
      EBaseException - failed to map filter