Package: org.gradle.plugins.signing

## [Groovy] Class SigningExtension

- org.gradle.plugins.signing.SigningExtension

- The global signing configuration for a project.

- - ### Properties Summary

    Properties
    Type | Name and description
    --- | ---
    `static String` | `DEFAULT_CONFIGURATION_NAME` The name of the configuration that all signature artifacts will be placed into ("signatures")
    `Configuration` | `configuration` The configuration that signature artifacts will be placed into.
    `Project` | `project` The project that the settings are for
    `SignatoryProvider` | `signatories` The provider of signatories.
    `SignatureTypeProvider` | `signatureTypes` The provider of signature types.

  - ### Constructor Summary

    Constructors
    Constructor and description
    `SigningExtension (Project project)` Configures the signing settings for the given project.

  - ### Methods Summary

    Methods
    Type | Name and description
    --- | ---
    `protected void` | `addSignatureSpecConventions(SignatureSpec spec)` Adds conventions to the given spec, using this settings object's default signatory and signature type as the default signatory and signature type for the spec.
    `protected def` | `addSignaturesToConfiguration(Sign task, Configuration configuration)`
    `protected SignatoryProvider` | `createSignatoryProvider()` Provides the signatory provider.
    `protected SignatureTypeProvider` | `createSignatureTypeProvider()` Provides the signature type provider.
    `protected SignOperation` | `doSignOperation(Closure setup)`
    `Configuration` | `getConfiguration()` The configuration that signature artifacts are added to.
    `protected Configuration` | `getDefaultConfiguration()` Provides the configuration that signature artifacts are added to.
    `Signatory` | `getSignatory()` The signatory that will be used for signing when an explicit signatory has not been specified.
    `SignatureType` | `getSignatureType()` The signature type that will be used for signing files when an explicit signature type has not been specified.
    `boolean` | `isRequired()` Whether or not this task should fail if no signatory or signature type are configured at generation time.
    `void` | `setRequired(Object required)` Whether or not this task should fail if no signatory or signature type are configured at generation time.
    `List<Sign>` | `sign(Task... tasksToSign)` Creates signing tasks that depend on and sign the "archive" produced by the given tasks.
    `List<Sign>` | `sign(Configuration... configurations)` Creates signing tasks that sign Configuration#getAllArtifacts()#getAllArtifacts() of the given configurations.
    `SignOperation` | `sign(PublishArtifact... publishArtifacts)` Digitally signs the publish artifacts, generating signature files alongside them.
    `SignOperation` | `sign(File... files)` Digitally signs the files, generating signature files alongside them.
    `SignOperation` | `sign(String classifier, File... files)` Digitally signs the files, generating signature files alongside them.
    `SignOperation` | `sign(Closure closure)` Creates a new sign operation using the given closure to configure it before executing it.
    `Signature` | `signPom(MavenDeployment mavenDeployment, Closure closure = null)` Signs the POM artifact for the given Maven deployment.
    `SignatoryProvider` | `signatories(Closure closure)` Configures the signatory provider (delegating to its configure method).

  - ### Inherited Methods Summary

    Inherited Methods
    Methods inherited from class | Name
    --- | ---
    `class Object` | `wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- - ### Property Detail

    - #### static final String DEFAULT_CONFIGURATION_NAME

      The name of the configuration that all signature artifacts will be placed into ("signatures")

    - #### Configuration configuration

      The configuration that signature artifacts will be placed into.

      Changing this will not affect any signing already configured.

    - #### final Project project

      The project that the settings are for

    - #### SignatoryProvider signatories

      The provider of signatories.

    - #### SignatureTypeProvider signatureTypes

      The provider of signature types.

  - ### Constructor Detail

    - #### SigningExtension(Project project)

      Configures the signing settings for the given project.

  - ### Method Detail

    - #### protected void addSignatureSpecConventions(SignatureSpec spec)

      Adds conventions to the given spec, using this settings object's default signatory and signature type as the default signatory and signature type for the spec.

    - #### protected def addSignaturesToConfiguration(Sign task, Configuration configuration)

    - #### protected SignatoryProvider createSignatoryProvider()

      Provides the signatory provider. Called once during construction.

    - #### protected SignatureTypeProvider createSignatureTypeProvider()

      Provides the signature type provider. Called once during construction.

    - #### protected SignOperation doSignOperation(Closure setup)

    - #### Configuration getConfiguration()

      The configuration that signature artifacts are added to.

    - #### protected Configuration getDefaultConfiguration()

      Provides the configuration that signature artifacts are added to. Called once during construction.

    - #### Signatory getSignatory()

      The signatory that will be used for signing when an explicit signatory has not been specified.

      Delegates to the signatory provider's default signatory.

    - #### SignatureType getSignatureType()

      The signature type that will be used for signing files when an explicit signature type has not been specified.

      Delegates to the signature type provider's default type.

    - #### boolean isRequired()

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

      Defaults to `true`.

      See Also:
        setRequired(Object)

    - #### void setRequired(Object required)

      Whether or not this task should fail if no signatory or signature type are configured at generation time. If `required` is a Callable, it will be stored and "called" on demand (i.e. when isRequired() is called) and the return value will be interpreting according to the Groovy Truth. For example:

           signing {
             required = { gradle.taskGraph.hasTask("uploadArchives") }
           }

      Because the task graph is not known until Gradle starts executing, we must use defer the decision. We can do this via using a Closure (which is a Callable). For any other type, the value will be stored and evaluated on demand according to the Groovy Truth.

           signing {
             required = false
           }

    - #### List<Sign> sign(Task... tasksToSign)

      Creates signing tasks that depend on and sign the "archive" produced by the given tasks.

      The created tasks will be named "sign<input task name capitalized>". That is, given a task with the name "jar" the created task will be named "signJar".

      If the task is not an AbstractArchiveTask, an InvalidUserDataException will be thrown.

      The signature artifact for the created task is added to the for this settings object.

      Parameters:
        `task` - The tasks whose archives are to be signed
      Returns:
        the created tasks.

    - #### List<Sign> sign(Configuration... configurations)

      Creates signing tasks that sign Configuration#getAllArtifacts()#getAllArtifacts() of the given configurations.

      The created tasks will be named "sign<configuration name capitalized>". That is, given a configuration with the name "archives" the created task will be named "signArchives". The signature artifact for the created task is added to the for this settings object.

      Parameters:
        `task` - The configurations whose archives are to be signed
      Returns:
        the created tasks.

    - #### SignOperation sign(PublishArtifact... publishArtifacts)

      Digitally signs the publish artifacts, generating signature files alongside them.

      The project's default signatory and default signature type from the signing settings will be used to generate the signature. The returned sign operation gives access to the created signature files.

      If there is no configured default signatory available, the sign operation will fail.

      Parameters:
        `publishArtifacts` - The publish artifacts to sign
      Returns:
        The executed sign operation

    - #### SignOperation sign(File... files)

      Digitally signs the files, generating signature files alongside them.

      The project's default signatory and default signature type from the signing settings will be used to generate the signature. The returned sign operation gives access to the created signature files.

      If there is no configured default signatory available, the sign operation will fail.

      Parameters:
        `publishArtifacts` - The files to sign.
      Returns:
        The executed sign operation.

    - #### SignOperation sign(String classifier, File... files)

      Digitally signs the files, generating signature files alongside them.

      The project's default signatory and default signature type from the signing settings will be used to generate the signature. The returned sign operation gives access to the created signature files.

      If there is no configured default signatory available, the sign operation will fail.

      Parameters:
        `classifier` - The classifier to assign to the created signature artifacts.
        `publishArtifacts` - The publish artifacts to sign.
      Returns:
        The executed sign operation.

    - #### SignOperation sign(Closure closure)

      Creates a new sign operation using the given closure to configure it before executing it.

      The project's default signatory and default signature type from the signing settings will be used to generate the signature. The returned sign operation gives access to the created signature files.

      If there is no configured default signatory available (and one is not explicitly specified in this operation's configuration), the sign operation will fail.

      Parameters:
        `closure` - The configuration of the sign operation.
      Returns:
        The executed sign operation.

    - #### Signature signPom(MavenDeployment mavenDeployment, Closure closure = null)

      Signs the POM artifact for the given Maven deployment.

      You can use this method to sign the generated POM when publishing to a Maven repository with the Maven plugin.

           uploadArchives {
             repositories {
               mavenDeployer {
                 beforeDeployment { MavenDeployment deployment ->
                   signing.signPom(deployment)
                 }
               }
             }
           }

      You can optionally provide a configuration closure to fine tune the sign operation for the POM.

      If isRequired() is false and the signature cannot be generated (e.g. no configured signatory), this method will silently do nothing. That is, a signature for the POM file will not be uploaded.

      Parameters:
        `mavenDeployment` - The deployment to sign the POM of
        `closure` - the configuration of the underlying sign operation for the POM (optional)
      Returns:
        the generated signature artifact

    - #### SignatoryProvider signatories(Closure closure)

      Configures the signatory provider (delegating to its configure method).

      Parameters:
        `closure` - the signatory provider configuration DSL
      Returns:
        the configured signatory provider