Package org.gradle.plugins.signing
Class Sign
java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.plugins.signing.Sign
- All Implemented Interfaces:
- Comparable<Task>,- org.gradle.api.internal.DynamicObjectAware,- org.gradle.api.internal.TaskInternal,- Named,- ExtensionAware,- Task,- SignatureSpec,- Configurable<Task>
@DisableCachingByDefault(because="Not made cacheable, yet")
public abstract class Sign
extends DefaultTask
implements SignatureSpec
A task for creating digital signature files for one or more; tasks, files, publishable artifacts or configurations.
 
The task produces Signature
The signature objects are created with defaults and using this tasks signatory and signature type.
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidgenerate()Generates the signature files.protected org.gradle.api.internal.CollectionCallbackActionDecoratorRequired for decorating reports container callbacks for tracing user code application.protected org.gradle.api.internal.file.FileCollectionFactoryAll of the files that will be signed by this task.The signature generators for this task mapped by a unique key used for up-to-date checking.Returns the signatory for this signing task.All of the signature files that will be generated by this operation.The signatures generated by this task.The signatures generated by this task mapped by a unique key used for up-to-date checking.The signature representation that will be created.Returns the single signature generated by this task.booleanWhether or not this task should fail if no signatory or signature type are configured at generation time.voidrequired(boolean required) Change whether or not this task should fail if no signatory or signature type are configured at the time of generation.voidsetRequired(boolean required) Whether or not it is required that this signature be generated.voidsetSignatory(Signatory signatory) Sets the signatory that will be signing the input.voidsetSignatureType(SignatureType signatureType) Sets the signature representation that the signatures will be produced as.voidConfigures the task to sign each of the given filesvoidConfigures the task to sign each of the given artifacts, using the given classifier as the classifier for the resultant signature publish artifact.voidsign(Configuration... configurations) Configures the task to sign every artifact of the given configurationsvoidsign(PublishArtifact... publishArtifacts) Configures the task to sign each of the given artifactsvoidsign(Publication... publications) Configures the task to sign every artifact of the given publicationsvoidConfigures the task to sign the archive produced for each of the given tasks (which must be archive tasks).voidChanges the signatory of the signatures.Methods inherited from class org.gradle.api.DefaultTaskcompareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Constructor Details- 
Sign@Inject public Sign()
 
- 
- 
Method Details- 
signConfigures the task to sign the archive produced for each of the given tasks (which must be archive tasks).
- 
signConfigures the task to sign each of the given artifacts
- 
signConfigures the task to sign each of the given files
- 
signConfigures the task to sign each of the given artifacts, using the given classifier as the classifier for the resultant signature publish artifact.
- 
signConfigures the task to sign every artifact of the given configurations
- 
signConfigures the task to sign every artifact of the given publications- Since:
- 4.8
 
- 
signatoryChanges the signatory of the signatures.
- 
requiredpublic 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.
- 
generatepublic void generate()Generates the signature files.
- 
getSignaturesThe signatures generated by this task.
- 
getGeneratorsByKeyThe signature generators for this task mapped by a unique key used for up-to-date checking.- Since:
- 8.1
 
- 
getSignaturesByKeyThe signatures generated by this task mapped by a unique key used for up-to-date checking.- Since:
- 5.1
 
- 
getSingleSignatureReturns the single signature generated by this task.- Returns:
- The signature.
- Throws:
- IllegalStateException- if there is not exactly one signature.
 
- 
getFileCollectionFactory@Inject protected org.gradle.api.internal.file.FileCollectionFactory getFileCollectionFactory()
- 
getFilesToSignAll of the files that will be signed by this task.
- 
getSignatureFilesAll of the signature files that will be generated by this operation.
- 
getSignatureTypeDescription copied from interface:SignatureSpecThe signature representation that will be created.- Specified by:
- getSignatureTypein interface- SignatureSpec
- Returns:
- the signature type, or nullif none specified.
 
- 
setSignatureTypeDescription copied from interface:SignatureSpecSets the signature representation that the signatures will be produced as.- Specified by:
- setSignatureTypein interface- SignatureSpec
- Parameters:
- signatureType- the signature type to use
 
- 
getSignatoryReturns the signatory for this signing task.- Specified by:
- getSignatoryin interface- SignatureSpec
- Returns:
- the signatory
 
- 
setSignatoryDescription copied from interface:SignatureSpecSets the signatory that will be signing the input.- Specified by:
- setSignatoryin interface- SignatureSpec
- Parameters:
- signatory- The signatory
 
- 
isRequiredWhether or not this task should fail if no signatory or signature type are configured at generation time.Defaults to true.- Specified by:
- isRequiredin interface- SignatureSpec
- Returns:
- Whether or not it is required that this signature be generated.
 
- 
setRequiredpublic void setRequired(boolean required) Description copied from interface:SignatureSpecWhether or not it is required that this signature be generated.- Specified by:
- setRequiredin interface- SignatureSpec
- Parameters:
- required- Whether or not it is required that this signature be generated.
- See Also:
 
- 
getCallbackActionDecorator@Inject protected org.gradle.api.internal.CollectionCallbackActionDecorator getCallbackActionDecorator()Required for decorating reports container callbacks for tracing user code application.- Since:
- 5.1
 
 
-