application/com.varabyte.kobweb.gradle.application.tasks/KobwebCacheAppBackendDataTask

KobwebCacheAppBackendDataTask

@CacheableTask

abstract class KobwebCacheAppBackendDataTask : DefaultTask(source)

Collect all backend app data from the current site and all library dependencies, writing the result to appDataFile.

This is done so that multiple tasks can read the same values from a single, cached file. Those tasks should take appDataFile as an input and then deserialize it in their execute method:

// Configuring the task
myBackendAppDataUsingTask.configure {
  appDataFile.set(kobwebCacheAppBackendDataTask.flatMap { it.appDataFile })
}

// Inside the task
@get:InputFile
@get:PathSensitive(PathSensitivity.NONE)
abstract val appDataFile: RegularFileProperty

@TaskAction
fun execute() {
  val appData = Json.decodeFromString<AppBackendData>(appDataFile.get().asFile.readText())
  // ...
}

Constructors

KobwebCacheAppBackendDataTask

constructor()

Properties

open var actions: List<Action<in Task?>?>?

open val ant: AntBuilder?

appBackendMetadataFile

@get:Optional

@get:InputFile

@get:PathSensitive(value = PathSensitivity.NONE)

abstract val appBackendMetadataFile: RegularFileProperty

@get:OutputFile

abstract val appDataFile: RegularFileProperty

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

compileClasspath

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.NONE)

abstract val compileClasspath: ConfigurableFileCollection

open val dependsOn: Set<Any?>?

open var description: @Nullable String?

open val destroyables: TaskDestroyables?

open var didWork: Boolean

open var enabled: Boolean

open val extensions: ExtensionContainer?

open val finalizedBy: TaskDependency?

open var group: @Nullable String?

open val identityPath: Path?

impliesSubProjects

open var impliesSubProjects: Boolean

open val inputs: TaskInputsInternal?

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal?

open val localState: TaskLocalState?

open val logger: Logger?

open val logging: LoggingManager?

open val mustRunAfter: TaskDependency?

open val name: String?

open val onlyIf: Spec<in TaskInternal?>?

open val outputs: TaskOutputsInternal?

open val path: String?

open val project: Project?

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String?>?

reasonsNotToTrackState

open val reasonsNotToTrackState: Set<String?>?

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String?>?

requiredServices

open val requiredServices: TaskRequiredServices?

sharedResources

open val sharedResources: List<ResourceLock?>?

open val shouldRunAfter: TaskDependency?

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture?

open val state: TaskStateInternal?

open val taskActions: List<InputChangesAwareTaskAction?>?

taskDependencies

open val taskDependencies: TaskDependencyInternal?

open val taskIdentity: TaskIdentity<*>?

open val temporaryDir: File?

temporaryDirFactory

open val temporaryDirFactory: Factory<File?>?

open val timeout: Property<Duration?>?

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec?>?)

appendParallelSafeAction

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

open operator fun compareTo(otherTask: Task?): Int

open fun configure(closure: Closure<*>?): Task?

open fun dependsOn(vararg paths: Any?): Task?

open fun doFirst(action: Closure<*>?): Task?

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

open fun doFirst(actionName: String?, action: Action<in Task?>?): Task?

open fun doLast(action: Closure<*>?): Task?

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

open fun doLast(actionName: String?, action: Action<in Task?>?): Task?

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String?)

doNotTrackStateIf

open fun doNotTrackStateIf(reason: String?, spec: Spec<in TaskInternal?>?)

open fun finalizedBy(vararg paths: Any?): Task?

open fun hasProperty(propertyName: String?): Boolean

open fun hasTaskActions(): Boolean

open fun mustRunAfter(vararg paths: Any?): Task?

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String?)

open fun onlyIf(onlyIfClosure: Closure<*>?)

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

open fun onlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

prependParallelSafeAction

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

open fun property(propertyName: String?): Any?

open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal?>?)

restoreTaskActions

open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction?>?)

open fun setDependsOn(dependsOn: Iterable<*>?)

open fun setFinalizedBy(finalizedByTasks: Iterable<*>?)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>?)

open fun setOnlyIf(onlyIfClosure: Closure<*>?)

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

open fun setOnlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

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

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>?)

open fun shouldRunAfter(vararg paths: Any?): TaskDependency?

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