Class PortalEnroll

    • Constructor Detail

    • Method Detail

      • init

        public void init​(java.lang.String name,
                         java.lang.String implName,
                         IConfigStore config)
                  throws EBaseException
        Initializes the PortalEnrollment auth manager.

        Specified by:
        init in interface IAuthManager
        Overrides:
        init in class DirBasedAuthentication
        Parameters:
        name - - The name for this authentication manager instance.
        implName - - The name of the authentication manager plugin.
        config - - The configuration store for this instance.
        Throws:
        EBaseException - If an error occurs during initialization.
      • getConfigParams

        public java.lang.String[] getConfigParams()
        Returns a list of configuration parameter names. The list is passed to the configuration console so instances of this implementation can be configured through the console.
        Specified by:
        getConfigParams in interface IAuthManager
        Specified by:
        getConfigParams in class DirBasedAuthentication
        Returns:
        String array of configuration parameter names.
      • 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 ;[,required];;... 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
        Overrides:
        getExtendedPluginInfo in class DirBasedAuthentication
      • regist

        public java.lang.String regist​(AuthToken token,
                                       java.lang.String uid)
        adds a user to the directory.
        Parameters:
        token - authentication token
        uid - the user's id.
        Returns:
        dn upon success and null upon failure.
      • initLdapAttrs

        public void initLdapAttrs​(netscape.ldap.LDAPSchema dirSchema,
                                  java.lang.String oclass)