Package com.zerog.ia.auto.project.console

Class GetPasswordConsole

  • All Implemented Interfaces:
    Referenceable
    public final class GetPasswordConsole
extends Action
    The panel allows developers to request a password from the end user.

    The password can be validate against a list passwords. To define the list of valid password set the passwordFile property, which expects a text file separated by the line ending character (\n).

    • Constructor Detail

      • GetPasswordConsole

        public GetPasswordConsole()

    • Method Detail

      • setTitle

        public void setTitle​(java.lang.String title)
        Defines the title of the panel. Default is "Enter Password".

      • getTitle

        public java.lang.String getTitle()
        Returns the title of the panel.

      • setPrompt

        public void setPrompt​(java.lang.String prompt)
        Defines the panel's prompt to display. Default is "Please Enter the Password:".

      • getPrompt

        public java.lang.String getPrompt()
        Returns the panel's prompt to display.

      • setInstructions

        public void setInstructions​(java.lang.String instructions)
        Defines the panel instructions to display. Default is "This installation requires a password to continue."

      • getInstructions

        public java.lang.String getInstructions()
        Returns the panel instructions to display.

      • setPasswordResultVar

        public void setPasswordResultVar​(java.lang.String variable)
        Defines the name of the variable where to store the entered password. Default is $USER_SUPPLIED_PASSWORD$.

      • getPasswordResultVar

        public java.lang.String getPasswordResultVar()
        Returns the name of the variable where to store the entered password.

      • setMatchingIndexResultVar

        public void setMatchingIndexResultVar​(java.lang.String matchingIndex)
        Defines the name of the variable where to store the index of the matching password. The panels matches the password with the list of passwords defined in the passwordFile property. The index starts from 1.

      • getMatchingIndexResultVar

        public java.lang.String getMatchingIndexResultVar()
        Returns the name of the variable where to store the index of the matching password.

      • setPasswordsList

        public void setPasswordsList​(java.util.Vector<java.lang.String> pl)
        Set the password list.

      • getPasswordsList

        public java.util.Vector<java.lang.String> getPasswordsList()
        Get the password list.

      • setAllowBlankInput

        public void setAllowBlankInput​(boolean allowBlank)
        Whether or not the allow password to be left blank.

      • getAllowBlankInput

        public boolean getAllowBlankInput()
        Whether or not the allow password to be left blank.

      • getValidatePassword

        public boolean getValidatePassword()
        Whether or not to validate the password against the list of valid password.
        See Also:
        setPasswordFile(java.lang.String)

      • setValidatePassword

        public void setValidatePassword​(boolean validatePassword)
        Whether or not to validate the password against the list of valid password.

      • setPasswordFile

        public void setPasswordFile​(java.lang.String path)
        The text file which contains the list of valid passwords. The passwords should be separated by new line ( ).

      • getPasswordFile

        public java.lang.String getPasswordFile()
        The text file which contains the list of valid passwords. The passwords should be separated by new line ( ).