
public class CommonExtension

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Logger`	`logger`
`private final PropertyParser`	`prop`
`private final ObjectFactory`	`obj`
`private final ServiceAccessor`	`services`
`private final FileTransferManager`	`fileTransfer`
`private final NotifierFacade`	`notifier`
`private final TaskFacade`	`tasks`
`private final JavaSupport`	`javaSupport`
`private final UserInputHandler`	`userInput`
`private final File`	`temporaryDir`
`private final Parallel`	`parallel`
`private final Formats`	`formats`
`private final Patterns`	`patterns`
`private final BuildScope`	`buildScope`
`private final Project`	`project`

Constructor Summary

Constructors
Constructor	Description
`CommonExtension(Project project)`

Method Summary

Modifier and Type	Method	Description
`final Unit`	`fileTransfer(Function1<FileTransferManager, Unit> options)`	Configures file transfer facade.
`final Unit`	`notifier(Function1<NotifierFacade, Unit> configurer)`
`final Unit`	`tasks(Function1<TaskFacade, Unit> configurer)`	Allows to register tasks with hooks working nicely with task configuration avoidance.
`final Unit`	`javaSupport(Function1<JavaSupport, Unit> options)`
`final <T extends Any> LazyPublishArtifact`	`publicationArtifact(Provider<T> provider)`	Allows easily provide artifact in a lazy way (e.g via task provider).
`final LazyPublishArtifact`	`publicationArtifact(String taskPath)`	Allows easily provide artifact in a lazy way (e.g via task provider).
`final <T extends Any> T`	`progress(Integer total, Function1<ProgressIndicator, T> action)`	Show asynchronous 0 indicator with percentage while performing some action.
`final <T extends Any> T`	`progress(Long total, Function1<ProgressIndicator, T> action)`	Show asynchronous progress indicator with percentage while performing some action.
`final <T extends Any> T`	`progress(Function1<ProgressIndicator, T> action)`
`final <T extends Any> T`	`progressIndicator(Function1<ProgressIndicator, T> action)`	Show asynchronous progress indicator while performing some action.
`final <T extends Any> T`	`progressLogger(Function1<ProgressLogger, T> action)`	Show synchronous progress logger while performing some action.
`final Unit`	`waitFor(Long time)`	Wait some time after performing asynchronous operation.
`final Unit`	`progressCountdown(Long time)`	Show synchronous progress countdown / time to wait after performing asynchronous operation.
`final Unit`	`progressCountdown(Function1<ProgressCountdown, Unit> options)`	Show synchronous progress countdown / time to wait after performing asynchronous operation.
`final File`	`temporaryFile(String path)`	Determine temporary directory for particular service (any name).
`final String`	`checksumFile(File file, Boolean recalculate)`	Get or compute MD5 checksum of file interactively.
`final File`	`recentFile(String dirPath, Iterable<String> filePatterns)`	Get recent file from directory
`final File`	`recentFile(File dir, Iterable<String> filePatterns)`	Get recent file from directory
`final Provider<File>`	`recentFileProvider(String dirPath, Iterable<String> filePatterns)`	Get recent file from directory
`final Provider<File>`	`recentFileProvider(File dir, Iterable<String> filePatterns)`	Get recent file from directory
`final ConfigurableFileCollection`	`recentFiles(Array<Out File> dirs, Iterable<String> filePatterns)`	Get recent files built in directories as file collection.
`final ConfigurableFileCollection`	`recentFiles(Iterable<File> dirs, Iterable<String> filePatterns)`	Get recent files built in directories as file collection.
`final ConfigurableFileCollection`	`providedFiles(Array<Out Provider<File>> providers)`	Returns file collection with providers returning any value (avoids exception).
`final ConfigurableFileCollection`	`providedFiles(Iterable<Provider<File>> providers)`	Returns file collection with providers returning any value (avoids exception).
`final Retry`	`retry(Function1<Retry, Unit> options)`	Factory method for configuration object determining how operation should be retried.
`final Unit`	`watchFiles(Function1<FileWatcher, Unit> options)`	React on file changes under configured directories.
`final File`	`resolveFile(Object value)`	Resolve single file from defined repositories or by using defined file transfers.
`final File`	`resolveFile(Function1<FileResolver, Unit> options)`	Resolve single file from defined repositories or by using defined file transfers.
`final List<File>`	`resolveFiles(Array<Out Any> values)`	Resolve files from defined repositories or by using defined file transfers.
`final List<File>`	`resolveFiles(Iterable<Any> values)`	Resolve files from defined repositories or by using defined file transfers.
`final List<File>`	`resolveFiles(Function1<FileResolver, Unit> options)`	Resolve files from defined repositories or by using defined file transfers.
`final <T extends Any> T`	`http(Function1<HttpClient, T> consumer)`	Perform any HTTP requests to external endpoints.
`final <T extends Any> T`	`httpFile(Function1<HttpFileTransfer, T> consumer)`	Download files using HTTP protocol using custom settings.
`final <T extends Any> T`	`sftpFile(Function1<SftpFileTransfer, T> consumer)`	Transfer files using over SFTP protocol using custom settings.
`final <T extends Any> T`	`smbFile(Function1<SmbFileTransfer, T> consumer)`	Transfer files using over SMB protocol using custom settings.
`final ZipFile`	`zip(File file)`	Utility to work with ZIP files (even big ones)
`final ZipFile`	`zip(String path)`	Utility to work with ZIP files (even big ones)
`final List<HealthStatus>`	`healthCheck(Function1<HealthChecker, Unit> options)`
`final Logger`	`getLogger()`
`final PropertyParser`	`getProp()`	Allows to read project property specified in command line and system property as a fallback.
`final ObjectFactory`	`getObj()`	Reduces boilerplate related to lazy configuration API
`final ServiceAccessor`	`getServices()`	Accessor for internal Gradle services.
`final FileTransferManager`	`getFileTransfer()`	Define settings for file transfer facade which allows to perform basic file operations on remote servers like uploading and downloading files.
`final NotifierFacade`	`getNotifier()`	Provides API for displaying interactive notification during running build tasks.
`final TaskFacade`	`getTasks()`
`final JavaSupport`	`getJavaSupport()`	Configure Java for running AEM instance and compilation.
`final UserInputHandler`	`getUserInput()`	Grab user input interactively.
`final File`	`getTemporaryDir()`
`final Parallel`	`getParallel()`
`final Formats`	`getFormats()`
`final Patterns`	`getPatterns()`
`final BuildScope`	`getBuildScope()`
`final Project`	`getProject()`

Methods inherited from class com.cognifide.gradle.common.CommonExtension
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- CommonExtension
```
CommonExtension(Project project)
```

Method Detail

fileTransfer

 final Unit fileTransfer(Function1<FileTransferManager, Unit> options)

Configures file transfer facade.

notifier

 final Unit notifier(Function1<NotifierFacade, Unit> configurer)

tasks
```
 final Unit tasks(Function1<TaskFacade, Unit> configurer)
