Class DBAttrMapper

    • Constructor Summary

      Constructors 
      Constructor Description
      DBAttrMapper()  
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract java.util.Enumeration<java.lang.String> getSupportedLDAPAttributeNames()
      Retrieves a list of LDAP attributes that are used in the mapper.
      abstract void mapLDAPAttributeSetToObject​(netscape.ldap.LDAPAttributeSet attrs, java.lang.String name, IDBObj parent)
      Maps LDAP attributes into object, and puts the object into 'parent'.
      abstract void mapObjectToLDAPAttributeSet​(IDBObj parent, java.lang.String name, java.lang.Object obj, netscape.ldap.LDAPAttributeSet attrs)
      Maps object attribute into LDAP attributes.
      abstract java.lang.String mapSearchFilter​(java.lang.String name, java.lang.String op, java.lang.String value)
      Maps search filters into LDAP search filter.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DBAttrMapper

        public DBAttrMapper()
    • Method Detail

      • getSupportedLDAPAttributeNames

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