Class AttributePresentConstraints

  • All Implemented Interfaces:
    IExtendedPluginInfo, com.netscape.certsrv.request.IPolicy, org.dogtagpki.legacy.policy.IEnrollmentPolicy, org.dogtagpki.legacy.policy.IPolicyRule

    public class AttributePresentConstraints
    extends APolicyRule
    implements org.dogtagpki.legacy.policy.IEnrollmentPolicy, IExtendedPluginInfo
    This checks if attribute present.

     NOTE:  The Policy Framework has been replaced by the Profile Framework.
     

    Version:
    $Revision$, $Date$
    • Field Detail

      • logger

        public static org.slf4j.Logger logger
      • mName

        protected java.lang.String mName
      • mImplName

        protected java.lang.String mImplName
      • DEF_LDAP_PORT

        protected static final java.lang.Integer DEF_LDAP_PORT
      • DEF_LDAP_SSL

        protected static final java.lang.Boolean DEF_LDAP_SSL
      • DEF_LDAP_VER

        protected static final java.lang.Integer DEF_LDAP_VER
      • DEF_LDAP_MINC

        protected static final java.lang.Integer DEF_LDAP_MINC
      • DEF_LDAP_MAXC

        protected static final java.lang.Integer DEF_LDAP_MAXC
      • mParamNames

        protected static java.util.Vector<java.lang.String> mParamNames
      • mParamDefault

        protected static java.util.Hashtable<java.lang.String,​java.lang.Object> mParamDefault
      • mParamValue

        protected java.util.Hashtable<java.lang.String,​java.lang.Object> mParamValue
    • Constructor Detail

      • AttributePresentConstraints

        public AttributePresentConstraints()
    • Method Detail

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

        public java.lang.String getName()
        Description copied from class: APolicyRule
        Returns the name of the policy rule.

        Specified by:
        getName in interface org.dogtagpki.legacy.policy.IPolicyRule
        Overrides:
        getName in class APolicyRule
        Returns:
        The name of the policy class.
      • getImplName

        public java.lang.String getImplName()
      • shutdown

        public void shutdown()
      • addParam

        protected static void addParam​(java.lang.String name,
                                       java.lang.Object value)
      • getStringConfigParam

        protected void getStringConfigParam​(IConfigStore config,
                                            java.lang.String paramName)
      • getIntConfigParam

        protected void getIntConfigParam​(IConfigStore config,
                                         java.lang.String paramName)
      • getBooleanConfigParam

        protected void getBooleanConfigParam​(IConfigStore config,
                                             java.lang.String paramName)
      • init

        public void init​(org.dogtagpki.legacy.policy.IPolicyProcessor owner,
                         IConfigStore config)
                  throws EBaseException
        Description copied from class: APolicyRule
        Initializes the policy rule.

        Specified by:
        init in interface org.dogtagpki.legacy.policy.IPolicyRule
        Specified by:
        init in class APolicyRule
        config - The config store reference
        Throws:
        EBaseException
      • apply

        public com.netscape.certsrv.request.PolicyResult apply​(com.netscape.certsrv.request.IRequest r)
        Description copied from class: APolicyRule
        Applies the policy on the given Request.

        Specified by:
        apply in interface com.netscape.certsrv.request.IPolicy
        Specified by:
        apply in interface org.dogtagpki.legacy.policy.IPolicyRule
        Specified by:
        apply in class APolicyRule
        Parameters:
        r - The request on which to apply policy.
        Returns:
        The policy result object.
      • getInstanceParams

        public java.util.Vector<java.lang.String> getInstanceParams()
        Description copied from class: APolicyRule
        Return configured parameters for a policy rule instance.
        Specified by:
        getInstanceParams in interface org.dogtagpki.legacy.policy.IPolicyRule
        Specified by:
        getInstanceParams in class APolicyRule
        Returns:
        nvPairs A Vector of name/value pairs.
      • getDefaultParams

        public java.util.Vector<java.lang.String> getDefaultParams()
        Description copied from class: APolicyRule
        Return default parameters for a policy implementation.
        Specified by:
        getDefaultParams in interface org.dogtagpki.legacy.policy.IPolicyRule
        Specified by:
        getDefaultParams in class APolicyRule
        Returns:
        nvPairs A Vector of name/value pairs.