Package org.gradle.plugins.signing

Klasse SignOperation

java.lang.Object
org.gradle.plugins.signing.SignOperation
Alle implementierten Schnittstellen:
SignatureSpec
public abstract class SignOperation extends Object implements SignatureSpec
A sign operation creates digital signatures for one or more files or publish artifacts.

The external representation of the signature is specified by the signature type property, while the signatory property specifies who is to sign.

A sign operation manages one or more Signature objects. The sign methods are used to register things to generate signatures for. The execute() method generates the signatures for all of the registered items at that time.

  • Konstruktordetails

    • SignOperation

      public SignOperation()

  • Methodendetails

    • getDisplayName

      public String getDisplayName()

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object

    • setSignatureType

      public void setSignatureType(SignatureType signatureType)
      Beschreibung aus Schnittstelle kopiert: SignatureSpec
      Sets the signature representation that the signatures will be produced as.
      Angegeben von:
      setSignatureType in Schnittstelle SignatureSpec
      Parameter:
      signatureType - the signature type to use

    • getSignatureType

      public SignatureType getSignatureType()
      Beschreibung aus Schnittstelle kopiert: SignatureSpec
      The signature representation that will be created.
      Angegeben von:
      getSignatureType in Schnittstelle SignatureSpec
      Gibt zurück:
      the signature type, or null if none specified.

    • setSignatory

      public void setSignatory(Signatory signatory)
      Beschreibung aus Schnittstelle kopiert: SignatureSpec
      Sets the signatory that will be signing the input.
      Angegeben von:
      setSignatory in Schnittstelle SignatureSpec
      Parameter:
      signatory - The signatory

    • getSignatory

      public Signatory getSignatory()
      Beschreibung aus Schnittstelle kopiert: SignatureSpec
      The signatory that will be performing the signing.
      Angegeben von:
      getSignatory in Schnittstelle SignatureSpec
      Gibt zurück:
      the signatory, or null if none specified.

    • setRequired

      public void setRequired(boolean required)
      Beschreibung aus Schnittstelle kopiert: SignatureSpec
      Whether or not it is required that this signature be generated.
      Angegeben von:
      setRequired in Schnittstelle SignatureSpec
      Parameter:
      required - Whether or not it is required that this signature be generated.
      Siehe auch:

    • isRequired

      public boolean isRequired()
      Beschreibung aus Schnittstelle kopiert: SignatureSpec
      Whether or not it is required that this signature be generated. A signature may not be able to be generated if a signatory and/or a signature type have not been specified. If it is required and cannot be generated, an exception will be thrown. Otherwise, it will not be generated.
      Angegeben von:
      isRequired in Schnittstelle SignatureSpec
      Gibt zurück:
      Whether or not it is required that this signature be generated.

    • sign

      public SignOperation sign(PublishArtifact... artifacts)
      Registers signatures for the given artifacts.
      Gibt zurück:
      this
      Siehe auch:

    • sign

      public SignOperation sign(File... files)
      Registers signatures for the given files.
      Gibt zurück:
      this
      Siehe auch:

    • sign

      public SignOperation sign(String classifier, File... files)
      Registers signatures (with the given classifier) for the given files
      Gibt zurück:
      this
      Siehe auch:

    • signatureType

      public SignOperation signatureType(SignatureType type)
      Change the signature type for signature generation.

    • signatory

      public SignOperation signatory(Signatory signatory)
      Change the signatory for signature generation.

    • configure

      public SignOperation configure(Closure closure)
      Executes the given closure against this object.

    • execute

      public SignOperation execute()
      Generates actual signature files for all of the registered signatures.

      The signatures are generated with the configuration they have at this time, which includes the signature type and signatory of this operation at this time.

      This method can be called multiple times, with the signatures being generated with their current configuration each time.

      Gibt zurück:
      this
      Siehe auch:

    • getSignatures

      public List<Signature> getSignatures()
      The registered signatures.

    • getSingleSignature

      public Signature getSingleSignature()
      Returns the single registered signature.
      Gibt zurück:
      The signature.
      Löst aus:
      IllegalStateException - if there is not exactly one registered signature.

    • getFilesToSign

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

    • getSignatureFiles

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

    • toFileCollection

      protected abstract FileCollection toFileCollection(List<File> files)