org.eclipse.jgit.api

Class VerifySignatureCommand

java.lang.Object

org.eclipse.jgit.api.GitCommand<Map<String,VerificationResult>>

org.eclipse.jgit.api.VerifySignatureCommand

All Implemented Interfaces:

Callable<Map<String,VerificationResult>>

public class VerifySignatureCommand
extends GitCommand<Map<String,VerificationResult>>

A command to verify GPG signatures on tags or commits.

Since:

5.11

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VerifySignatureCommand.VerifyMode Describes what kind of objects shall be handled by a VerifySignatureCommand.

Field Summary

Fields inherited from class org.eclipse.jgit.api.GitCommand

repo

Constructor Summary

Constructors

Constructor and Description
VerifySignatureCommand(Repository repo) Creates a new VerifySignatureCommand for the given Repository.

Method Summary

Modifier and Type	Method and Description
VerifySignatureCommand	addName(String name) Add a name of an object (SHA-1, ref name; anything that can be resolved) to the command to have its signature verified.
VerifySignatureCommand	addNames(Collection<String> names) Add names of objects (SHA-1, ref name; anything that can be resolved) to the command to have their signatures verified.
VerifySignatureCommand	addNames(String... names) Add names of objects (SHA-1, ref name; anything that can be resolved) to the command to have their signatures verified.
Map<String,VerificationResult>	call() Resolves all names added to the command to git objects and verifies their signature.
GpgSignatureVerifier	getVerifier() Retrieves the currently set GpgSignatureVerifier.
VerifySignatureCommand	setGpgConfig(GpgConfig config) Sets an external GpgConfig to use.
VerifySignatureCommand	setMode(VerifySignatureCommand.VerifyMode mode) Sets the mode of operation for this command.
VerifySignatureCommand	setVerifier(GpgSignatureVerifier verifier) Sets the GpgSignatureVerifier to use.

Methods inherited from class org.eclipse.jgit.api.GitCommand

checkCallable, getRepository, setCallable

Methods inherited from class java.lang.Object

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

Constructor Detail

VerifySignatureCommand

public VerifySignatureCommand(Repository repo)

Creates a new VerifySignatureCommand for the given Repository.

Parameters:

repo - to operate on

Method Detail

addName

public VerifySignatureCommand addName(String name)

Add a name of an object (SHA-1, ref name; anything that can be resolved) to the command to have its signature verified.

Parameters:

name - to add

Returns:

this

addNames

public VerifySignatureCommand addNames(String... names)

Add names of objects (SHA-1, ref name; anything that can be resolved) to the command to have their signatures verified.

Parameters:

names - to add; duplicates will be ignored

Returns:

this

addNames

public VerifySignatureCommand addNames(Collection<String> names)

Add names of objects (SHA-1, ref name; anything that can be resolved) to the command to have their signatures verified.

Parameters:

names - to add; duplicates will be ignored

Returns:

this

setMode

public VerifySignatureCommand setMode(@NonNull
                                      VerifySignatureCommand.VerifyMode mode)

Sets the mode of operation for this command.

Parameters:

mode - the VerifySignatureCommand.VerifyMode to set

Returns:

this

setVerifier

public VerifySignatureCommand setVerifier(GpgSignatureVerifier verifier)

Sets the GpgSignatureVerifier to use.

Parameters:

verifier - the GpgSignatureVerifier to use, or null to use the default verifier

Returns:

this

setGpgConfig

public VerifySignatureCommand setGpgConfig(GpgConfig config)

Sets an external GpgConfig to use. Whether it will be used it at the discretion of the setVerifier(GpgSignatureVerifier).

Parameters:

config - to set; if null, the config will be loaded from the git config of the repository

Returns:

this

Since:

5.11

getVerifier

public GpgSignatureVerifier getVerifier()

Retrieves the currently set GpgSignatureVerifier. Can be used after a successful call() to get the verifier that was used.

Returns:

the GpgSignatureVerifier

call

@NonNull
public Map<String,VerificationResult> call()
                                             throws ServiceUnavailableException,
                                                    WrongObjectTypeException

Resolves all names added to the command to git objects and verifies their signature. Non-existing objects are ignored.

Depending on the setMode(VerifyMode), only tags or commits or any kind of objects are allowed.

Unsigned objects are silently skipped.

Specified by:

call in interface Callable<Map<String,VerificationResult>>

Specified by:

call in class GitCommand<Map<String,VerificationResult>>

Returns:

a map of the given names to the corresponding VerificationResult, excluding ignored or skipped objects.

Throws:

ServiceUnavailableException - if no GpgSignatureVerifier was set and no GpgSignatureVerifierFactory is available

WrongObjectTypeException - if a name resolves to an object of a type not allowed by the setMode(VerifyMode) mode