gradle/org.gradle.plugins.signing/Signature

Signature

open class Signature : AbstractPublishArtifact(source)

A digital signature file artifact.

A signature file is always generated from another file, which may be a PublishArtifact.

Constructors

Signature

constructor(toSign: PublishArtifact, signatureSpec: SignatureSpec, tasks: Array<Any>)

Creates a signature artifact for the given public artifact.

constructor(toSign: File, signatureSpec: SignatureSpec, tasks: Array<Any>)

Creates a signature artifact for the given file.

constructor(toSign: File, classifier: String, signatureSpec: SignatureSpec, tasks: Array<Any>)

Creates a signature artifact for the given file, with the given classifier.

constructor(toSign: Closure<File>, classifier: Closure<String>, signatureSpec: SignatureSpec, tasks: Array<Any>)

Creates a signature artifact for the file returned by the toSign closure.

constructor(toSign: Callable<File>, classifier: Callable<String>, signatureSpec: SignatureSpec, tasks: Array<Any>)

Creates a signature artifact for the file returned by the toSign closure.

Types

Generator

@Incubating

open class Generator

Configuration-cache compatible signature generator.

Properties

classifier

@get:Internal

open var classifier: String

The classifier of the signature artifact.

date

@get:Internal

open var date: Date

The date of the signature artifact.

extension

@get:Internal

open var extension: String

The extension of the signature artifact.

name

@get:Internal

open var name: String

The name of the signature artifact.

signatureSpec

@get:Internal

open var signatureSpec: SignatureSpec

The specification of how to generate the signature.

type

@get:Internal

open var type: String

The type of the signature artifact.

Functions

builtBy

open fun builtBy(tasks: Array<Any>): AbstractPublishArtifact

generate

open fun generate()

Generates the signature file.

getBuildDependencies

@Internal

open fun getBuildDependencies(): TaskDependency

getClassifier

abstract fun getClassifier(): @Nullable String

getDate

abstract fun getDate(): @Nullable Date

getExtension

abstract fun getExtension(): String

getFile

@OutputFile

open fun getFile(): File

The file for the generated signature, which may not yet exist.

getName

abstract fun getName(): String

getSignatory

@Internal(value = "already tracked as part of the Sign task")

open fun getSignatory(): Signatory

The signatory of this signature file.

getSignatureType

@Internal(value = "already tracked as part of the Sign task")

open fun getSignatureType(): SignatureType

The file representation type of the signature.

getToSign

@PathSensitive(value = PathSensitivity.NONE)

@InputFile

open fun getToSign(): File

The file that is to be signed.

getType

abstract fun getType(): String

shouldBePublished

open fun shouldBePublished(): Boolean

toString

open fun toString(): String