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

KobwebStartTask

abstract class KobwebStartTask @Inject constructor(remoteDebuggingBlock: AppBlock.ServerBlock.RemoteDebuggingBlock, env: ServerEnvironment, siteLayout: Provider<SiteLayout>, reuseServer: Boolean) : KobwebTask(source)

Start a Kobweb web server.

Note that this task is NOT blocking. It will start a server in the background and then return success immediately.

You should execute the KobwebStopTask to stop a server started by this task.

Parameters

reuseServer

If a server is already running, re-use it if possible.

Constructors

KobwebStartTask

@Inject

constructor(remoteDebuggingBlock: AppBlock.ServerBlock.RemoteDebuggingBlock, env: ServerEnvironment, siteLayout: Provider<SiteLayout>, reuseServer: Boolean)

Properties

actions

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

ant

open val ant: AntBuilder

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

dependsOn

open val dependsOn: Set<Any>

description

open var description: @Nullable String?

destroyables

open val destroyables: TaskDestroyables

didWork

open var didWork: Boolean

enabled

open var enabled: Boolean

extensions

open val extensions: ExtensionContainer

finalizedBy

open val finalizedBy: TaskDependency

group

open var group: @Nullable String?

identityPath

open val identityPath: Path

impliesSubProjects

open var impliesSubProjects: Boolean

inputs

open val inputs: TaskInputsInternal

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

isEnabled

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

kobwebApplication

@get:Internal

val kobwebApplication: KobwebApplication

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal

localState

open val localState: TaskLocalState

logger

open val logger: Logger

logging

open val logging: LoggingManager

mustRunAfter

open val mustRunAfter: TaskDependency

name

open val name: String

onlyIf

open val onlyIf: Spec<in TaskInternal>

outputs

open val outputs: TaskOutputsInternal

path

open val path: String

project

open val project: Project

projectLayout

@get:Inject

abstract val projectLayout: ProjectLayout

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String>

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String>

requiredServices

open val requiredServices: TaskRequiredServices

serverJar

@get:InputFile

abstract val serverJar: RegularFileProperty

serverPluginsDir

@get:InputFiles

abstract val serverPluginsDir: DirectoryProperty

sharedResources

open val sharedResources: List<ResourceLock>

shouldRunAfter

open val shouldRunAfter: TaskDependency

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture

state

open val state: TaskStateInternal

taskActions

open val taskActions: List<InputChangesAwareTaskAction>

taskDependencies

open val taskDependencies: TaskDependencyInternal

taskIdentity

open val taskIdentity: TaskIdentity<*>

temporaryDir

open val temporaryDir: File

temporaryDirFactory

open val temporaryDirFactory: Factory<File>

timeout

open val timeout: Property<Duration>

watchFiles

@get:InputFiles

abstract val watchFiles: ConfigurableFileCollection

A collection of files that Gradle should watch for changes when running kobwebStart in continuous mode.

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

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

compareTo

open operator fun compareTo(otherTask: Task): Int

configure

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

dependsOn

open fun dependsOn(vararg paths: Any): Task

doFirst

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

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

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

doLast

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)

execute

fun execute()

finalizedBy

open fun finalizedBy(vararg paths: Any): Task

hasProperty

open fun hasProperty(propertyName: String): Boolean

hasTaskActions

open fun hasTaskActions(): Boolean

mustRunAfter

open fun mustRunAfter(vararg paths: Any): Task

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

onlyIf

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>)

property

open fun property(propertyName: String): Any

setDependsOn

open fun setDependsOn(dependsOn: Iterable<*>)

setFinalizedBy

open fun setFinalizedBy(finalizedByTasks: Iterable<*>)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>)

setOnlyIf

open fun setOnlyIf(onlyIfClosure: Closure<*>)

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

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

setProperty

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

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>)

shouldRunAfter

open fun shouldRunAfter(vararg paths: Any): TaskDependency

usesService

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