Class LdapCertSubjMap

    • Constructor Summary

      Constructors 
      Constructor Description
      LdapCertSubjMap()  
      LdapCertSubjMap​(java.lang.String searchBase)
      constructs a certificate subject name mapper with search base.
      LdapCertSubjMap​(java.lang.String searchBase, java.lang.String certSubjNameAttr, java.lang.String certAttr)
      Constructor using non-ES cert map attribute name.
      LdapCertSubjMap​(java.lang.String searchBase, java.lang.String certSubjNameAttr, java.lang.String certAttr, boolean useAllEntries)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCertSubjNameAttr()
      return certificate subject attribute
      IConfigStore getConfigStore()
      Return config store.
      java.util.Vector<java.lang.String> getDefaultParams()
      Returns the initial default parameters.
      java.lang.String getDescription()
      Returns the description of this mapper.
      java.lang.String[] getExtendedPluginInfo​(java.util.Locale locale)
      This method returns an array of strings.
      java.lang.String getImplName()
      Returns implementation name.
      java.util.Vector<java.lang.String> getInstanceParams()
      Returns the current instance parameters.
      java.lang.String getSearchBase()
      return search base
      void init​(IConfigStore config)
      Initialize from config store.
      java.lang.String map​(netscape.ldap.LDAPConnection conn, IRequest req, java.lang.Object obj)
      maps a certificate to a LDAP entry.
      java.lang.String map​(netscape.ldap.LDAPConnection conn, java.lang.Object obj)
      Finds the entry for the certificate by looking for the cert subject name in the subject name attribute.
      java.util.Vector<java.lang.String> mapAll​(netscape.ldap.LDAPConnection conn, IRequest req, java.lang.Object obj)  
      java.util.Vector<java.lang.String> mapAll​(netscape.ldap.LDAPConnection conn, java.lang.Object obj)  
      boolean useAllEntries()  
      • 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
      • LDAP_CERTSUBJNAME_ATTR

        public static final java.lang.String LDAP_CERTSUBJNAME_ATTR
        See Also:
        Constant Field Values
      • mSearchBase

        protected java.lang.String mSearchBase
      • mCertSubjNameAttr

        protected java.lang.String mCertSubjNameAttr
      • mUseAllEntries

        protected boolean mUseAllEntries
    • Constructor Detail

      • LdapCertSubjMap

        public LdapCertSubjMap()
      • LdapCertSubjMap

        public LdapCertSubjMap​(java.lang.String searchBase)
        constructs a certificate subject name mapper with search base.
        Parameters:
        searchBase - the dn to start searching for the certificate subject name.
      • LdapCertSubjMap

        public LdapCertSubjMap​(java.lang.String searchBase,
                               java.lang.String certSubjNameAttr,
                               java.lang.String certAttr)
        Constructor using non-ES cert map attribute name.
        Parameters:
        searchBase - entry to start search.
        certSubjNameAttr - attribute for certificate subject names.
        certAttr - attribute to find certificate.
      • LdapCertSubjMap

        public LdapCertSubjMap​(java.lang.String searchBase,
                               java.lang.String certSubjNameAttr,
                               java.lang.String certAttr,
                               boolean useAllEntries)
    • Method Detail

      • getImplName

        public java.lang.String getImplName()
        Description copied from interface: ILdapMapper
        Returns implementation name.
        Specified by:
        getImplName in interface ILdapMapper
      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: ILdapMapper
        Returns the description of this mapper.
        Specified by:
        getDescription in interface ILdapMapper
      • getDefaultParams

        public java.util.Vector<java.lang.String> getDefaultParams()
        Description copied from interface: ILdapMapper
        Returns the initial default parameters.
        Specified by:
        getDefaultParams in interface ILdapMapper
      • getExtendedPluginInfo

        public java.lang.String[] getExtendedPluginInfo​(java.util.Locale locale)
        Description copied from interface: IExtendedPluginInfo
        This method returns an array of strings. Each element of the array represents a configurable parameter, or some other meta-info (such as help-token) there is an entry indexed on that parameter name Where: type_info is either 'string', 'number', 'boolean', 'password' or 'choice(ch1,ch2,ch3,...)' If the marker 'required' is included after the type_info, the parameter will has some visually distinctive marking in the UI. 'description' is a short sentence describing the parameter 'choice' is rendered as a drop-down list. The first parameter in the list will be activated by default 'boolean' is rendered as a checkbox. The resulting parameter will be either 'true' or 'false' 'string' allows any characters 'number' allows only numbers 'password' is rendered as a password field (the characters are replaced with *'s when being types. This parameter is not passed through to the plugin. It is instead inserted directly into the password cache keyed on the instance name. The value of the parameter 'bindPWPrompt' (see example below) is set to the key. In addition to the configurable parameters, the following magic parameters may be defined: HELP_TOKEN;helptoken - a pointer to the online manual section for this plugin HELP_TEXT;helptext - a general help string describing the plugin For example: "username;string;The username you wish to login as" "bindPWPrompt;password;Enter password to bind as above user with" "algorithm;choice(RSA,DSA);Which algorithm do you want to use" "enable;boolean;Do you want to run this plugin" "port;number;Which port number do you want to use"
        Specified by:
        getExtendedPluginInfo in interface IExtendedPluginInfo
      • getInstanceParams

        public java.util.Vector<java.lang.String> getInstanceParams()
        Description copied from interface: ILdapMapper
        Returns the current instance parameters.
        Specified by:
        getInstanceParams in interface ILdapMapper
      • map

        public java.lang.String map​(netscape.ldap.LDAPConnection conn,
                                    java.lang.Object obj)
                             throws ELdapException
        Finds the entry for the certificate by looking for the cert subject name in the subject name attribute.
        Specified by:
        map in interface ILdapMapper
        Parameters:
        conn - - the LDAP connection.
        obj - - the X509Certificate.
        Returns:
        dn indicates whether a mapping was successful
        Throws:
        ELdapException - Map operation failed.
      • map

        public java.lang.String map​(netscape.ldap.LDAPConnection conn,
                                    IRequest req,
                                    java.lang.Object obj)
                             throws ELdapException
        Description copied from interface: ILdapMapper
        maps a certificate to a LDAP entry. returns dn of the mapped LDAP entry.
        Specified by:
        map in interface ILdapMapper
        Parameters:
        conn - the LDAP connection
        req - the request to map
        obj - the object to map
        Returns:
        dn indicates whether a mapping was successful
        Throws:
        ELdapException - Map operation failed.
      • mapAll

        public java.util.Vector<java.lang.String> mapAll​(netscape.ldap.LDAPConnection conn,
                                                         java.lang.Object obj)
                                                  throws ELdapException
        Throws:
        ELdapException
      • mapAll

        public java.util.Vector<java.lang.String> mapAll​(netscape.ldap.LDAPConnection conn,
                                                         IRequest req,
                                                         java.lang.Object obj)
                                                  throws ELdapException
        Throws:
        ELdapException
      • getSearchBase

        public java.lang.String getSearchBase()
        return search base
      • getCertSubjNameAttr

        public java.lang.String getCertSubjNameAttr()
        return certificate subject attribute
      • useAllEntries

        public boolean useAllEntries()