Modifier and Type	Class and Description
public static enum	GpgConfig.GpgFormat Config values for gpg.format.

Modifier and Type	Field and Description
private final boolean	forceAnnotated
private final GpgConfig.GpgFormat	keyFormat
private final String	program
private final boolean	signAllTags
private final boolean	signCommits
private final String	signingKey
private final String	sshAllowedSignersFile
private final String	sshDefaultKeyCommand
private final String	sshRevocationFile

Access	Constructor and Description
public	GpgConfig(Config the config to read from config) Create a new GPG config that reads the configuration from config.

Method Summary

Modifier and Type	Method and Description
public GpgConfig.GpgFormat	Returns: the `org.eclipse.jgit.lib.GpgConfig.GpgFormat` getKeyFormat() Retrieves the config value of gpg.format.
public String	Returns: the program string configured, or `null` if none getProgram() Retrieves the value of the configured GPG program to use, as defined by gpg.openpgp.program, gpg.x509.program (depending on the defined `format`), or gpg.program.
public String	Returns: the value of user.signingKey (may be `null`) getSigningKey() Retrieves the config value of user.signingKey.
public String	Returns: the value of `gpg.ssh.allowedSignersFile` getSshAllowedSignersFile() Retrieves the value of git config `gpg.ssh.allowedSignersFile`.
public String	Returns: the value of `gpg.ssh.defaultKeyCommand` getSshDefaultKeyCommand() Retrieves the value of git config `gpg.ssh.defaultKeyCommand`.
public String	Returns: the value of `gpg.ssh.revocationFile` getSshRevocationFile() Retrieves the value of git config `gpg.ssh.revocationFile`.
public boolean	Returns: the value of `tag.gpgSign`; by default `false` isSignAllTags() Retrieves the value of git config `tag.gpgSign`.
public boolean	Returns: the value of `tag.forceSignAnnotated`; by default `false` isSignAnnotated() Retrieves the value of git config `tag.forceSignAnnotated`.
public boolean	Returns: the value of commit.gpgSign (defaults to `false`) isSignCommits() Retrieves the config value of commit.gpgSign.

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

Field Detail

forceAnnotated	back to summary
private final boolean forceAnnotated

keyFormat	back to summary
private final GpgConfig.GpgFormat keyFormat

program	back to summary
private final String program

signAllTags	back to summary
private final boolean signAllTags

signCommits	back to summary
private final boolean signCommits

signingKey	back to summary
private final String signingKey

sshAllowedSignersFile	back to summary
private final String sshAllowedSignersFile

sshDefaultKeyCommand	back to summary
private final String sshDefaultKeyCommand

sshRevocationFile	back to summary
private final String sshRevocationFile

Constructor Detail

GpgConfig	back to summary
public GpgConfig(Config config) Create a new GPG config that reads the configuration from config. Parameters config:Config the config to read from

GpgConfig

back to summary

public GpgConfig(Config config)

Create a new GPG config that reads the configuration from config.

Parameters

config:Config: the config to read from

Method Detail

getKeyFormat back to summary

getKeyFormat	back to summary
public GpgConfig.GpgFormat getKeyFormat() Retrieves the config value of gpg.format. Returns:GpgConfig.GpgFormat the `org.eclipse.jgit.lib.GpgConfig.GpgFormat`

public GpgConfig.GpgFormat getKeyFormat()

Retrieves the config value of gpg.format.

Returns:GpgConfig.GpgFormat: the org.eclipse.jgit.lib.GpgConfig.GpgFormat

getProgram back to summary

getProgram	back to summary
public String getProgram() Retrieves the value of the configured GPG program to use, as defined by gpg.openpgp.program, gpg.x509.program (depending on the defined `format`), or gpg.program. Returns:String the program string configured, or `null` if none Since 5.11

public String getProgram()

Retrieves the value of the configured GPG program to use, as defined by gpg.openpgp.program, gpg.x509.program (depending on the defined format), or gpg.program.

Returns:String: the program string configured, or null if none
Since: 5.11

getSigningKey back to summary

getSigningKey	back to summary
public String getSigningKey() Retrieves the config value of user.signingKey. Returns:String the value of user.signingKey (may be `null`)

public String getSigningKey()

Retrieves the config value of user.signingKey.

Returns:String: the value of user.signingKey (may be null)

getSshAllowedSignersFile back to summary

getSshAllowedSignersFile	back to summary
public String getSshAllowedSignersFile() Retrieves the value of git config `gpg.ssh.allowedSignersFile`. Returns:String the value of `gpg.ssh.allowedSignersFile` Since 7.1

public String getSshAllowedSignersFile()

Retrieves the value of git config gpg.ssh.allowedSignersFile.

Returns:String: the value of gpg.ssh.allowedSignersFile
Since: 7.1

getSshDefaultKeyCommand back to summary

getSshDefaultKeyCommand	back to summary
public String getSshDefaultKeyCommand() Retrieves the value of git config `gpg.ssh.defaultKeyCommand`. Returns:String the value of `gpg.ssh.defaultKeyCommand` Since 7.1

public String getSshDefaultKeyCommand()

Retrieves the value of git config gpg.ssh.defaultKeyCommand.

