Package org.eclipse.jgit.lib

Class GpgConfig

java.lang.Object

org.eclipse.jgit.lib.GpgConfig

public class GpgConfig
extends Object

Typed access to GPG related configuration options.

Since:

5.2

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
GpgConfig(String keySpec, GpgConfig.GpgFormat format, String gpgProgram)	Create a GpgConfig with the given parameters and default true for signing commits and false for tags.
GpgConfig(Config config)	Create a new GPG config that reads the configuration from config.

Method Summary

Modifier and Type	Method	Description
GpgConfig.GpgFormat	getKeyFormat()	Retrieves the config value of gpg.format.
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.
String	getSigningKey()	Retrieves the config value of user.signingKey.
boolean	isSignAllTags()	Retrieves the value of git config tag.gpgSign.
boolean	isSignAnnotated()	Retrieves the value of git config tag.forceSignAnnotated.
boolean	isSignCommits()	Retrieves the config value of commit.gpgSign.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GpgConfig

public GpgConfig(String keySpec,
                 GpgConfig.GpgFormat format,
                 String gpgProgram)

Create a GpgConfig with the given parameters and default true for signing commits and false for tags.

Parameters:

keySpec - to use

format - to use

gpgProgram - to use

Since:

5.11

GpgConfig

public GpgConfig(Config config)

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

Parameters:

config - the config to read from

Method Detail

getKeyFormat

public GpgConfig.GpgFormat getKeyFormat()

Retrieves the config value of gpg.format.

Returns:

the GpgConfig.GpgFormat

getProgram

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:

the program string configured, or null if none

Since:

5.11

getSigningKey

public String getSigningKey()

Retrieves the config value of user.signingKey.

Returns:

the value of user.signingKey (may be null)

isSignCommits

public boolean isSignCommits()

Retrieves the config value of commit.gpgSign.

Returns:

the value of commit.gpgSign (defaults to false)

isSignAllTags

public boolean isSignAllTags()

Retrieves the value of git config tag.gpgSign.

Returns:

the value of tag.gpgSign; by default false

Since:

5.11

isSignAnnotated

public boolean isSignAnnotated()

Retrieves the value of git config tag.forceSignAnnotated.

Returns:

the value of tag.forceSignAnnotated; by default false

Since:

5.11