Class Sign

  • All Implemented Interfaces:
    Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, SignatureSpec, org.gradle.util.Configurable<Task>

    public 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

    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.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.gradle.api.Task

        Task.Namer
    • Constructor Summary

      Constructors 
      Constructor Description
      Sign()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void generate()
      Generates the signature files.
      protected org.gradle.api.internal.file.FileCollectionFactory getFileCollectionFactory()  
      FileCollection getFilesToSign()
      All of the files that will be signed by this task.
      Iterable<File> getInputFiles()  
      Map<String,​File> getOutputFiles()  
      Signatory getSignatory()
      Returns the signatory for this signing task.
      FileCollection getSignatureFiles()
      All of the signature files that will be generated by this operation.
      DomainObjectSet<Signature> getSignatures()
      The signatures generated by this task.
      SignatureType getSignatureType()
      The signature representation that will be created.
      Signature getSingleSignature()
      Returns the single signature generated by this task.
      boolean isRequired()
      Whether or not this task should fail if no signatory or signature type are configured at generation time.
      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 setRequired​(boolean required)
      Whether or not it is required that this signature be generated.
      void setSignatory​(Signatory signatory)
      Sets the signatory that will be signing the input.
      void setSignatureType​(SignatureType signatureType)
      Sets the signature representation that the signatures will be produced as.
      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 sign​(PublishArtifact... publishArtifacts)
      Configures the task to sign each of the given artifacts
      void sign​(Task... tasks)
      Configures the task to sign the archive produced for each of the given tasks (which must be archive tasks).
      void signatory​(Signatory signatory)
      Changes the signatory of the signatures.
      • Methods inherited from class org.gradle.api.internal.AbstractTask

        addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString
    • Constructor Detail

      • Sign

        public Sign()
    • Method Detail

      • sign

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

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

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

        public 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

        public void sign​(Configuration... configurations)
        Configures the task to sign every artifact of the given configurations
      • signatory

        public void signatory​(Signatory signatory)
        Changes the signatory of the signatures.
      • required

        public 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.
      • generate

        public void generate()
        Generates the signature files.
      • getSingleSignature

        @Internal
        public Signature getSingleSignature()
        Returns 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()
      • getFilesToSign

        @Internal
        public FileCollection getFilesToSign()
        All of the files that will be signed by this task.
      • getSignatureFiles

        @Internal
        public FileCollection getSignatureFiles()
        All of the signature files that will be generated by this operation.
      • getSignatureType

        public SignatureType getSignatureType()
        Description copied from interface: SignatureSpec
        The signature representation that will be created.
        Specified by:
        getSignatureType in interface SignatureSpec
        Returns:
        the signature type, or null if none specified.
      • setSignatureType

        public void setSignatureType​(SignatureType signatureType)
        Description copied from interface: SignatureSpec
        Sets the signature representation that the signatures will be produced as.
        Specified by:
        setSignatureType in interface SignatureSpec
        Parameters:
        signatureType - the signature type to use
      • getSignatory

        public Signatory getSignatory()
        Returns the signatory for this signing task.
        Specified by:
        getSignatory in interface SignatureSpec
        Returns:
        the signatory
      • setSignatory

        public void setSignatory​(Signatory signatory)
        Description copied from interface: SignatureSpec
        Sets the signatory that will be signing the input.
        Specified by:
        setSignatory in interface SignatureSpec
        Parameters:
        signatory - The signatory
      • isRequired

        @Input
        public boolean isRequired()
        Whether or not this task should fail if no signatory or signature type are configured at generation time.

        Defaults to true.

        Specified by:
        isRequired in interface SignatureSpec
        Returns:
        Whether or not it is required that this signature be generated.
      • setRequired

        public void setRequired​(boolean required)
        Description copied from interface: SignatureSpec
        Whether or not it is required that this signature be generated.
        Specified by:
        setRequired in interface SignatureSpec
        Parameters:
        required - Whether or not it is required that this signature be generated.
        See Also:
        SignatureSpec.isRequired()