Module org.kohsuke.github.api

Package org.kohsuke.github

Class GHVerification

java.lang.Object

org.kohsuke.github.GHVerification

public class GHVerification
extends Object

The commit/tag can be signed by user. This object holds the verification status. Whether the Commit/Tag is signed or not.

Author:

Sourabh Sarvotham Parkala

See Also:

• tags signature verification
• commits signature verification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GHVerification.Reason	The possible values for reason in verification object from github.

Constructor Summary

Constructors

Constructor	Description
GHVerification()	Create default GHVerification instance

Method Summary

Modifier and Type	Method	Description
String	getPayload()	Gets the payload that was signed.
GHVerification.Reason	getReason()	Gets reason for verification value.
String	getSignature()	Gets signature used for the verification.
Instant	getVerifiedAt()	Gets the time when the signature was verified by GitHub.
boolean	isVerified()	Indicates whether GitHub considers the signature in this commit to be verified.

Methods inherited from class java.lang.Object

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

Constructor Details

GHVerification

public GHVerification()

Create default GHVerification instance

Method Details

getPayload

public String getPayload()

Gets the payload that was signed.

Returns:

null if not signed else encoded signature.

getReason

public GHVerification.Reason getReason()

Gets reason for verification value.

Returns:

reason of type GHVerification.Reason, such as "valid" or "unsigned". The possible values can be found in GHVerification.Reason}

getSignature

public String getSignature()

Gets signature used for the verification.

Returns:

null if not signed else encoded signature.

getVerifiedAt

public Instant getVerifiedAt()

Gets the time when the signature was verified by GitHub.

Returns:

the instant the signature was verified, or null if not available.

isVerified

public boolean isVerified()

Indicates whether GitHub considers the signature in this commit to be verified.

Returns:

true if the signature is valid else returns false.