```
Allows to register tasks with hooks working nicely with task configuration avoidance.

javaSupport

 final Unit javaSupport(Function1<JavaSupport, Unit> options)

publicationArtifact

 final <T extends Any> LazyPublishArtifact publicationArtifact(Provider<T> provider)

Allows easily provide artifact in a lazy way (e.g via task provider).

publicationArtifact
```
 final LazyPublishArtifact publicationArtifact(String taskPath)
```
Allows easily provide artifact in a lazy way (e.g via task provider).

progress

 final <T extends Any> T progress(Integer total, Function1<ProgressIndicator, T> action)

Show asynchronous 0 indicator with percentage while performing some action.

progress

 final <T extends Any> T progress(Long total, Function1<ProgressIndicator, T> action)

Show asynchronous progress indicator with percentage while performing some action.

progress

 final <T extends Any> T progress(Function1<ProgressIndicator, T> action)

progressIndicator

 final <T extends Any> T progressIndicator(Function1<ProgressIndicator, T> action)

Show asynchronous progress indicator while performing some action.

progressLogger

 final <T extends Any> T progressLogger(Function1<ProgressLogger, T> action)

Show synchronous progress logger while performing some action.

waitFor
```
 final Unit waitFor(Long time)
```
Wait some time after performing asynchronous operation.

progressCountdown
```
 final Unit progressCountdown(Long time)
```
Show synchronous progress countdown / time to wait after performing asynchronous operation.

progressCountdown
```
 final Unit progressCountdown(Function1<ProgressCountdown, Unit> options)
```
Show synchronous progress countdown / time to wait after performing asynchronous operation.

temporaryFile
```
 final File temporaryFile(String path)
```
Determine temporary directory for particular service (any name).

checksumFile

 final String checksumFile(File file, Boolean recalculate)

Get or compute MD5 checksum of file interactively.

recentFile

 final File recentFile(String dirPath, Iterable<String> filePatterns)

Get recent file from directory

recentFile

 final File recentFile(File dir, Iterable<String> filePatterns)

Get recent file from directory

recentFileProvider

 final Provider<File> recentFileProvider(String dirPath, Iterable<String> filePatterns)

Get recent file from directory

recentFileProvider

 final Provider<File> recentFileProvider(File dir, Iterable<String> filePatterns)

Get recent file from directory

recentFiles

 final ConfigurableFileCollection recentFiles(Array<Out File> dirs, Iterable<String> filePatterns)

Get recent files built in directories as file collection.

recentFiles

 final ConfigurableFileCollection recentFiles(Iterable<File> dirs, Iterable<String> filePatterns)

Get recent files built in directories as file collection.

providedFiles
```
 final ConfigurableFileCollection providedFiles(Array<Out Provider<File>> providers)
