# SignOperation

abstract class SignOperation : SignatureSpec(source)

A sign operation creates digital signatures for one or more files.

The external representation of the signature is specified by getSignatureType, while the getSignatory specifies how to sign. The `sign` methods are used to register files to generate signatures for. The execute method generates the signatures for all the registered items at that time.

#### Since

1.0

## Constructors

SignOperation
Link copied to clipboard
constructor()

## Properties

signatory
Link copied to clipboard
open var signatory: Signatory
The signatory to the generated digital signatures.
signatureType
Link copied to clipboard
open var signatureType: SignatureType
The file representation of the signature(s).

## Functions

configure
Link copied to clipboard
open fun configure(closure: Closure): SignOperation
Executes the given closure against this object.
execute
Link copied to clipboard
open fun execute(): SignOperation
Generates actual signature files for all of the registered signatures.
getDisplayName
Link copied to clipboard
open fun getDisplayName(): String
Returns the display name.
getFilesToSign
Link copied to clipboard
open fun getFilesToSign(): FileCollection
All of the files that will be signed by this operation.
getSignatureFiles
Link copied to clipboard
open fun getSignatureFiles(): FileCollection
All of the signature files that will be generated by this operation.
getSignatures
Link copied to clipboard
open fun getSignatures(): List<Signature>
The registered signatures.
getSingleSignature
Link copied to clipboard
open fun getSingleSignature(): Signature
Returns the single registered signature.
isRequired
Link copied to clipboard
open fun isRequired(): Boolean
Whether or not it is required that this signature be generated.
setRequired
Link copied to clipboard
open fun setRequired(required: Boolean)
Whether or not it is required that this signature be generated.
setSignatureType
Link copied to clipboard
abstract fun setSignatureType(type: SignatureType)
Sets the signature representation that the signatures will be produced as.
sign
Link copied to clipboard
open fun sign(files: Array<File>): SignOperation
Registers signatures for the given files.
open fun sign(artifacts: Array<PublishArtifact>): SignOperation
Registers signatures for the given artifacts.
open fun sign(ignoredClassifier: String, files: Array<File>): SignOperation
Registers signatures (with the given classifier) for the given files
signatory
Link copied to clipboard
open fun signatory(signatory: Signatory): SignOperation
Change the signatory for signature generation.
signatureType
Link copied to clipboard
open fun signatureType(type: SignatureType): SignOperation
Change the signature type for signature generation.
toString
Link copied to clipboard
open fun toString(): String