Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD DETAIL: FIELD | PROPERTY | CONSTR | METHOD

org.gradle.plugins.signing
[Groovy] Class Sign

java.lang.Object
  org.gradle.api.internal.AbstractTask
      org.gradle.api.DefaultTask
          org.gradle.plugins.signing.Sign
All Implemented Interfaces:
SignatureSpec
class Sign
extends DefaultTask

A task for creating digital signature files for one or more; tasks, files, publishable artifacts or configurations.

The task produces Signature

objects that are publishable artifacts and can be assigned to another configuration.

The signature objects are created with defaults and using this tasks signatory and signature type.

Property Summary
boolean required

Whether or not this task should fail if no signatory or signature type are configured at generation time.
Signatory signatory

The signatory to the generated signatures.
SignatureType signatureType

 
Constructor Summary
Sign()

 
Method Summary
void generate()

Generates the signature files.
FileCollection getFilesToSign()

All of the files that will be signed by this task.
FileCollection getSignatureFiles()

All of the signature files that will be generated by this operation.
DomainObjectSet getSignatures()

The signatures generated by this task.
Signature getSingleSignature()

Returns the the single signature generated by this task.
void required(boolean required)

Change whether or not this task should fail if no signatory or signature type are configured at the time of generation.
void sign(Task... tasks)

Configures the task to sign the archive produced for each of the given tasks (which must be archive tasks).
void sign(PublishArtifact... publishArtifacts)

Configures the task to sign each of the given artifacts
void sign(File... files)

Configures the task to sign each of the given files
void sign(String classifier, File... files)

Configures the task to sign each of the given artifacts, using the given classifier as the classifier for the resultant signature publish artifact.
void sign(Configuration... configurations)

Configures the task to sign every artifact of the given configurations
void signatory(Signatory signatory)

Changes the signatory of the signatures.
void signatureType(SignatureType type)

Changes the signature file representation for the signatures.
 

Property Detail

required

boolean required
Whether or not this task should fail if no signatory or signature type are configured at generation time.

Defaults to true.

signatory

Signatory signatory
The signatory to the generated signatures.

signatureType

SignatureType signatureType

 
Constructor Detail

Sign

Sign()

 
Method Detail

generate

@TaskAction
void generate()
Generates the signature files.

getFilesToSign

FileCollection getFilesToSign()
All of the files that will be signed by this task.

getSignatureFiles

FileCollection getSignatureFiles()
All of the signature files that will be generated by this operation.

getSignatures

DomainObjectSet getSignatures()
The signatures generated by this task.

getSingleSignature

Signature getSingleSignature()
Returns the the single signature generated by this task.
throws:
IllegalStateException if there is not exactly one signature.
Returns:
The signature.

required

void required(boolean required)
Change whether or not this task should fail if no signatory or signature type are configured at the time of generation.

sign

void sign(Task... tasks)
Configures the task to sign the archive produced for each of the given tasks (which must be archive tasks).

sign

void sign(PublishArtifact... publishArtifacts)
Configures the task to sign each of the given artifacts

sign

void sign(File... files)
Configures the task to sign each of the given files

sign

void sign(String classifier, File... files)
Configures the task to sign each of the given artifacts, using the given classifier as the classifier for the resultant signature publish artifact.

sign

void sign(Configuration... configurations)
Configures the task to sign every artifact of the given configurations

signatory

void signatory(Signatory signatory)
Changes the signatory of the signatures.

signatureType

void signatureType(SignatureType type)
Changes the signature file representation for the signatures.

 

Gradle API 1.0