JGit 7.2.0.202503040940-r · org.eclipse.jgit.transport.CredentialsProvider

Modifier and Type	Field and Description
private static volatile CredentialsProvider	defaultProvider

Access	Constructor and Description
public	CredentialsProvider()

Method Summary

Modifier and Type	Method and Description
public abstract boolean	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. get(URIish the URI of the remote resource that needs authentication. uri, CredentialItem... the items the application requires to complete authentication. items) Ask for the credential items to be populated.
public boolean	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. get(URIish the URI of the remote resource that needs authentication. uri, List<CredentialItem> the items the application requires to complete authentication. items) Ask for the credential items to be populated.
public static CredentialsProvider	Returns: the default credentials provider, or null. getDefault() Get the default credentials provider, or null.
protected static boolean	Returns: `true` if any of the passed items is null, `false` otherwise isAnyNull(CredentialItem... credential items to check items) Whether any of the passed items is null
public abstract boolean	Returns: `true` if the provider is interactive with the end-user. isInteractive() Check if the provider is interactive with the end-user.
public void	reset(URIish a `org.eclipse.jgit.transport.URIish` object. uri) Reset the credentials provider for the given URI
public static void	setDefault(CredentialsProvider the new default provider, may be null to select no default. p) Set the default credentials provider.
public abstract boolean	Returns: `true` if this `org.eclipse.jgit.transport.CredentialsProvider` supports all of the items supplied. supports(CredentialItem... the items the application requires to complete authentication. items) Check if the provider can supply the necessary `org.eclipse.jgit.transport.CredentialItem`s.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

defaultProvider	back to summary
private static volatile CredentialsProvider defaultProvider

CredentialsProvider	back to summary
public CredentialsProvider()

Method Detail

get back to summary

get	back to summary
public abstract boolean get(URIish uri, CredentialItem... items) throws UnsupportedCredentialItem Ask for the credential items to be populated. Parameters uri:URIish the URI of the remote resource that needs authentication. items:CredentialItem[] the items the application requires to complete authentication. Returns:boolean `true` if the request was successful and values were supplied; `false` if the user canceled the request and did not supply all requested values. Exceptions UnsupportedCredentialItem: if one of the items supplied is not supported.

public abstract boolean get(URIish uri, CredentialItem... items) throws UnsupportedCredentialItem

Ask for the credential items to be populated.

Parameters

uri:URIish: the URI of the remote resource that needs authentication.
items:CredentialItem[]: the items the application requires to complete authentication.

Returns:boolean

true if the request was successful and values were supplied; false if the user canceled the request and did not supply all requested values.

Exceptions

UnsupportedCredentialItem:: if one of the items supplied is not supported.

get back to summary

get	back to summary
public boolean get(URIish uri, List<CredentialItem> items) throws UnsupportedCredentialItem Ask for the credential items to be populated. Parameters uri:URIish the URI of the remote resource that needs authentication. items:List<CredentialItem> the items the application requires to complete authentication. Returns:boolean `true` if the request was successful and values were supplied; `false` if the user canceled the request and did not supply all requested values. Exceptions UnsupportedCredentialItem: if one of the items supplied is not supported.

public boolean get(URIish uri, List<CredentialItem> items) throws UnsupportedCredentialItem

Ask for the credential items to be populated.

Parameters

uri:URIish: the URI of the remote resource that needs authentication.
items:List<CredentialItem>: the items the application requires to complete authentication.

Returns:boolean

true if the request was successful and values were supplied; false if the user canceled the request and did not supply all requested values.

Exceptions

UnsupportedCredentialItem:: if one of the items supplied is not supported.

getDefault	back to summary
public static CredentialsProvider getDefault() Get the default credentials provider, or null. Returns:CredentialsProvider the default credentials provider, or null.

getDefault

back to summary

public static CredentialsProvider getDefault()

Get the default credentials provider, or null.

Returns:CredentialsProvider: the default credentials provider, or null.

isAnyNull back to summary

isAnyNull	back to summary
protected static boolean isAnyNull(CredentialItem... items) Whether any of the passed items is null Parameters items:CredentialItem[] credential items to check Returns:boolean `true` if any of the passed items is null, `false` otherwise Since 4.2

protected static boolean isAnyNull(CredentialItem... items)

Whether any of the passed items is null

Parameters

items:CredentialItem[]: credential items to check

Returns:boolean

true if any of the passed items is null, false otherwise

Since

4.2

isInteractive back to summary

isInteractive	back to summary
public abstract 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. Returns:boolean `true` if the provider is interactive with the end-user.

public abstract 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.

Returns:boolean: true if the provider is interactive with the end-user.

reset back to summary

reset	back to summary
public void reset(URIish uri) Reset the credentials provider for the given URI Parameters uri:URIish a `org.eclipse.jgit.transport.URIish` object.

public void reset(URIish uri)

Reset the credentials provider for the given URI

Parameters

uri:URIish: a org.eclipse.jgit.transport.URIish object.

setDefault	back to summary
public static void setDefault(CredentialsProvider p) Set the default credentials provider. Parameters p:CredentialsProvider the new default provider, may be null to select no default.

setDefault

back to summary

public static void setDefault(CredentialsProvider p)

Set the default credentials provider.

Parameters

p:CredentialsProvider: the new default provider, may be null to select no default.

supports back to summary

supports	back to summary
public abstract boolean supports(CredentialItem... items) Check if the provider can supply the necessary `org.eclipse.jgit.transport.CredentialItem`s. Parameters items:CredentialItem[] the items the application requires to complete authentication. Returns:boolean `true` if this `org.eclipse.jgit.transport.CredentialsProvider` supports all of the items supplied.

public abstract boolean supports(CredentialItem... items)

Check if the provider can supply the necessary org.eclipse.jgit.transport.CredentialItems.

Parameters

items:CredentialItem[]: the items the application requires to complete authentication.

Returns:boolean

true if this org.eclipse.jgit.transport.CredentialsProvider supports all of the items supplied.

public abstract Class CredentialsProvider

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail