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
public abstract class CredentialItem extends Object
A credential requested from aCredentialsProvider
. 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 Classes Modifier and Type Class Description static class
CredentialItem.CharArrayType
An item whose value is stored as a char[] and is therefore clearable.static class
CredentialItem.InformationalMessage
An advice message presented to the user, with no response required.static class
CredentialItem.Password
Prompt for a password, which is masked on input.static class
CredentialItem.StringType
An item whose value is stored as a string.static class
CredentialItem.Username
Prompt for a username, which is not masked on input.static class
CredentialItem.YesNoType
An item whose value is a boolean choice, presented as Yes/No.
-
Constructor Summary
Constructors Constructor Description CredentialItem(String promptText, boolean maskValue)
Initialize a prompt.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
clear()
Clear the stored value, destroying it as much as possible.String
getPromptText()
Get prompt to display to the user.boolean
isValueSecure()
Whether the value should be masked when entered.
-
-
-
Constructor Detail
-
CredentialItem
public CredentialItem(String promptText, boolean maskValue)
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 Detail
-
getPromptText
public String 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.
-
-