Package org.eclipse.jgit.transport
Class CredentialItem
java.lang.Object
org.eclipse.jgit.transport.CredentialItem
- Direct Known Subclasses:
CredentialItem.CharArrayType
,CredentialItem.InformationalMessage
,CredentialItem.StringType
,CredentialItem.YesNoType
A credential requested from a
CredentialsProvider
.
Most users should work with the specialized subclasses:
CredentialItem.Username
for usernamesCredentialItem.Password
for passwordsCredentialItem.StringType
for other general string informationCredentialItem.CharArrayType
for other general secret information
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
An item whose value is stored as a char[] and is therefore clearable.static class
An advice message presented to the user, with no response required.static class
Prompt for a password, which is masked on input.static class
An item whose value is stored as a string.static class
Prompt for a username, which is not masked on input.static class
An item whose value is a boolean choice, presented as Yes/No. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract void
clear()
Clear the stored value, destroying it as much as possible.Get prompt to display to the user.boolean
Whether the value should be masked when entered.
-
Field Details
-
promptText
-
valueSecure
private final boolean valueSecure
-
-
Constructor Details
-
CredentialItem
Initialize a prompt.- Parameters:
promptText
- prompt to display to the user alongside of the input field. Should be sufficient text to indicate what to supply for this item.maskValue
- true if the value should be masked from displaying during input. This should be true for passwords and other secrets, false for names and other public data.
-
-
Method Details
-
getPromptText
Get prompt to display to the user.- Returns:
- prompt to display to the user.
-
isValueSecure
public boolean isValueSecure()Whether the value should be masked when entered.- Returns:
- true if the value should be masked when entered.
-
clear
public abstract void clear()Clear the stored value, destroying it as much as possible.
-