Package com.netscape.cmscore.request

Class 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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Enumeration<java.lang.String> getSupportedLDAPAttributeNames()
      Retrieves a list of LDAP attributes that are used in the mapper.
      void mapLDAPAttributeSetToObject​(netscape.ldap.LDAPAttributeSet attrs, java.lang.String name, IDBObj parent)
      Maps LDAP attributes into object, and puts the object into 'parent'.
      void mapObjectToLDAPAttributeSet​(IDBObj parent, java.lang.String name, java.lang.Object obj, netscape.ldap.LDAPAttributeSet attrs)
      Maps object attribute into LDAP attributes.
      java.lang.String mapSearchFilter​(java.lang.String name, java.lang.String op, java.lang.String value)
      Maps search filters into LDAP search filter.
      boolean supportsLDAPAttributeName​(java.lang.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 Detail

      • DBDynAttrMapper

        public DBDynAttrMapper()

    • Method Detail

      • supportsLDAPAttributeName

        public boolean supportsLDAPAttributeName​(java.lang.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 java.util.Enumeration<java.lang.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,
                                        java.lang.String name,
                                        java.lang.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,
                                        java.lang.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 java.lang.String mapSearchFilter​(java.lang.String name,
                                        java.lang.String op,
                                        java.lang.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