Class ConsoleCredentialsProvider


  • public class ConsoleCredentialsProvider
    extends CredentialsProvider
    Interacts with the user during authentication by using the text console.
    Since:
    4.0
    • Constructor Detail

      • ConsoleCredentialsProvider

        public ConsoleCredentialsProvider()
    • Method Detail

      • install

        public static void install()
        Install this implementation as the default.
      • isInteractive

        public boolean isInteractive()
        Check if the provider is interactive with the end-user. An interactive provider may try to open a dialog box, or prompt for input on the terminal, and will wait for a user response. A non-interactive provider will either populate CredentialItems, or fail.
        Specified by:
        isInteractive in class CredentialsProvider
        Returns:
        true if the provider is interactive with the end-user.
      • get

        public boolean get​(URIish uri,
                           CredentialItem... items)
                    throws UnsupportedCredentialItem
        Ask for the credential items to be populated.
        Specified by:
        get in class CredentialsProvider
        Parameters:
        uri - the URI of the remote resource that needs authentication.
        items - the items the application requires to complete authentication.
        Returns:
        true if the request was successful and values were supplied; false if the user canceled the request and did not supply all requested values.
        Throws:
        UnsupportedCredentialItem - if one of the items supplied is not supported.