```
Returns file collection with providers returning any value (avoids exception).

providedFiles
```
 final ConfigurableFileCollection providedFiles(Iterable<Provider<File>> providers)
```
Returns file collection with providers returning any value (avoids exception).

retry
```
 final Retry retry(Function1<Retry, Unit> options)
```
Factory method for configuration object determining how operation should be retried.

watchFiles

 final Unit watchFiles(Function1<FileWatcher, Unit> options)

React on file changes under configured directories.

resolveFile
```
 final File resolveFile(Object value)
```
Resolve single file from defined repositories or by using defined file transfers.

resolveFile
```
 final File resolveFile(Function1<FileResolver, Unit> options)
```
Resolve single file from defined repositories or by using defined file transfers.

resolveFiles
```
 final List<File> resolveFiles(Array<Out Any> values)
```
Resolve files from defined repositories or by using defined file transfers.

resolveFiles
```
 final List<File> resolveFiles(Iterable<Any> values)
```
Resolve files from defined repositories or by using defined file transfers.

resolveFiles
```
 final List<File> resolveFiles(Function1<FileResolver, Unit> options)
```
Resolve files from defined repositories or by using defined file transfers.

http

 final <T extends Any> T http(Function1<HttpClient, T> consumer)

Perform any HTTP requests to external endpoints.

httpFile

 final <T extends Any> T httpFile(Function1<HttpFileTransfer, T> consumer)

Download files using HTTP protocol using custom settings.

sftpFile

 final <T extends Any> T sftpFile(Function1<SftpFileTransfer, T> consumer)

Transfer files using over SFTP protocol using custom settings.

smbFile

 final <T extends Any> T smbFile(Function1<SmbFileTransfer, T> consumer)

Transfer files using over SMB protocol using custom settings.

zip
```
 final ZipFile zip(File file)
```
Utility to work with ZIP files (even big ones)

zip
```
 final ZipFile zip(String path)
```
Utility to work with ZIP files (even big ones)

healthCheck

 final List<HealthStatus> healthCheck(Function1<HealthChecker, Unit> options)

getLogger
```
 final Logger getLogger()
```

getProp
```
 final PropertyParser getProp()
```
Allows to read project property specified in command line and system property as a fallback.

getObj
```
 final ObjectFactory getObj()
```
Reduces boilerplate related to lazy configuration API

getServices
```
 final ServiceAccessor getServices()
```
Accessor for internal Gradle services.

getFileTransfer
```
 final FileTransferManager getFileTransfer()
```
Define settings for file transfer facade which allows to perform basic file operations on remote servers like uploading and downloading files.

getNotifier
```
 final NotifierFacade getNotifier()
```
Provides API for displaying interactive notification during running build tasks.

getTasks
```
 final TaskFacade getTasks()
```

getJavaSupport
```
 final JavaSupport getJavaSupport()
```
Configure Java for running AEM instance and compilation.

getUserInput
```
 final UserInputHandler getUserInput()
```
Grab user input interactively.

getTemporaryDir
```
 final File getTemporaryDir()
```

getParallel
```
 final Parallel getParallel()
```

getFormats
```
 final Formats getFormats()
```

getPatterns
```
 final Patterns getPatterns()
```

getBuildScope
```
 final BuildScope getBuildScope()
```

getProject
```
 final Project getProject()
```

Class CommonExtension

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.cognifide.gradle.common.CommonExtension

Methods inherited from class java.lang.Object

Constructor Detail

CommonExtension

Method Detail

fileTransfer

notifier

tasks

javaSupport

publicationArtifact

publicationArtifact

progress

progress

progress

progressIndicator

progressLogger

waitFor

progressCountdown

progressCountdown

temporaryFile

checksumFile

recentFile

recentFile

recentFileProvider

recentFileProvider

recentFiles

recentFiles

providedFiles

providedFiles

retry

watchFiles

resolveFile

resolveFile

resolveFiles

resolveFiles

resolveFiles

http

httpFile

sftpFile

smbFile

zip

zip

healthCheck

getLogger

getProp

getObj

getServices

getFileTransfer

getNotifier

getTasks

getJavaSupport

getUserInput

getTemporaryDir

getParallel

getFormats

getPatterns

getBuildScope

getProject