common-plugin / com.cognifide.gradle.common / CommonExtension

CommonExtension

open class CommonExtension

Constructors

<init>

CommonExtension(project: Project)

Properties

buildScope

val buildScope: BuildScope

fileTransfer

Define settings for file transfer facade which allows to perform basic file operations on remote servers like uploading and downloading files.

val fileTransfer: FileTransferManager

formats

val formats: Formats

logger

val logger: Logger!

notifier

Provides API for displaying interactive notification during running build tasks.

val notifier: NotifierFacade

obj

Reduces boilerplate related to lazy configuration API

val obj: ObjectFactory

parallel

val parallel: Parallel

patterns

val patterns: Patterns

project

val project: Project

prop

Allows to read project property specified in command line and system property as a fallback.

val prop: PropertyParser

services

Accessor for internal Gradle services.

val services: ServiceAccessor

tasks

val tasks: TaskFacade

temporaryDir

Predefined temporary directory.

val temporaryDir: File

userInput

Grab user input interactively.

val userInput: UserInputHandler

Functions

fileTransfer

Configures file transfer facade.

fun fileTransfer(options: FileTransferManager.() -> Unit): Unit

http

Perform any HTTP requests to external endpoints.

fun <T> http(consumer: HttpClient.() -> T): T

httpFile

Download files using HTTP protocol using custom settings.

fun <T> httpFile(consumer: HttpFileTransfer.() -> T): T

notifier

fun notifier(configurer: NotifierFacade.() -> Unit): Unit

progress

Show asynchronous 0 indicator with percentage while performing some action.

fun <T> progress(total: Int, action: ProgressIndicator.() -> T): T

Show asynchronous progress indicator with percentage while performing some action.

fun <T> progress(total: Long, action: ProgressIndicator.() -> T): Tfun <T> progress(action: ProgressIndicator.() -> T): T

progressCountdown

Show synchronous progress countdown / time to wait after performing asynchronous operation.

fun progressCountdown(time: Long): Unit
fun progressCountdown(options: ProgressCountdown.() -> Unit): Unit

progressIndicator

Show asynchronous progress indicator while performing some action.

fun <T> progressIndicator(action: ProgressIndicator.() -> T): T

progressLogger

Show synchronous progress logger while performing some action.

fun <T> progressLogger(action: ProgressLogger.() -> T): T

resolveFile

Resolve single file from defined repositories or by using defined file transfers.

fun resolveFile(value: Any): File
fun resolveFile(options: FileResolver.() -> Unit): File

resolveFiles

Resolve files from defined repositories or by using defined file transfers.

fun resolveFiles(options: FileResolver.() -> Unit): List<File>

retry

Factory method for configuration object determining how operation should be retried.

fun retry(configurer: Retry.() -> Unit): Retry

Factory method for configuration object determining that operation should not be retried.

fun retry(): Retry

sftpFile

Transfer files using over SFTP protocol using custom settings.

fun <T> sftpFile(consumer: SftpFileTransfer.() -> T): T

smbFile

Transfer files using over SMB protocol using custom settings.

fun <T> smbFile(consumer: SmbFileTransfer.() -> T): T

tasks

Allows to register tasks with hooks working nicely with task configuration avoidance.

fun tasks(configurer: TaskFacade.() -> Unit): Unit

temporaryFile

Determine temporary directory for particular service (any name).

fun temporaryFile(path: String): File

waitFor

Wait some time after performing asynchronous operation.

fun waitFor(time: Long): Unit

watchFiles

React on file changes under configured directories.

fun watchFiles(options: FileWatcher.() -> Unit): Unit

Companion Object Properties

NAME

const val NAME: String

TEMPORARY_DIR

const val TEMPORARY_DIR: String

Companion Object Functions

of

fun of(project: Project): CommonExtension