Returns:String: the value of gpg.ssh.defaultKeyCommand
Since: 7.1

getSshRevocationFile back to summary

getSshRevocationFile	back to summary
public String getSshRevocationFile() Retrieves the value of git config `gpg.ssh.revocationFile`. Returns:String the value of `gpg.ssh.revocationFile` Since 7.1

public String getSshRevocationFile()

Retrieves the value of git config gpg.ssh.revocationFile.

Returns:String: the value of gpg.ssh.revocationFile
Since: 7.1

isSignAllTags back to summary

isSignAllTags	back to summary
public boolean isSignAllTags() Retrieves the value of git config `tag.gpgSign`. Returns:boolean the value of `tag.gpgSign`; by default `false` Since 5.11

public boolean isSignAllTags()

Retrieves the value of git config tag.gpgSign.

Returns:boolean: the value of tag.gpgSign; by default false
Since: 5.11

isSignAnnotated back to summary

isSignAnnotated	back to summary
public boolean isSignAnnotated() Retrieves the value of git config `tag.forceSignAnnotated`. Returns:boolean the value of `tag.forceSignAnnotated`; by default `false` Since 5.11

public boolean isSignAnnotated()

Retrieves the value of git config tag.forceSignAnnotated.

Returns:boolean: the value of tag.forceSignAnnotated; by default false
Since: 5.11

isSignCommits back to summary

isSignCommits	back to summary
public boolean isSignCommits() Retrieves the config value of commit.gpgSign. Returns:boolean the value of commit.gpgSign (defaults to `false`)

public boolean isSignCommits()

Retrieves the config value of commit.gpgSign.

Returns:boolean: the value of commit.gpgSign (defaults to false)

org.eclipse.jgit.lib back to summary

public final Enum GpgConfig.GpgFormat

Class Inheritance

extends Enum<GpgConfig.GpgFormat>
implements ConfigEnum

java.lang.Object
java.lang.Enum
org.eclipse.jgit.lib.GpgConfig.GpgFormat

All Implemented Interfaces

org.eclipse.jgit.lib.Config.ConfigEnum

Config values for gpg.format.

Field Summary

Modifier and Type	Field and Description
private final String	configValue
public static final GpgConfig.GpgFormat	OPENPGP Value for openpgp
public static final GpgConfig.GpgFormat	SSH Value for ssh.
public static final GpgConfig.GpgFormat	X509 Value for x509

Constructor Summary

Access	Constructor and Description
private	GpgFormat(String configValue)

Method Summary

Modifier and Type	Method and Description
public boolean	matchConfigValue(String the string to match s) Implements org.eclipse.jgit.lib.Config.ConfigEnum.matchConfigValue. Checks if the given string matches with enum value.
public String	toConfigValue() Implements org.eclipse.jgit.lib.Config.ConfigEnum.toConfigValue. Converts enumeration value into a string to be save in config.
public static GpgConfig.GpgFormat	valueOf(String name)
public static GpgConfig.GpgFormat[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

configValue	back to summary
private final String configValue

OPENPGP	back to summary
public static final GpgConfig.GpgFormat OPENPGP Value for openpgp

SSH	back to summary
public static final GpgConfig.GpgFormat SSH Value for ssh. Since 7.0

SSH

back to summary

public static final GpgConfig.GpgFormat SSH

Value for ssh.

Since: 7.0

X509	back to summary
public static final GpgConfig.GpgFormat X509 Value for x509

Constructor Detail

GpgFormat	back to summary
private GpgFormat(String configValue)

Method Detail

matchConfigValue	back to summary
public boolean matchConfigValue(String s) Implements org.eclipse.jgit.lib.Config.ConfigEnum.matchConfigValue. Doc from org.eclipse.jgit.lib.Config.ConfigEnum.matchConfigValue. Checks if the given string matches with enum value. Parameters s:String the string to match Returns:boolean true if the given string matches enum value, false otherwise Annotations @Override

matchConfigValue

back to summary

public boolean matchConfigValue(String s)

Implements org.eclipse.jgit.lib.Config.ConfigEnum.matchConfigValue.

Doc from org.eclipse.jgit.lib.Config.ConfigEnum.matchConfigValue.

Checks if the given string matches with enum value.

Parameters

s:String: the string to match

Returns:boolean

true if the given string matches enum value, false otherwise

Annotations

@Override

toConfigValue	back to summary
public String toConfigValue() Implements org.eclipse.jgit.lib.Config.ConfigEnum.toConfigValue. Doc from org.eclipse.jgit.lib.Config.ConfigEnum.toConfigValue. Converts enumeration value into a string to be save in config. Returns:String the enum value as config string Annotations @Override

toConfigValue

back to summary

public String toConfigValue()

Implements org.eclipse.jgit.lib.Config.ConfigEnum.toConfigValue.

Doc from org.eclipse.jgit.lib.Config.ConfigEnum.toConfigValue.

Converts enumeration value into a string to be save in config.

Returns:String

the enum value as config string

Annotations

@Override

valueOf	back to summary
public static GpgConfig.GpgFormat valueOf(String name)

values	back to summary
public static GpgConfig.GpgFormat[] values()

public Class GpgConfig

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum GpgConfig.GpgFormat

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail