Sign

@DisableCachingByDefault(because = "Not made cacheable, yet")

abstract class Sign : DefaultTask, SignatureSpec(source)

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.

Constructors

Sign

@Inject

constructor()

Properties

description

open var description: String

enabled

open var enabled: Boolean

extra

val ExtensionAware.extra: ExtraPropertiesExtension

The extra properties extension in this object's extension container.

group

open var group: String

impliesSubProjects

open var impliesSubProjects: Boolean

signatory

@get:Optional

open var signatory: Signatory

signatureType

@get:Optional

open var signatureType: SignatureType

state

val state: TaskStateInternal

TASK_ACTION

val TASK_ACTION: String = "action"

TASK_CONSTRUCTOR_ARGS

val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"

TASK_DEPENDS_ON

val TASK_DEPENDS_ON: String = "dependsOn"

TASK_DESCRIPTION

val TASK_DESCRIPTION: String = "description"

TASK_GROUP

val TASK_GROUP: String = "group"

TASK_NAME

val TASK_NAME: String = "name"

TASK_OVERWRITE

val TASK_OVERWRITE: String = "overwrite"

TASK_TYPE

val TASK_TYPE: String = "type"

timeout

val timeout: Property<Duration>

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task>)

compareTo

open fun compareTo(otherTask: Task): Int

configure

open fun configure(closure: Closure): Task

abstract fun configure(cl: Closure): T

configure

inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

Executes the given configuration block against the extension of the specified type.

dependsOn

open fun dependsOn(paths: Array<Any>): Task

doFirst

open fun doFirst(action: Action<in Task>): Task

doLast

open fun doLast(action: Action<in Task>): Task

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

finalizedBy

open fun finalizedBy(paths: Array<Any>): Task

generate

open fun generate()

Generates the signature files.

getActions

open fun getActions(): List<Action<in Task>>

getAnt

open fun getAnt(): AntBuilder

getAsDynamicObject

open fun getAsDynamicObject(): DynamicObject

getConvention

open fun getConvention(): Convention

getDependsOn

open fun getDependsOn(): Set<Any>

getDestroyables

open fun getDestroyables(): TaskDestroyables

getDidWork

open fun getDidWork(): Boolean

getExtensions

open fun getExtensions(): ExtensionContainer

getFilesToSign

@Internal

open fun getFilesToSign(): FileCollection

All of the files that will be signed by this task.

getFinalizedBy

open fun getFinalizedBy(): TaskDependency

getGeneratorsByKey

@Incubating

open fun getGeneratorsByKey(): Map<String, Signature.Generator>

The signature generators for this task mapped by a unique key used for up-to-date checking.

getIdentityPath

open fun getIdentityPath(): Path

getInputs

open fun getInputs(): TaskInputsInternal

abstract fun getInputs(): TaskInputs

getLifecycleDependencies

open fun getLifecycleDependencies(): TaskDependencyInternal

abstract fun getLifecycleDependencies(): TaskDependency

getLocalState

open fun getLocalState(): TaskLocalState

getLogger

open fun getLogger(): Logger

getLogging

open fun getLogging(): LoggingManager

getMustRunAfter

open fun getMustRunAfter(): TaskDependency

getName

open fun getName(): String

getOnlyIf

open fun getOnlyIf(): Spec<in TaskInternal>

getOutputs

open fun getOutputs(): TaskOutputsInternal

abstract fun getOutputs(): TaskOutputs

getPath

open fun getPath(): String

getProject

open fun getProject(): Project

getReasonNotToTrackState

open fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open fun getRequiredServices(): TaskRequiredServices

getSharedResources

open fun getSharedResources(): List<ResourceLock>

abstract fun getSharedResources(): List<out ResourceLock>

getShouldRunAfter

open fun getShouldRunAfter(): TaskDependency

getSignatory

abstract fun getSignatory(): Signatory

getSignatureFiles

@Internal

open fun getSignatureFiles(): FileCollection

All of the signature files that will be generated by this operation.

getSignatures

@Internal

open fun getSignatures(): DomainObjectSet<Signature>

The signatures generated by this task.

getSignaturesByKey

@Internal

open fun getSignaturesByKey(): Map<String, Signature>

The signatures generated by this task mapped by a unique key used for up-to-date checking.

getSignatureType

abstract fun getSignatureType(): SignatureType

getSingleSignature

@Internal

open fun getSingleSignature(): Signature

Returns the single signature generated by this task.

getStandardOutputCapture

open fun getStandardOutputCapture(): StandardOutputCapture

getState

abstract fun getState(): TaskState

getTaskActions

open fun getTaskActions(): List<InputChangesAwareTaskAction>

getTaskDependencies

open fun getTaskDependencies(): TaskDependencyInternal

abstract fun getTaskDependencies(): TaskDependency

getTaskIdentity

open fun getTaskIdentity(): TaskIdentity<out Any>

getTemporaryDir

open fun getTemporaryDir(): File

getTemporaryDirFactory

open fun getTemporaryDirFactory(): Factory<File>

hasProperty

open fun hasProperty(propertyName: String): Boolean

hasTaskActions

open fun hasTaskActions(): Boolean

injectIntoNewInstance

open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T

isCompatibleWithConfigurationCache

open fun isCompatibleWithConfigurationCache(): Boolean

isEnabled

open fun isEnabled(): Boolean

isHasCustomActions

open fun isHasCustomActions(): Boolean

isRequired

@Input

open fun isRequired(): Boolean

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

mustRunAfter

open fun mustRunAfter(paths: Array<Any>): Task

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

onlyIf

open fun onlyIf(spec: Spec<in Task>)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task>)

property

open fun property(propertyName: String): Any

required

open fun required(required: Boolean)

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

setActions

open fun setActions(replacements: List<Action<in Task>>)

setDependsOn

open fun setDependsOn(dependsOn: Iterable<out Any>)

setDidWork

open fun setDidWork(didWork: Boolean)

setFinalizedBy

open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)

setOnlyIf

open fun setOnlyIf(spec: Spec<in Task>)

setProperty

open fun setProperty(name: String, value: Any)

setRequired

open fun setRequired(required: Boolean)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)

setSignatory

abstract fun setSignatory(signatory: Signatory)

setSignatureType

abstract fun setSignatureType(type: SignatureType)

shouldRunAfter

open fun shouldRunAfter(paths: Array<Any>): TaskDependency

sign

open fun sign(files: Array<File>)

Configures the task to sign each of the given files

open fun sign(tasks: Array<Task>)

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

open fun sign(configurations: Array<Configuration>)

Configures the task to sign every artifact of the given configurations

open fun sign(publishArtifacts: Array<PublishArtifact>)

Configures the task to sign each of the given artifacts

open fun sign(publications: Array<Publication>)

Configures the task to sign every artifact of the given publications

open fun sign(classifier: String, files: Array<File>)

Configures the task to sign each of the given artifacts, using the given classifier as the classifier for the resultant signature publish artifact.

signatory

open fun signatory(signatory: Signatory)

Changes the signatory of the signatures.

the

inline fun <T : Any> ExtensionAware.the(): T

Returns the extension of the specified type.

fun <T : Any> ExtensionAware.the(extensionType: KClass<T>): T

Returns the extension of the specified extensionType.

usesService

open fun usesService(service: Provider<out BuildService<out Any>>)