Class NetRCCredentialsProvider

java.lang.Object
org.eclipse.jgit.transport.CredentialsProvider
org.eclipse.jgit.transport.NetRCCredentialsProvider

public class NetRCCredentialsProvider extends CredentialsProvider
Simple .netrc credentials provider. It can lookup the first machine entry from your .netrc file.
Since:
3.5
  • Field Details

  • Constructor Details

    • NetRCCredentialsProvider

      public NetRCCredentialsProvider()

      Constructor for NetRCCredentialsProvider.

  • Method Details

    • install

      public static void install()
      Install default provider for the .netrc parser.
    • supports

      public boolean supports(CredentialItem... items)
      Check if the provider can supply the necessary CredentialItems.
      Specified by:
      supports in class CredentialsProvider
      Parameters:
      items - the items the application requires to complete authentication.
      Returns:
      true if this CredentialsProvider supports all of the items supplied.
    • 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.
    • 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.