Package com.netscape.cmscore.request

Class RequestStateMapper

  • All Implemented Interfaces:
    IDBAttrMapper
    public class RequestStateMapper
extends java.lang.Object
implements IDBAttrMapper
    A mapper between an request state object and its LDAP attribute representation

    Version:
    $Revision$ $Date$
    Author:
    thayes

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static org.slf4j.Logger logger  
      protected static java.util.Vector<java.lang.String> mAttrs  

    • 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.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • logger

        public static org.slf4j.Logger logger

      • mAttrs

        protected static final java.util.Vector<java.lang.String> mAttrs

    • Constructor Detail

      • RequestStateMapper

        public RequestStateMapper()

    • Method Detail

      • getSupportedLDAPAttributeNames

        public java.util.Enumeration<java.lang.String> getSupportedLDAPAttributeNames()
        Description copied from interface: IDBAttrMapper
        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 interface IDBAttrMapper
        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 interface: IDBAttrMapper
        Maps object attribute into LDAP attributes.
        Specified by:
        mapObjectToLDAPAttributeSet in interface IDBAttrMapper
        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 interface: IDBAttrMapper
        Maps LDAP attributes into object, and puts the object into 'parent'.
        Specified by:
        mapLDAPAttributeSetToObject in interface IDBAttrMapper
        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)
        Description copied from interface: IDBAttrMapper
        Maps search filters into LDAP search filter.
        Specified by:
        mapSearchFilter in interface IDBAttrMapper
        Parameters:
        name - name of db attribute
        op - filte operation (i.e. "=", ">=")
        value - attribute value