aem-plugin

alltypes

abstract class AbstractAction : InstanceAction

AbstractAction(aem: AemExtension)
protected val aem: AemExtension
var enabled: Boolean
var notify: Boolean
fun notify(title: String, text: String, enabled: Boolean = this.notify): Unit

abstract class AbstractFileTransfer : FileTransferHandler, Serializable

AbstractFileTransfer(aem: AemExtension)
protected val aem: AemExtension
open fun deleteFrom(dirUrl: String, fileName: String): Unit
open fun download(fileUrl: String): Unit
fun downloader(): FileDownloader
open fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
open var enabled: Boolean
open fun list(dirUrl: String): List<FileEntry>
open val parallelable: Boolean
open fun stat(dirUrl: String, fileName: String): FileEntry?
open fun truncate(dirUrl: String): Unit
fun uploader(): FileUploader
open fun uploadTo(dirUrl: String, fileName: String, source: File): Unit

abstract class AbstractInstance : Instance

AbstractInstance(aem: AemExtension)
protected val aem: AemExtension
open val available: Boolean
fun awaitUp(options: AwaitUpAction.() -> Unit = {}): Unit
open lateinit var environment: String
open fun equals(other: Any?): Boolean
open fun hashCode(): Int
open lateinit var httpUrl: String
open lateinit var id: String
protected val logger: Logger!
open var name: String
open var properties: MutableMap<String, String?>
open fun property(key: String, value: String?): Unit
fun property(key: String): String?
fun reload(options: ReloadAction.() -> Unit = {}): Unit
fun reloadAndAwaitUp(): Unit
open val sync: InstanceSync
open val systemProperties: Map<String, String>
open val version: String
open val zoneId: ZoneId

class Action

Action(step: InstanceStep, status: Status)
val status: Status
val step: InstanceStep

open class AemDefaultTask : DefaultTask, AemTask

AemDefaultTask()
val aem: AemExtension
fun checkForce(): Unit
open fun projectEvaluated(): Unit
fun projectEvaluated(callback: () -> Unit): Unit
open fun projectsEvaluated(): Unit
fun projectsEvaluated(callback: () -> Unit): Unit
open fun taskGraphReady(graph: TaskExecutionGraph): Unit
fun taskGraphReady(callback: (TaskExecutionGraph) -> Unit): Unit

open class AemException : GradleException

AemException(message: String, cause: Throwable)
AemException(message: String)

class AemExtension : Serializable

AemExtension(project: Project)
val anyInstance: Instance
val authorInstance: Instance
val authorInstances: List<Instance>
fun authorInstances(consumer: (Instance) -> Unit): Unit
val availableInstance: Instance?
val baseName: String
val buildScope: BuildScope
val bundle: File
val bundles: List<File>
fun composePackage(definition: PackageDefinition.() -> Unit): File
val configCommonDir: File
val configDir: File
fun dependentBundles(task: Task): List<File>
fun dependentPackages(task: Task): List<File>
fun dockerDaemon(spec: DaemonSpec.() -> Unit): Unit
fun dockerRun(spec: RunSpec.() -> Unit): DockerResult
val env: String
val environment: Environment
fun environment(configurer: Environment.() -> Unit): Unit
val fileTransfer: FileTransferManager
fun fileTransfer(options: FileTransferManager.() -> Unit): Unit
val filter: FilterFile
fun filter(file: File): FilterFile
fun filter(path: String): FilterFile
fun filterInstances(nameMatcher: String = props.string("instance.name") ?: "$env-*"): List<Instance>
val formats: Formats
fun <T> http(consumer: HttpClient.() -> T): T
fun <T> httpFile(consumer: HttpFileTransfer.() -> T): T
fun instance(options: InstanceOptions.() -> Unit): Unit
fun instance(urlOrName: String): Instance
val instanceActions: InstanceActionPerformer
val instanceOptions: InstanceOptions
val instances: List<Instance>
fun instances(consumer: (Instance) -> Unit): Unit
fun instances(filter: String, consumer: (Instance) -> Unit): Unit
fun instances(urlsOrNames: Iterable<String>): List<Instance>
val javaPackages: List<String>
var lineSeparator: String
val lineSeparatorString: String
fun localInstance(options: LocalInstanceManager.() -> Unit): LocalInstanceManager
val localInstanceManager: LocalInstanceManager
val localInstances: List<LocalInstance>
fun localInstances(consumer: LocalInstance.() -> Unit): Unit
val logger: Logger!
val main: AemExtension
const val NAME: String
fun namedInstance(desiredName: String? = props.string("instance.name"), defaultName: String = "$env-*"): Instance
val notifier: NotifierFacade
fun notifier(configurer: NotifierFacade.() -> Unit): Unit
fun of(project: Project): AemExtension
val offline: Boolean
fun package(options: PackageOptions.() -> Unit): Unit
fun package(file: File): PackageFile
val package: File
val packageOptions: PackageOptions
val packages: List<File>
val parallel: Parallel
val patterns: Patterns
fun pkg(options: PackageOptions.() -> Unit): Unit
fun pkg(file: File): PackageFile
val pkg: File
fun <T> progress(total: Int, action: ProgressIndicator.() -> T): T
fun <T> progress(total: Long, action: ProgressIndicator.() -> T): T
fun <T> progress(action: ProgressIndicator.() -> T): T
fun progressCountdown(time: Long): Unit
fun progressCountdown(options: ProgressCountdown.() -> Unit): Unit
fun <T> progressIndicator(action: ProgressIndicator.() -> T): T
fun <T> progressLogger(action: ProgressLogger.() -> T): T
val project: Project
val projectMain: Project
val projectName: String
val projectPrefixes: List<String>
val props: PropertyParser
val publishInstance: Instance
val publishInstances: List<Instance>
fun publishInstances(consumer: Instance.() -> Unit): Unit
fun <T> rcp(options: RcpClient.() -> T): T
val remoteInstances: List<RemoteInstance>
fun remoteInstances(consumer: RemoteInstance.() -> Unit): Unit
fun resolveFile(value: Any): File
fun resolveFile(options: FileResolver.() -> Unit): File
fun resolveFiles(options: FileResolver.() -> Unit): List<File>
fun resolveFiles(downloadDir: File, options: FileResolver.() -> Unit): List<File>
fun retry(configurer: Retry.() -> Unit): Retry
fun retry(): Retry
fun <T> sftpFile(consumer: SftpFileTransfer.() -> T): T
fun <T> smbFile(consumer: SmbFileTransfer.() -> T): T
fun sync(action: InstanceSync.() -> Unit): Unit
fun <T> sync(instance: Instance, action: InstanceSync.() -> T): T
fun sync(instances: Iterable<Instance>, action: InstanceSync.() -> Unit): Unit
fun syncBundles(action: InstanceSync.(File) -> Unit): Unit
fun syncFiles(instances: Iterable<Instance>, packages: Iterable<File>, action: InstanceSync.(File) -> Unit): Unit
fun <T> syncInstance(instance: Instance, action: InstanceSync.() -> T): T
fun syncInstances(action: InstanceSync.() -> Unit): Unit
fun syncInstances(instances: Iterable<Instance>, action: InstanceSync.() -> Unit): Unit
fun syncPackages(action: InstanceSync.(File) -> Unit): Unit
val tasks: AemTaskFacade
fun tasks(configurer: AemTaskFacade.() -> Unit): Unit
const val TEMPORARY_DIR: String
fun temporaryDir(task: Task): File
fun temporaryDir(name: String): File
val temporaryDir: File
fun temporaryFile(name: String): File
val userInput: UserInputHandler
fun validatePackage(vararg packages: File, options: PackageValidator.() -> Unit): Unit
fun validatePackage(packages: Iterable<File>, options: PackageValidator.() -> Unit): Unit
fun vlt(command: String): VltSummary
fun <T> vlt(options: VltClient.() -> T): T
fun waitFor(time: Long): Unit
fun watchFiles(options: FileWatcher.() -> Unit): Unit

abstract class AemPlugin : Plugin<Project>

AemPlugin()
open fun apply(project: Project): Unit
class Build : Serializable

Build()
lateinit var gradleVersion: String
lateinit var pluginVersion: String

val BUILD: Build
abstract fun Project.configure(): Unit
val ID: String
val NAME: String
val NAME_WITH_VERSION: String
@Synchronized fun once(callback: (Build) -> Unit): Unit
const val PKG: String
protected fun Project.tasks(configurer: AemTaskFacade.() -> Unit): Unit
fun withId(project: Project, id: String): List<Project>

interface AemTask : Task

abstract val aem: AemExtension
const val GROUP: String
open fun projectEvaluated(): Unit
open fun projectsEvaluated(): Unit
open fun taskGraphReady(graph: TaskExecutionGraph): Unit
fun temporaryDir(project: Project, taskName: String): File
fun temporaryDir(project: Project, taskName: String, path: String): File
fun temporaryFile(project: Project, taskName: String, name: String): File

class AemTaskFacade : Serializable

AemTaskFacade(aem: AemExtension)
val aem: AemExtension
fun bundleCompose(configurer: BundleCompose.() -> Unit): TaskProvider<BundleCompose>
fun bundleEmbed(dependencyOptions: DependencyOptions.() -> Unit, export: Boolean, pkgs: Iterable<String>): Unit
fun bundleEmbed(dependencyNotation: Any, export: Boolean, pkgs: Iterable<String>): Unit
fun bundleExportEmbed(dependencyNotation: Any, vararg pkgs: String): Unit
fun bundleExportEmbed(dependencyNotation: Any, pkgs: Iterable<String>): Unit
fun bundlePrivateEmbed(dependencyNotation: Any, vararg pkgs: String): Unit
fun bundlePrivateEmbed(dependencyNotation: Any, pkgs: Iterable<String>): Unit
val bundles: List<BundleCompose!>
val checks: List<Task>
fun debug(configurer: Debug.() -> Unit): TaskProvider<Debug>
fun destroy(configurer: Destroy.() -> Unit): TaskProvider<Destroy>
fun down(configurer: Down.() -> Unit): TaskProvider<Down>
fun environmentAwait(configurer: EnvironmentAwait.() -> Unit): TaskProvider<EnvironmentAwait>
fun environmentDestroy(configurer: EnvironmentDestroy.() -> Unit): TaskProvider<EnvironmentDestroy>
fun environmentDev(configurer: EnvironmentDev.() -> Unit): TaskProvider<EnvironmentDev>
fun environmentDown(configurer: EnvironmentDown.() -> Unit): TaskProvider<EnvironmentDown>
fun environmentHosts(configurer: EnvironmentHosts.() -> Unit): TaskProvider<EnvironmentHosts>
fun environmentRestart(configurer: EnvironmentRestart.() -> Unit): TaskProvider<EnvironmentRestart>
fun environmentUp(configurer: EnvironmentUp.() -> Unit): TaskProvider<EnvironmentUp>
fun <reified T : Task> get(path: String): T
fun <T : Task> get(path: String, type: Class<T>): T
fun <reified T : Task> getAll(): List<T!>
fun <T : Task> getAll(type: Class<T>): List<T!>
fun instanceAwait(configurer: InstanceAwait.() -> Unit): TaskProvider<InstanceAwait>
fun instanceBackup(configurer: InstanceBackup.() -> Unit): TaskProvider<InstanceBackup>
fun instanceCreate(configurer: InstanceCreate.() -> Unit): TaskProvider<InstanceCreate>
fun instanceDestroy(configurer: InstanceDestroy.() -> Unit): TaskProvider<InstanceDestroy>
fun instanceDown(configurer: InstanceDown.() -> Unit): TaskProvider<InstanceDown>
fun instanceProvision(configurer: InstanceProvision.() -> Unit): TaskProvider<InstanceProvision>
fun instanceReload(configurer: InstanceReload.() -> Unit): TaskProvider<InstanceReload>
fun instanceResetup(configurer: InstanceResetup.() -> Unit): TaskProvider<InstanceResetup>
fun instanceRestart(configurer: InstanceRestart.() -> Unit): TaskProvider<InstanceRestart>
val instanceSatisfy: InstanceSatisfy
fun instanceSatisfy(configurer: InstanceSatisfy.() -> Unit): TaskProvider<InstanceSatisfy>
fun instanceSetup(configurer: InstanceSetup.() -> Unit): TaskProvider<InstanceSetup>
fun instanceTail(configurer: InstanceTail.() -> Unit): TaskProvider<InstanceTail>
fun instanceUp(configurer: InstanceUp.() -> Unit): TaskProvider<InstanceUp>
fun named(name: String): TaskProvider<Task>
inline fun <reified T : Task> named(name: String, noinline configurer: T.() -> Unit = {}): TaskProvider<T>
fun <T : Task> named(name: String, type: Class<T>, configurer: T.() -> Unit): TaskProvider<T>
fun packageActivate(configurer: PackageActivate.() -> Unit): TaskProvider<PackageActivate>
fun packageCompose(configurer: PackageCompose.() -> Unit): TaskProvider<PackageCompose>
fun packageDelete(configurer: PackageDelete.() -> Unit): TaskProvider<PackageDelete>
fun packageDeploy(configurer: PackageDeploy.() -> Unit): TaskProvider<PackageDeploy>
fun packageInstall(configurer: PackageInstall.() -> Unit): TaskProvider<PackageInstall>
fun packagePurge(configurer: PackagePurge.() -> Unit): TaskProvider<PackagePurge>
val packages: List<PackageCompose!>
fun packageUninstall(configurer: PackageUninstall.() -> Unit): TaskProvider<PackageUninstall>
fun packageUpload(configurer: PackageUpload.() -> Unit): TaskProvider<PackageUpload>
fun pathed(path: String): TaskProvider<Task>
fun pathed(paths: Collection<Any>): List<TaskProvider<out Task>>
val project: Project
fun rcp(configurer: Rcp.() -> Unit): TaskProvider<Rcp>
inline fun <reified T : Task> register(name: String, noinline configurer: T.() -> Unit = {}): TaskProvider<T>
fun <T : Task> register(name: String, clazz: Class<T>, configurer: T.() -> Unit = {}): TaskProvider<T>
fun register(name: String, configurer: AemDefaultTask.() -> Unit): Unit
inline fun <reified T : Task> registerOrConfigure(name: String, noinline configurer: T.() -> Unit = {}): TaskProvider<T>
inline fun <reified T : Task> registerOrConfigure(vararg names: String, noinline configurer: T.() -> Unit = {}): Unit
fun registerSequence(name: String, sequenceOptions: TaskSequence.() -> Unit): TaskProvider<Task>
fun registerSequence(name: String, taskOptions: Task.() -> Unit, sequenceOptions: TaskSequence.() -> Unit): TaskProvider<Task>
fun resetup(configurer: Resetup.() -> Unit): TaskProvider<Resetup>
fun restart(configurer: Restart.() -> Unit): TaskProvider<Restart>
fun setup(configurer: Setup.() -> Unit): TaskProvider<Setup>
fun sync(configurer: Sync.() -> Unit): TaskProvider<Sync>
val tests: List<Test!>
inline fun <reified T : Task> typed(noinline configurer: T.() -> Unit): Unit
fun <T : Task> typed(type: Class<T>, configurer: T.() -> Unit): Unit
fun up(configurer: Up.() -> Unit): TaskProvider<Up>
fun vlt(configurer: Vlt.() -> Unit): TaskProvider<Vlt>

abstract class AnyInstanceAction : AbstractAction

AnyInstanceAction(aem: AemExtension)
var instances: List<Instance>

open class Await : AemDefaultTask

Await()
const val NAME: String

class AwaitDownAction : LocalInstanceAction

AwaitDownAction(aem: AemExtension)
fun perform(): Unit
fun timeout(options: TimeoutCheck.() -> Unit): Unit
fun unavailable(options: UnavailableCheck.() -> Unit): Unit
fun unchanged(options: UnchangedCheck.() -> Unit): Unit

class AwaitUpAction : AnyInstanceAction

AwaitUpAction(aem: AemExtension)
fun bundles(options: BundlesCheck.() -> Unit): Unit
fun components(options: ComponentsCheck.() -> Unit): Unit
fun events(options: EventsCheck.() -> Unit): Unit
fun perform(): Unit
fun timeout(options: TimeoutCheck.() -> Unit): Unit
fun unchanged(options: UnchangedCheck.() -> Unit): Unit

class BackupResolver

BackupResolver(aem: AemExtension)
val any: File?
var downloadUrl: String?
val local: File?
var localDir: File
var namer: () -> String
val remote: File?
var remoteDir: File
var selector: Collection<BackupSource>.() -> BackupSource?
var suffix: String
var uploadUrl: String?

class BackupSource

BackupSource(type: BackupType, fileEntry: FileEntry, fileResolver: () -> File)
val file: File
val fileEntry: FileEntry
val fileResolver: () -> File
val type: BackupType

enum class BackupType

LOCAL
REMOTE

abstract class Base : Runtime

Base(aem: AemExtension)
protected val aem: AemExtension
protected val logger: Logger!
open fun toString(): String

object Behaviors

class Timer

Timer()
val elapsed: Long
fun reset(): Unit
val started: Long
fun tick(): Unit
val ticks: Long

fun waitFor(duration: Int): Unit
fun waitFor(duration: Long): Unit
fun waitUntil(interval: Int, condition: (Timer) -> Boolean): Unit
fun waitUntil(interval: Long, condition: (Timer) -> Boolean): Unit
fun waitUntil(interval: (Long) -> Long, condition: (Timer) -> Boolean): Unit

class BuildResponse

var isSuccess: Boolean
lateinit var msg: String
lateinit var path: String

class BuildScope

BuildScope()
@Synchronized fun doOnce(operation: String, action: () -> Unit): Boolean?
fun <T : Any> get(key: String): T?
fun <T : Any> getOrPut(key: String, defaultValue: () -> T): T
fun <T : Any> getOrPut(key: String, defaultValue: () -> T, invalidate: Boolean): T
fun of(project: Project): BuildScope
fun <T : Any> put(key: String, value: T): Unit
fun <T : Any> tryGetOrPut(key: String, defaultValue: () -> T?): T?

class Bundle

Bundle()
const val ATTRIBUTE_ACTIVATOR: String
const val ATTRIBUTE_CATEGORY: String
const val ATTRIBUTE_CONTRIBUTORS: String
const val ATTRIBUTE_COPYRIGHT: String
const val ATTRIBUTE_DESCRIPTION: String
const val ATTRIBUTE_DEVELOPERS: String
const val ATTRIBUTE_DOC_URL: String
const val ATTRIBUTE_EXPORT_PACKAGE: String
const val ATTRIBUTE_FRAGMENT_HOST: String
const val ATTRIBUTE_IMPORT_PACKAGE: String
const val ATTRIBUTE_LICENSE: String
const val ATTRIBUTE_NAME: String
const val ATTRIBUTE_PRIVATE_PACKAGE: String
const val ATTRIBUTE_SLING_MODEL_PACKAGES: String
const val ATTRIBUTE_SYMBOLIC_NAME: String
const val ATTRIBUTE_VENDOR: String
const val ATTRIBUTE_VERSION: String
fun equals(other: Any?): Boolean
var fragment: Boolean
fun hashCode(): Int
lateinit var id: String
lateinit var name: String
val stable: Boolean
val state: String
var stateRaw: Int
lateinit var symbolicName: String
fun toString(): String
lateinit var version: String

open class BundleCompose : Jar, AemTask

BundleCompose()
var activator: String?
val ACTIVATOR_CLASSES: List<String>
val aem: AemExtension
fun attribute(name: String, value: String?): Manifest!
fun attribute(name: String): String?
var attributes: MutableMap<String, Any?>
var attributesConvention: Boolean
fun bndTool(options: BundleTaskConvention.() -> Unit): Unit
val bundleConvention: BundleTaskConvention
var category: String?
val composedDir: File
val composedFile: File
var contributors: String?
protected open fun copy(): Unit
var copyright: String?
var developers: String?
var displayName: String?
var docUrl: String?
fun excludePackage(pkgs: Iterable<String>): Unit
fun excludePackage(vararg pkgs: String): Unit
fun exportPackage(pkgs: Iterable<String>): Unit
fun exportPackage(vararg pkgs: String): Unit
var exportPackages: List<String>
var fragmentHost: String?
fun hasAttribute(name: String): Boolean
fun importPackage(pkgs: Iterable<String>): Unit
fun importPackage(vararg pkgs: String): Unit
var importPackages: List<String>
var installPath: String
var installRunMode: String?
val javaConvention: JavaPluginConvention!
var javaPackage: String?
var javaPackageOptions: String
var license: String?
const val NAME: String
fun privatePackage(pkgs: Iterable<String>): Unit
fun privatePackage(vararg pkgs: String): Unit
var privatePackages: List<String>
open fun projectEvaluated(): Unit
var slingModelPackages: String?
val SOURCE_SETS: Map<String, String>
var symbolicName: String?
var vaultFilter: Boolean
var vendor: String?
fun wildcardPackage(pkgs: Iterable<String>): List<String>
fun wildcardPackage(vararg pkgs: String): List<String>

class BundleDependency

BundleDependency(aem: AemExtension, notation: Any, installPath: String, vaultFilter: Boolean)
val file: File
var installPath: String
var vaultFilter: Boolean

class BundleException : AemException

BundleException(message: String, cause: Throwable)
BundleException(message: String)

class BundleException : AemException

BundleException(message: String, cause: Throwable)
BundleException(message: String)

class BundleFile : Serializable

BundleFile(file: File)
val description: String
val file: File
val group: String
val jar: Jar
val symbolicName: String
fun toString(): String
val version: String

open class BundleInstall : BundleTask

BundleInstall()
var awaited: Boolean
fun awaitUp(options: AwaitUpAction.() -> Unit): Unit
fun awaitUp(): Unit
var completer: () -> Unit
var finalizer: InstanceSync.() -> Unit
var initializer: InstanceSync.() -> Unit
open fun install(): Unit
const val NAME: String
var refreshPackages: Boolean
var retry: Retry
var start: Boolean
var startLevel: Int

class BundlePlugin : AemPlugin

BundlePlugin()
fun Project.configure(): Unit
const val ID: String

class BundlesCheck : DefaultCheck

BundlesCheck(group: CheckGroup)
fun check(): Unit
var symbolicNamesIgnored: List<String>

class BundleState

val activeBundles: Int
val activeFragments: Int
lateinit var bundles: List<Bundle>
fun bundlesExcept(symbolicNames: Iterable<String>): List<Bundle>
fun equals(other: Any?): Boolean
fun hashCode(): Int
val installedBundles: Int
val resolvedBundles: Int
val stable: Boolean
fun stable(symbolicNames: Iterable<String>): Boolean
fun stable(symbolicName: String): Boolean
fun stableExcept(symbolicNames: Iterable<String>): Boolean
fun stableExcept(symbolicName: String): Boolean
val stablePercent: String
lateinit var stats: List<Int>
val statsWithLabels: String
lateinit var status: String
fun toString(): String
val total: Int
val unknown: Boolean
fun unknown(e: Exception): BundleState

open class BundleTask : AemDefaultTask

BundleTask()
fun bundle(path: String): Unit
var bundles: List<File>
fun instance(urlOrName: String): Unit
var instances: List<Instance>
open fun projectsEvaluated(): Unit

open class BundleUninstall : BundleTask

BundleUninstall()
const val NAME: String
fun uninstall(): Unit

interface Check

abstract fun check(): Unit
open val failure: Boolean
abstract val status: String
abstract val success: Boolean

class CheckAction : AnyInstanceAction

CheckAction(aem: AemExtension)
fun perform(): Unit
val runner: CheckRunner
fun runner(options: CheckRunner.() -> Unit): Unit

class CheckFactory

CheckFactory(group: CheckGroup)
fun bundles(options: BundlesCheck.() -> Unit): BundlesCheck
fun components(options: ComponentsCheck.() -> Unit): ComponentsCheck
fun custom(callback: CustomCheck.() -> Unit): CustomCheck
fun events(options: EventsCheck.() -> Unit): EventsCheck
val group: CheckGroup
fun timeout(options: TimeoutCheck.() -> Unit): TimeoutCheck
fun unavailable(options: UnavailableCheck.() -> Unit): UnavailableCheck
fun unchanged(options: UnchangedCheck.() -> Unit): UnchangedCheck

class CheckGroup

CheckGroup(runner: CheckRunner, instance: Instance, checkFactory: CheckFactory.() -> List<Check>)
fun check(): Unit
var checks: List<Check>
val done: Boolean
val instance: Instance
fun log(): Unit
val runner: CheckRunner
fun state(value: Any): Unit
val state: Int
val stateBuilder: HashCodeBuilder
val statusLogger: CollectingLogger
val summary: String

class CheckProgress

CheckProgress(instance: Instance)
var currentCheck: CheckGroup?
var previousCheck: CheckGroup?
val stateChanged: Boolean
var stateChanges: Int
val stateTime: Long
val summary: String

class CheckRunner

CheckRunner(aem: AemExtension)
var abortCause: Exception?
val aborted: Boolean
fun check(instances: Collection<Instance>): Unit
fun checks(definitions: CheckFactory.() -> List<Check>): Unit
var delay: Long
var logInstantly: Boolean
fun progress(instance: Instance): CheckProgress
val runningTime: Long
var verbose: Boolean

class Cleaner

Cleaner(aem: AemExtension)
fun beforeClean(root: File): Unit
fun clean(root: File): Unit
fun cleanNamespaces(lines: List<String>): List<String>
val CONTENT_PROP_PATTERN: Pattern
var contentProcess: (File, List<String>) -> List<String>
var filesDeleted: PatternFilterable.() -> Unit
var filesDotContent: PatternFilterable.() -> Unit
var filesFlattened: PatternFilterable.() -> Unit
const val JCR_CONTENT_FILE: String
const val JCR_MIXIN_TYPES_PROP: String
const val JCR_ROOT_PREFIX: String
var lineProcess: (File, String) -> String
fun mergeSinglePropertyLines(lines: List<String>): MutableList<String>
var mixinTypesSkipped: List<String>
val NAMESPACE_PATTERN: Pattern
var namespacesSkipped: Boolean
fun normalizeContent(file: File, lines: List<String>): List<String>
fun normalizeLine(file: File, line: String): String
fun normalizeMixins(file: File, line: String): String
var parentsBackupEnabled: Boolean
var parentsBackupSuffix: String
fun pathRule(pattern: String, excludedPaths: List<String>): String
fun pathRule(pattern: String, excludedPaths: List<String>, includedPaths: List<String>): String
fun prepare(root: File): Unit
var propertiesSkipped: List<String>
fun skipProperties(file: File, line: String): String

class CleanerRule

CleanerRule(value: String)
const val EXCLUDE_FLAG: String
fun manyFrom(props: List<String>): List<CleanerRule>
fun match(file: File, value: String): Boolean
const val PATH_DELIMITER: String
const val PATHS_DELIMITER: String

class CollectingLogger

CollectingLogger()
fun debug(message: String): Unit
fun debug(summary: String, details: String): Unit
val entries: MutableList<LogEntry>
fun error(message: String): Unit
fun error(summary: String, details: String): Unit
fun info(message: String): Unit
fun info(summary: String, details: String): Unit
fun lifecycle(message: String): Unit
fun lifecycle(summary: String, details: String): Unit
fun log(level: LogLevel, details: String, summary: String? = null): Unit
data class LogEntry

LogEntry(level: LogLevel, details: String, summary: String? = null)
val details: String
val level: LogLevel
val summary: String?

fun logTo(logger: Logger, levelMapper: (LogLevel) -> LogLevel = { it }): Unit
fun warn(message: String): Unit
fun warn(summary: String, details: String): Unit

class CommonPlugin : AemPlugin

CommonPlugin()
fun Project.configure(): Unit
const val ID: String
const val STRUCTURE_PROPERTIES_FILE: String

class Component

Component()
val active: Boolean
var bundleId: Int?
val disabled: Boolean
fun equals(other: Any?): Boolean
val failedActivation: Boolean
fun hashCode(): Int
lateinit var id: String
lateinit var name: String
val noConfig: Boolean
val notUnsatisfied: Boolean
var pid: String?
val satisfied: Boolean
lateinit var state: String
val STATE_ACTIVE: String
val STATE_DISABLED: String
val STATE_NO_CONFIG: String
val STATE_RAW_ACTIVE: Int
val STATE_RAW_DISABLED_OR_NO_CONFIG: Int
val STATE_RAW_FAILED_ACTIVATION: Int
val STATE_RAW_SATISTIED: Int
val STATE_RAW_UNSATISFIED: Int
val STATE_SATISFIED: String
var stateRaw: Int
fun toString(): String
val uid: String
val unsatisfied: Boolean

class ComponentsCheck : DefaultCheck

ComponentsCheck(group: CheckGroup)
fun check(): Unit
var platformComponents: List<String>
var specificComponents: List<String>

class ComponentState

fun check(pids: Collection<String>, predicate: (Component) -> Boolean): Boolean
fun check(pids: Collection<String>, ignoredPids: Collection<String>, predicate: (Component) -> Boolean): Boolean
lateinit var components: List<Component>
fun equals(other: Any?): Boolean
fun find(pids: Collection<String>): List<Component>
fun find(pids: Collection<String>, ignoredPids: Collection<String>): List<Component>
fun hashCode(): Int
fun toString(): String
var total: Int
val unknown: Boolean
fun unknown(): ComponentState

class Condition

Condition(step: InstanceStep)
fun always(): Boolean
fun failSafeOnce(): Boolean
val instance: Instance
fun never(): Boolean
fun once(): Boolean
fun repeatAfter(millis: Long): Boolean
fun repeatAfterDays(count: Long): Boolean
fun repeatAfterHours(count: Long): Boolean
fun repeatAfterMinutes(count: Long): Boolean
fun repeatAfterSeconds(count: Long): Boolean
fun repeatEvery(counterPredicate: (Long) -> Boolean): Boolean
fun repeatEvery(times: Long): Boolean
fun repeatProbably(probability: Double): Boolean
fun rerunOnFail(): Boolean
fun sinceEndedMoreThan(millis: Long): Boolean
val step: InstanceStep
fun ultimateOnce(): Boolean

class Configuration

Configuration()
var bundleLocation: String?
class ConfigurationProperty

ConfigurationProperty()
val value: Any?

const val DESCRIPTION_METATYPE_ABSENCE: String
fun equals(other: Any?): Boolean
fun hashCode(): Int
val metatypeAbsence: Boolean
lateinit var pid: String
val properties: Map<String, Any?>
var serviceLocation: String?
fun toString(): String

class ConfigurationState

ConfigurationState()
class Pid

Pid()
var fpid: String?
var hasConfig: Boolean
lateinit var id: String
lateinit var name: String
var nameHint: String?

lateinit var pids: List<Pid>
fun toString(): String
val unknown: Boolean
fun unknown(): ConfigurationState

class ConsolePrinter

ConsolePrinter(instance: InstanceLogInfo, log: (String) -> Unit, incidentMaxAgeInMillis: Long = 5000)
fun dump(newLogs: List<Log>): Unit
fun none(): ConsolePrinter

class Container

Container(docker: Docker, name: String)
val aem: AemExtension
fun await(): Unit
var awaitRetry: Retry
fun cleanDir(vararg paths: String): Unit
fun dev(options: DevOptions.() -> Unit): Unit
val devOptions: DevOptions
val docker: Docker
fun ensureDir(vararg paths: String): Unit
fun exec(execSpec: ExecSpec.() -> Unit): DockerResult
fun exec(command: String, exitCode: Int? = 0): DockerResult
fun exec(operation: String, command: String, exitCode: Int? = 0): DockerResult
fun execShell(command: String, exitCode: Int? = 0): DockerResult
fun execShell(operation: String, command: String, exitCode: Int? = 0): DockerResult
fun execShellQuiet(command: String, exitCode: Int? = 0): DockerResult
val host: HostFileManager
fun host(options: HostFileManager.() -> Unit): Unit
val id: String?
val internalName: String
fun isLocked(name: String): Boolean
fun lock(name: String): Unit
const val LOCK_ROOT: String
const val LOCK_UP: String
val name: String
fun reload(action: Container.() -> Unit): Unit
fun reload(): Unit
var reloadAction: Container.() -> Unit
fun resolve(action: HostFileManager.() -> Unit): Unit
fun resolve(): Unit
var resolveAction: HostFileManager.() -> Unit
val running: Boolean
var runningTimeout: Long
fun up(action: Container.() -> Unit): Unit
fun up(): Unit
val up: Boolean
var upAction: Container.() -> Unit

class ContainerException : DockerException

ContainerException(message: String, cause: Throwable)
ContainerException(message: String)

class ContainerFileEvent

ContainerFileEvent(container: Container, event: Event)
val container: Container
val event: Event

class ContainerManager

ContainerManager(docker: Docker)
fun define(name: String, definition: Container.() -> Unit): Container
val defined: MutableList<Container>
operator fun String.invoke(definition: Container.() -> Unit): Container
fun named(name: String): Container
fun reload(): Unit
fun resolve(): Unit
val running: Boolean
val up: Boolean
fun up(): Unit
fun use(name: String, action: Container.() -> Unit): Unit

class Crx : InstanceService

Crx(sync: InstanceSync)
const val EXPORT_NODE_TYPE_PATH: String
const val NODE_TYPES_UNKNOWN: String
val nodeTypes: String
fun readNodeTypes(): String

class CrxException : InstanceException

CrxException(message: String, cause: Throwable)
CrxException(message: String)

class CustomCheck : DefaultCheck

CustomCheck(group: CheckGroup, callback: CustomCheck.() -> Unit)
fun check(): Unit

class CustomFileTransfer : ProtocolFileTransfer

CustomFileTransfer(aem: AemExtension)
fun delete(callback: (dirUrl: String, fileName: String) -> Unit): Unit
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun download(callback: (dirUrl: String, fileName: String, target: File) -> Unit): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun exists(callback: (dirUrl: String, fileName: String) -> Boolean): Unit
fun exists(dirUrl: String, fileName: String): Boolean
fun list(callback: (dirUrl: String) -> List<FileEntry>): Unit
fun list(dirUrl: String): List<FileEntry>
lateinit var name: String
var parallelable: Boolean
lateinit var protocols: List<String>
fun truncate(callback: (dirUrl: String) -> Unit): Unit
fun truncate(dirUrl: String): Unit
fun upload(callback: (dirUrl: String, fileName: String, target: File) -> Unit): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit

class DaemonSpec : RunSpec

DaemonSpec(aem: AemExtension)
var id: String?
var initTime: Long
val outputFile: File!
var stopPrevious: Boolean
var unique: Boolean

open class Debug : AemDefaultTask

Debug()
val buildProperties: Map<String, Any>
fun debug(): Unit
val file: File
const val NAME: String
var packageDeployed: Boolean
val packageProperties: Map<String, Package?>
val projectProperties: Map<String, String>
val properties: Map<String, Any>

abstract class DefaultCheck : Check

DefaultCheck(group: CheckGroup)
protected val aem: AemExtension
protected val group: CheckGroup
val instance: Instance
const val LOG_VALUES_COUNT: Int
fun logValues(values: Collection<Any>): String
val progress: CheckProgress
val runner: CheckRunner
fun <T : Any> state(value: T): T
open val status: String
val statusLogger: CollectingLogger
open val success: Boolean
var sync: InstanceSync

class DelegatingFileAlterationListener : FileAlterationListener

DelegatingFileAlterationListener(notify: (Event) -> Unit)
fun onDirectoryChange(directory: File?): Unit
fun onDirectoryCreate(directory: File): Unit
fun onDirectoryDelete(directory: File): Unit
fun onFileChange(file: File): Unit
fun onFileCreate(file: File): Unit
fun onFileDelete(file: File): Unit
fun onStart(observer: FileAlterationObserver?): Unit
fun onStop(observer: FileAlterationObserver?): Unit

class DeleteResponse : HtmlResponse

fun from(input: InputStream, bufferSize: Int): DeleteResponse
protected fun getErrorPatterns(): List<ErrorPattern>
val status: Status

class DependencyOptions

DependencyOptions()
fun add(aem: AemExtension, configuration: String, options: DependencyOptions.() -> Unit): Unit
fun add(aem: AemExtension, configuration: String, notation: Any): Unit
var classifier: String?
var configuration: String?
fun create(aem: AemExtension, notation: Any): Dependency
fun create(aem: AemExtension, options: DependencyOptions.() -> Unit): Dependency
fun dependency(group: String, name: String, version: String? = null, configuration: String? = null, classifier: String? = null, ext: String? = null): Unit
var ext: String?
lateinit var group: String
fun isNotation(text: String): Boolean
lateinit var name: String
val notation: String
fun resolve(aem: AemExtension, notation: Any): File
var version: String?

class Desktop : Base

Desktop(aem: AemExtension)
fun determinePath(path: String): String
val hostInternalIp: String?
val hostIp: String
val name: String
const val NAME: String
val safeVolumes: Boolean

open class Destroy : AemDefaultTask

Destroy()
const val NAME: String

class DevOptions

DevOptions(container: Container)
val container: Container
fun watchConfigDir(vararg paths: String): Unit
fun watchDir(vararg files: File): Unit
var watchDirs: MutableList<File>

class Docker

Docker(environment: Environment)
val aem: AemExtension
val composeFile: File
val composeTemplateFile: File
val configPath: String
val containers: ContainerManager
fun containers(options: ContainerManager.() -> Unit): Unit
fun daemon(spec: DaemonSpec.() -> Unit): Unit
fun down(): Unit
val environment: Environment
fun init(): Unit
fun reload(): Unit
val rootPath: String
fun run(spec: RunSpec.() -> Unit): DockerResult
fun run(image: String, command: String, exitCode: Int = 0): DockerResult
fun run(operation: String, image: String, command: String, exitCode: Int = 0): DockerResult
val running: Boolean
fun runShell(image: String, command: String, exitCode: Int = 0): DockerResult
fun runShell(operation: String, image: String, command: String, exitCode: Int = 0): DockerResult
val runtime: Runtime
val stack: Stack
val up: Boolean
fun up(): Unit

class DockerCustomSpec : DockerSpec

DockerCustomSpec(base: DockerDefaultSpec, argsOverride: List<String>)
val args: List<String>
val argsOverride: List<String>
val base: DockerDefaultSpec

open class DockerDefaultSpec : DockerSpec

DockerDefaultSpec(aem: AemExtension)
protected val aem: AemExtension
open val args: List<String>
open var command: String
open var errors: OutputStream?
fun exitCode(code: Int): Unit
open var exitCodes: List<Int>
open val fullCommand: String
open fun ignoreExitCodes(): Unit
open var input: InputStream?
open fun option(value: String): Unit
open var options: List<String>
open var output: OutputStream?

open class DockerException : AemException

DockerException(message: String, cause: Throwable)
DockerException(message: String)

object DockerProcess

const val COMMAND: String
fun exec(options: ProcBuilder.() -> Unit): ProcResult
fun execQuietly(options: ProcBuilder.() -> Unit): ProcResult
fun execSpec(spec: DockerSpec): DockerResult
fun execString(options: ProcBuilder.() -> Unit): String

class DockerResult

DockerResult(base: ProcResult)
val base: ProcResult
val errorBytes: ByteArray
val errorString: String
val executionTime: Long
val exitCode: Int
val outputBytes: ByteArray
val outputString: String
val procString: String

interface DockerSpec

abstract val args: List<String>
abstract var command: String
abstract var errors: OutputStream?
abstract var exitCodes: List<Int>
abstract val fullCommand: String
abstract fun ignoreExitCodes(): Unit
abstract var input: InputStream?
abstract fun option(value: String): Unit
abstract var options: List<String>
abstract var output: OutputStream?

class DorkboxNotifier : Notifier

DorkboxNotifier(aem: AemExtension, configurer: Notify.() -> Unit)
val aem: AemExtension
val configurer: Notify.() -> Unit
fun notify(title: String, text: String, level: LogLevel, onClick: (Notify) -> Unit): Unit

open class Down : AemDefaultTask

Down()
const val NAME: String

class Downloader

Downloader(aem: AemExtension)
fun download(): Unit
var extract: Boolean
var extractDir: File
var filter: FilterFile
var instance: Instance
var retry: Retry

class Environment : Serializable

Environment(aem: AemExtension)
val aem: AemExtension
fun check(verbose: Boolean = true): List<HealthStatus>
val configDir: File
val created: Boolean
fun destroy(): Unit
val docker: Docker
fun docker(options: Docker.() -> Unit): Unit
fun down(): Unit
const val ENVIRONMENT_DIR: String
var healthChecker: HealthChecker
fun healthChecks(options: HealthChecker.() -> Unit): Unit
val hosts: HostOptions
fun hosts(options: HostOptions.() -> Unit): Unit
fun hosts(vararg values: String): Unit
fun hosts(names: Iterable<String>): Unit
fun reload(): Unit
fun resolve(): Unit
fun restart(): Unit
var rootDir: File
val running: Boolean
fun toString(): String
val up: Boolean
fun up(): Unit

open class EnvironmentAwait : AemDefaultTask

EnvironmentAwait()
fun await(): Unit
const val NAME: String

open class EnvironmentDestroy : AemDefaultTask

EnvironmentDestroy()
fun destroy(): Unit
const val NAME: String
open fun taskGraphReady(graph: TaskExecutionGraph): Unit

open class EnvironmentDev : AemDefaultTask

EnvironmentDev()
fun dev(): Unit
const val NAME: String
val reloader: Reloader

open class EnvironmentDown : AemDefaultTask

EnvironmentDown()
fun down(): Unit
const val NAME: String

class EnvironmentException : AemException

EnvironmentException(message: String, cause: Throwable)
EnvironmentException(message: String)

open class EnvironmentHosts : AemDefaultTask

EnvironmentHosts()
fun appendHosts(): Unit
const val NAME: String

class EnvironmentPlugin : AemPlugin

EnvironmentPlugin()
fun Project.configure(): Unit
const val ID: String

open class EnvironmentReload : AemDefaultTask

EnvironmentReload()
const val NAME: String
fun reload(): Unit

open class EnvironmentResetup : AemDefaultTask

EnvironmentResetup()
const val NAME: String

open class EnvironmentResolve : AemDefaultTask

EnvironmentResolve()
const val NAME: String
fun resolve(): Unit

open class EnvironmentRestart : AemDefaultTask

EnvironmentRestart()
const val NAME: String

open class EnvironmentUp : AemDefaultTask

EnvironmentUp()
const val NAME: String
fun up(): Unit

data class ErrorPattern

ErrorPattern(pattern: Pattern, printStackTrace: Boolean, message: String = "")
val message: String
val pattern: Pattern
val printStackTrace: Boolean

class Event

Event(file: File, type: EventType)
val file: File
fun toString(): String
val type: EventType

class Event

Event()
var category: String?
val details: String
fun equals(other: Any?): Boolean
fun hashCode(): Int
lateinit var id: String
var info: String?
lateinit var received: String
val service: String?
lateinit var topic: String
fun toString(): String

class EventsCheck : DefaultCheck

EventsCheck(group: CheckGroup)
fun check(): Unit
const val EVENT_DETAILS_LENGTH: Int
var unstableAgeMillis: Long
var unstableTopics: List<String>

class EventState

fun equals(other: Any?): Boolean
lateinit var events: List<Event>
fun hashCode(): Int
fun matching(topics: Iterable<String>, ageMillis: Long, ageZoneId: ZoneId): List<Event>
lateinit var status: String
fun toString(): String
val unknown: Boolean
fun unknown(): EventState

enum class EventType

DIR_CREATED
DIR_DELETED
FILE_CHANGED
FILE_CREATED
FILE_DELETED

class ExecSpec : DockerDefaultSpec

ExecSpec(aem: AemExtension)
fun env(vars: Map<String, String>): Unit
fun env(varName: String, varValue: String): Unit
var indicator: Boolean
var operation: () -> String
fun operation(operation: () -> String): Unit
fun operation(text: String): Unit
fun privileged(): Unit
fun user(id: String): Unit
fun workDir(path: String): Unit

class FileContentReader : BaseFilterReader, ChainableReader

FileContentReader(input: Reader)
fun chain(reader: Reader): Reader
fun filter(filterable: ContentFilterable, filter: (String) -> String): Unit
fun props(filter: (String) -> String): Map<String, (String) -> String>
fun read(): Int

class FileDestination : LogDestination

FileDestination(instanceName: String, logFiles: LogFiles)
fun dump(logs: List<Log>): Unit

class FileDownloader

FileDownloader(aem: AemExtension)
fun download(size: Long, input: InputStream, target: File): Unit
const val KILOBYTE: Int
fun ProgressLogger.logProgress(operation: String, readLength: Long, fullLength: Long, file: File, startDownloadTime: Long): Unit
fun remainingDownloadTime(startDownloadTime: Long, fullLength: Long): Long
const val TRANSFER_CHUNK_100_KB: Int

data class FileEntry

FileEntry(name: String, size: Long? = null, modified: Long? = null)
val modified: Long?
val name: String
fun of(file: File): FileEntry
val size: Long?

open class FileException : AemException

FileException(message: String, cause: Throwable)
FileException(message: String)

open class FileGroup

FileGroup(aem: AemExtension, downloadDir: File, name: String)
val aem: AemExtension
protected open fun createResolution(id: String, resolver: (FileResolution) -> File): FileResolution
val dirs: List<File>
val downloadDir: File
val files: List<File>
val name: String
val resolutions: List<FileResolution>
fun resolve(id: String, resolver: (FileResolution) -> File): FileResolution
fun resolve(): List<File>

object FileOperations

fun amendFile(file: File, amender: (String) -> String): Unit
fun amendFiles(dir: File, wildcardFilters: List<String>, amender: (File, String) -> String): Unit
fun copyResources(resourceRoot: String, targetDir: File, skipExisting: Boolean = false): Unit
fun eachResource(resourceRoot: String, targetDir: File, callback: (String, File) -> Unit): Unit
fun find(project: Project, dirIfFileName: String, pathOrFileNames: List<String>): File?
fun find(project: Project, dirIfFileName: String, pathOrFileName: String): File?
fun find(dir: File, pattern: String): File?
fun find(dir: File, patterns: List<String>): File?
fun getResources(path: String): List<String>
fun isDirEmpty(dir: File): Boolean
fun isDirEmpty(dir: Path): Boolean
fun lock(file: File): Unit
fun lock(file: File, callback: () -> Unit): Unit
fun readResource(path: String): InputStream?
fun removeDirContents(dir: File): Boolean
fun zipContains(zip: File, fileName: String): Boolean
fun zipPack(zip: File, sourceDir: File): Unit
fun zipUnpackAll(zip: File, targetDir: File): Unit
fun zipUnpackDir(zip: File, dirName: String, dir: File): Unit

open class FileResolution

FileResolution(group: FileGroup, id: String, resolver: (FileResolution) -> File)
fun archiveFile(archive: File, entryPattern: String): File
fun archiveFiles(archive: File, entriesPattern: String): Sequence<File>
fun archiveTree(archive: File): FileTree
fun copyArchiveFile(archive: File, entryPattern: String, target: File): File
fun copyArchiveFiles(archive: File, entriesPattern: String, targetDir: File): Unit
fun copyFile(source: File, target: File): Unit
fun copyToDirectory(source: File, targetDir: File): Unit
val dir: File
val file: File
val group: FileGroup
val id: String
fun resolve(): File
fun then(operation: FileResolution.(File) -> File): Unit
fun use(operation: FileResolution.(File) -> Unit): Unit

open class FileResolver : Resolver<FileGroup>

FileResolver(aem: AemExtension, downloadDir: File)
open fun createGroup(name: String): FileGroup

interface FileTransfer

open fun delete(fileUrl: String): Unit
abstract fun deleteFrom(dirUrl: String, fileName: String): Unit
open fun download(fileUrl: String, target: File): Unit
abstract fun download(fileUrl: String): Unit
abstract fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
open fun downloadTo(fileUrl: String, dir: File): File
open fun exists(fileUrl: String): Boolean
open fun exists(dirUrl: String, fileName: String): Boolean
abstract fun handles(fileUrl: String): Boolean
abstract fun list(dirUrl: String): List<FileEntry>
fun splitFileUrl(fileUrl: String): Pair<String, String>
abstract fun stat(dirUrl: String, fileName: String): FileEntry?
open fun stat(fileUrl: String): FileEntry?
abstract fun truncate(dirUrl: String): Unit
open fun upload(fileUrl: String, source: File): Unit
abstract fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
open fun uploadTo(dirUrl: String, source: File): Unit

class FileTransferFactory

FileTransferFactory(aem: AemExtension)
fun <T> http(options: HttpFileTransfer.() -> T): T
fun <T> sftp(options: SftpFileTransfer.() -> T): T
fun <T> smb(options: SmbFileTransfer.() -> T): T

interface FileTransferHandler : FileTransfer

abstract val enabled: Boolean
abstract val name: String
abstract val parallelable: Boolean

class FileTransferManager : FileTransfer

FileTransferManager(aem: AemExtension)
val credentials: Pair<String, String>
fun credentials(user: String?, password: String?, domain: String? = null): Unit
val credentialsString: String
fun custom(name: String, definition: CustomFileTransfer.() -> Unit): Unit
fun deleteFrom(dirUrl: String, fileName: String): Unit
var domain: String?
fun download(fileUrl: String): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun downloadUsing(transfer: FileTransfer, fileUrl: String, target: File): Unit
fun downloadUsing(transfer: FileTransfer, dirUrl: String, fileName: String, target: File): Unit
val factory: FileTransferFactory
fun handles(fileUrl: String): Boolean
fun handling(fileUrl: String): FileTransferHandler
val http: HttpFileTransfer
fun http(options: HttpFileTransfer.() -> Unit): Unit
fun list(dirUrl: String): List<FileEntry>
const val NAME: String
fun named(name: String): FileTransfer
var password: String?
val path: PathFileTransfer
fun path(options: PathFileTransfer.() -> Unit): Unit
val resolve: ResolveFileTransfer
fun resolve(options: ResolveFileTransfer.() -> Unit): Unit
val sftp: SftpFileTransfer
fun sftp(options: SftpFileTransfer.() -> Unit): Unit
val smb: SmbFileTransfer
fun smb(options: SmbFileTransfer.() -> Unit): Unit
fun stat(dirUrl: String, fileName: String): FileEntry?
const val TMP_SUFFIX: String
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
fun uploadUsing(transfer: FileTransfer, fileUrl: String, source: File): Unit
fun uploadUsing(transfer: FileTransfer, dirUrl: String, fileName: String, source: File): Unit
val url: UrlFileTransfer
fun url(options: UrlFileTransfer.() -> Unit): Unit
var user: String?

class FileUploader

FileUploader(aem: AemExtension)
const val KILOBYTE: Int
fun ProgressLogger.logProgress(operation: String, readLength: Long, fullLength: Long, file: File): Unit
const val TRANSFER_CHUNK_100_KB: Int
fun upload(file: File, output: OutputStream, cleanup: (File) -> Unit = {}): Unit

open class FileWatcher

FileWatcher(aem: AemExtension)
val aem: AemExtension
lateinit var dirs: List<File>
fun ignore(vararg paths: String): Unit
fun ignore(paths: Iterable<String>): Unit
var ignores: MutableList<String>
var interval: Long
lateinit var onChange: (Event) -> Unit
fun start(): Unit

class FilterElement

FilterElement(root: String)
val element: Element
const val EXCLUDE_TAG: String
var excludes: Collection<String>
const val FILTER_TAG: String
const val INCLUDE_TAG: String
var includes: Collection<String>
var mode: String?
const val MODE_ATTR: String
fun of(root: String, definition: FilterElement.() -> Unit): FilterElement
fun parse(xml: String): List<FilterElement>
const val PATTERN_ATTR: String
val root: String
const val ROOT_ATTR: String
var type: FilterType

class FilterFile : Closeable

FilterFile(file: File, temporary: Boolean = false)
const val BUILD_NAME: String
fun close(): Unit
val elements: List<FilterElement>
val file: File
const val ORIGIN_NAME: String
fun rootDirs(contentDir: File): List<File>
val roots: Set<String>
const val SYNC_NAME: String
fun temporary(project: Project, paths: List<String>): FilterFile
const val TEMPORARY_NAME: String
fun toString(): String

enum class FilterType

DIR
FILE
UNKNOWN

object Formats

fun asJson(input: InputStream): DocumentContext!
fun asJson(value: String): DocumentContext!
fun asPassword(value: String): String
fun asVersion(value: String): GradleVersion
fun bytesToHuman(bytes: Long): String
fun calculateChecksum(text: String): String
fun commandToArgs(command: String): List<String>
fun date(date: Date = Date()): String
fun dateFileName(date: Date = Date()): String
fun dateTime(timestamp: Long, zoneId: ZoneId): LocalDateTime
fun dateToCalendar(date: Date): Calendar
fun duration(millis: Long): String
fun durationFit(thenMillis: Long, thenZoneId: ZoneId, durationMillis: Long): Boolean
fun durationSince(millis: Long): String
fun <reified T : Any> fromJson(json: String): T
fun <T> fromJson(json: String, clazz: Class<T>): T
fun fromJsonToMap(json: String): Map<String, Any?>
fun jsonMapper(pretty: Boolean): ObjectMapper
fun manglePath(path: String): String
fun noLineBreaks(text: String): String
fun normalizePath(path: String): String
fun normalizeSeparators(name: String, separator: String): String
fun percent(current: Int, total: Int): String
fun percent(current: Long, total: Long): String
fun percentExplained(current: Int, total: Int): String
fun percentExplained(current: Long, total: Long): String
fun projectPath(file: File, project: Project): String
fun projectPath(path: String, project: Project): String
fun relativePath(path: String, basePath: String): String
fun rootProjectPath(file: File, project: Project): String
fun rootProjectPath(path: String, project: Project): String
fun size(file: File): String
fun timestamp(): String
fun toBase64(value: String): String
fun toJson(value: Any, pretty: Boolean = true): String
fun toJson(value: Map<String, Any?>, pretty: Boolean = true): String
fun toList(value: String?, delimiter: String = ","): List<String>?
fun toMap(value: String?, valueDelimiter: String = ",", keyDelimiter: String = "="): Map<String, String>?
val URL_VALIDATOR: UrlValidator
val VERSION_UNKNOWN: GradleVersion!
fun versionAtLeast(actual: String, required: String): Boolean

class GroovyConsole : InstanceService

GroovyConsole(sync: InstanceSync)
const val EVAL_PATH: String
fun evalCode(code: String, data: Map<String, Any> = mapOf()): GroovyConsoleResult
fun evalScript(file: File, data: Map<String, Any> = mapOf()): GroovyConsoleResult
fun evalScript(fileName: String, data: Map<String, Any> = mapOf()): GroovyConsoleResult
fun evalScripts(fileNamePattern: String = "**/*.groovy", data: Map<String, Any> = mapOf()): Sequence<GroovyConsoleResult>
fun evalScripts(scripts: Iterable<File>, data: Map<String, Any> = mapOf()): Sequence<GroovyConsoleResult>
var scriptRootDir: File
var verbose: Boolean

class GroovyConsoleResult

GroovyConsoleResult()
lateinit var data: String
lateinit var exceptionStackTrace: String
lateinit var output: String
var result: String?
lateinit var runningTime: String
lateinit var script: String
fun toString(): String

class HealthCheck

HealthCheck(name: String, action: () -> Any?)
val action: () -> Any?
val name: String
fun perform(): HealthStatus
fun toString(): String

class HealthChecker

HealthChecker(environment: Environment)
fun check(verbose: Boolean = true): List<HealthStatus>
fun define(name: String, check: () -> Unit): Unit
val environment: Environment
fun http(options: HttpClient.() -> Unit): Unit
var retry: Retry
fun url(checkName: String, url: String, criteria: UrlCheck.() -> Unit): Unit

class HealthStatus

HealthStatus(check: HealthCheck, cause: Exception? = null)
val cause: Exception?
val check: HealthCheck
val passed: Boolean
val status: String
fun toString(): String

class Host : Serializable

Host(url: String)
val config: URL
var ip: String
fun tag(id: String): Unit
fun tag(ids: Iterable<String>): Unit
fun tag(vararg ids: String): Unit
var tags: MutableSet<String>
val text: String
val url: String

class HostFileManager

HostFileManager(container: Container)
fun cleanDir(vararg paths: String): Unit
val configDir: File
fun configFile(path: String): File
val container: Container
fun ensureDir(): Unit
fun ensureDir(vararg paths: String): Unit
fun file(path: String): File
var fileDir: File
fun resolveFiles(options: FileResolver.() -> Unit): List<File>
val rootDir: File

class HostOptions : Serializable

HostOptions(environment: Environment)
fun all(vararg tags: String): List<Host>
fun all(tags: Iterable<String>): List<Host>
val appendix: String
val author: Host
fun author(vararg urls: String, options: Host.() -> Unit = {}): Unit
fun author(urls: Iterable<String>, options: Host.() -> Unit = {}): Unit
val authors: List<Host>
fun define(url: String, options: Host.() -> Unit = {}): Unit
fun define(vararg urls: String, options: Host.() -> Unit = {}): Unit
fun define(urls: Iterable<String>, options: Host.() -> Unit = {}): Unit
var defined: MutableList<Host>
fun find(vararg tags: String): Host
fun find(tags: Iterable<String>): Host
var ipDefault: String
val osFile: String
fun other(vararg urls: String, options: Host.() -> Unit = {}): Unit
fun other(urls: Iterable<String>, options: Host.() -> Unit = {}): Unit
val others: List<Host>
val publish: Host
fun publish(vararg urls: String, options: Host.() -> Unit = {}): Unit
fun publish(urls: Iterable<String>, options: Host.() -> Unit = {}): Unit
val publishes: List<Host>
val TAG_AUTHOR: String
val TAG_OTHER: String
val TAG_PUBLISH: String

abstract class HtmlResponse

HtmlResponse(rawHtml: String)
val errors: List<String>
fun filter(input: InputStream, errorPatterns: List<ErrorPattern>, statusTags: List<String>, bufferSize: Int): String
protected abstract fun getErrorPatterns(): List<ErrorPattern>
enum class Status

FAIL
SUCCESS
SUCCESS_WITH_ERRORS

abstract val status: Status
val success: Boolean

open class HttpClient : Serializable

HttpClient(aem: AemExtension)
fun asJson(response: HttpResponse): DocumentContext
fun asJson(jsonString: String): DocumentContext
fun <reified T : Any> asObjectFromJson(response: HttpResponse): T
fun <T> asObjectFromJson(response: HttpResponse, clazz: Class<T>): T
fun asStream(response: HttpResponse): InputStream
fun asString(response: HttpResponse): String
var authorizationPreemptive: Boolean
var baseUrl: String
open fun baseUrl(uri: String): String
var basicCredentials: Pair<String?, String?>
var basicPassword: String?
var basicUser: String?
fun checkHtml(response: HttpResponse, validator: Document.() -> Boolean): Unit
fun checkStatus(response: HttpResponse, statusCodes: IntRange = STATUS_CODE_VALID): Unit
fun checkStatus(response: HttpResponse, statusCode: Int): Unit
fun checkStatus(response: HttpResponse, statusCodes: List<Int>): Unit
fun checkText(response: HttpResponse, containedText: String, ignoreCase: Boolean = true): Unit
val client: CloseableHttpClient!
var clientBuilder: HttpClientBuilder.() -> Unit
var connectionIgnoreSsl: Boolean
var connectionRetries: Boolean
var connectionTimeout: Int
open fun createEntityMultipart(params: Map<String, Any?>): HttpEntity
open fun createEntityUrlencoded(params: Map<String, Any?>): HttpEntity
fun delete(uri: String): Unit
fun <T> delete(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> delete(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpDelete.() -> Unit): T
open fun <T> execute(method: HttpRequestBase, handler: HttpClient.(HttpResponse) -> T): T
fun execute(method: HttpRequestBase): Unit
fun <T> fileTransfer(operation: HttpFileTransfer.() -> T): T
fun get(uri: String): Unit
fun <T> get(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> get(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpGet.() -> Unit): T
fun head(uri: String): Unit
fun <T> head(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> head(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpHead.() -> Unit): T
fun patch(path: String): Unit
fun <T> patch(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> patch(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpPatch.() -> Unit): T
fun post(url: String, params: Map<String, Any?> = mapOf()): Unit
fun <T> post(uri: String, params: Map<String, Any?> = mapOf(), handler: HttpClient.(HttpResponse) -> T): T
fun <T> post(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> post(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpPost.() -> Unit): T
fun postMultipart(uri: String, params: Map<String, Any?> = mapOf()): Unit
fun <T> postMultipart(uri: String, params: Map<String, Any?> = mapOf(), handler: HttpClient.(HttpResponse) -> T): T
fun postUrlencoded(uri: String, params: Map<String, Any?> = mapOf()): Unit
fun <T> postUrlencoded(uri: String, params: Map<String, Any?> = mapOf(), handler: HttpClient.(HttpResponse) -> T): T
var proxyHost: String?
var proxyPort: Int?
var proxyScheme: String?
fun put(uri: String): Unit
fun <T> put(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> put(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpPut.() -> Unit): T
fun <T> request(method: String, uri: String, handler: HttpClient.(HttpResponse) -> T): T
var requestConfigurer: HttpRequestBase.() -> Unit
var responseChecker: (HttpResponse) -> Unit
var responseChecks: Boolean
var responseHandler: (HttpResponse) -> Unit
val STATUS_CODE_VALID: IntRange
open fun throwStatusException(response: HttpResponse): Unit

class HttpFileException : FileException

HttpFileException(message: String, cause: Throwable)
HttpFileException(message: String)

class HttpFileTransfer : ProtocolFileTransfer

HttpFileTransfer(aem: AemExtension, client: HttpClient = client(aem))
fun client(configurer: HttpClient.() -> Unit): Unit
var client: HttpClient
fun client(aem: AemExtension): HttpClient
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
val name: String
const val NAME: String
val protocols: List<String>

enum class IdType

AUTHOR
fun byId(id: String): IdType
fun byUrl(url: String): IdType
PUBLISH
val type: String

class InstallResolver

InstallResolver(aem: AemExtension)
var downloadDir: File
fun files(configurer: FileResolver.() -> Unit): Unit
val files: List<File>

class InstallResponse : HtmlResponse

fun from(input: InputStream, bufferSize: Int): InstallResponse
protected fun getErrorPatterns(): List<ErrorPattern>
fun hasPackageErrors(patterns: Collection<String>): Boolean
val status: Status

interface Instance : Serializable

open val author: Boolean
abstract val available: Boolean
open val cmd: Boolean
open val credentials: Pair<String, String>
open val credentialsString: String
fun defaults(aem: AemExtension, configurer: RemoteInstance.() -> Unit = {}): List<RemoteInstance>
abstract val environment: String
const val ENVIRONMENT_CMD: String
const val FILTER_ANY: String
open val hiddenPassword: String
open val httpBasicAuthUrl: String
open val httpPort: Int
abstract val httpUrl: String
abstract val id: String
open val json: String
val LOCAL_PROPS: List<String>
abstract val name: String
fun parse(aem: AemExtension, str: String, configurer: RemoteInstance.() -> Unit = {}): List<RemoteInstance>
abstract val password: String
const val PASSWORD_DEFAULT: String
abstract val properties: Map<String, String?>
fun properties(aem: AemExtension): List<Instance>
abstract fun property(key: String, value: String?): Unit
abstract fun property(key: String): String?
open val publish: Boolean
val REMOTE_PROPS: List<String>
abstract val sync: InstanceSync
open fun <T> sync(action: InstanceSync.() -> T): T
abstract val systemProperties: Map<String, String>
open val type: IdType
const val URL_AUTHOR_DEFAULT: String
const val URL_PUBLISH_DEFAULT: String
abstract val user: String
const val USER_DEFAULT: String
open fun validate(): Unit
abstract val version: String
abstract val zoneId: ZoneId

interface InstanceAction : Serializable

abstract fun perform(): Unit

class InstanceActionPerformer

InstanceActionPerformer(aem: AemExtension)
fun awaitDown(options: AwaitDownAction.() -> Unit = {}): Unit
fun awaitUp(options: AwaitUpAction.() -> Unit = {}): Unit
fun check(options: CheckAction.() -> Unit): Unit
fun reload(options: ReloadAction.() -> Unit = {}): Unit
fun reloadAndAwaitUp(): Unit

class InstanceAnalyzer

InstanceAnalyzer(tailer: InstanceTailer, instance: Instance, logsChannel: ReceiveChannel<Log>, notificationChannel: SendChannel<LogChunk>)
fun listenTailed(): Unit

open class InstanceAwait : AemDefaultTask

InstanceAwait()
fun await(): Unit
fun awaitUp(options: AwaitUpAction.() -> Unit): Unit
const val NAME: String

open class InstanceBackup : AemDefaultTask

InstanceBackup()
fun backup(): Unit
var mode: Mode
enum class Mode

fun of(name: String): Mode
UPLOAD_ONLY
ZIP_AND_UPLOAD
ZIP_ONLY

const val NAME: String

open class InstanceCreate : LocalInstanceTask

InstanceCreate()
fun create(): Unit
const val NAME: String

open class InstanceDestroy : LocalInstanceTask

InstanceDestroy()
fun destroy(): Unit
const val NAME: String
open fun taskGraphReady(graph: TaskExecutionGraph): Unit

open class InstanceDown : LocalInstanceTask

InstanceDown()
fun awaitDown(options: AwaitDownAction.() -> Unit): Unit
fun down(): Unit
const val NAME: String

open class InstanceException : AemException

InstanceException(message: String, cause: Throwable)
InstanceException(message: String)

open class InstanceHttpClient : HttpClient

InstanceHttpClient(aem: AemExtension, instance: Instance)
val instance: Instance
open fun throwStatusException(response: HttpResponse): Unit

data class InstanceLogInfo

InstanceLogInfo(name: String, zoneId: ZoneId)
val name: String
fun none(): InstanceLogInfo
fun of(instance: Instance): InstanceLogInfo
val zoneId: ZoneId

open class InstanceOptions : Serializable

InstanceOptions(aem: AemExtension)
val defined: MutableMap<String, Instance>
fun local(httpUrl: String): Unit
fun local(httpUrl: String, name: String): Unit
fun local(httpUrl: String, options: LocalInstance.() -> Unit): Unit
fun parse(urlOrName: String): Instance
fun remote(httpUrl: String): Unit
fun remote(httpUrl: String, name: String): Unit
fun remote(httpUrl: String, options: RemoteInstance.() -> Unit): Unit
fun sync(options: InstanceSync.() -> Unit): Unit

class InstancePlugin : AemPlugin

InstancePlugin()
fun Project.configure(): Unit
const val ID: String

open class InstanceProvision : AemDefaultTask

InstanceProvision()
const val NAME: String
fun provision(): Unit
val provisioner: Provisioner
fun provisioner(options: Provisioner.() -> Unit): Unit
fun step(id: String, options: Step.() -> Unit): Unit

open class InstanceReload : InstanceTask

InstanceReload()
fun awaitUp(options: AwaitUpAction.() -> Unit): Unit
const val NAME: String
fun reload(options: ReloadAction.() -> Unit): Unit
fun reload(): Unit

open class InstanceResetup : AemDefaultTask

InstanceResetup()
const val NAME: String

open class InstanceResolve : AemDefaultTask

InstanceResolve()
const val NAME: String
fun resolve(): Unit

open class InstanceRestart : AemDefaultTask

InstanceRestart()
const val NAME: String

open class InstanceSatisfy : PackageDeploy

InstanceSatisfy()
val allFiles: List<File>
val cmdGroups: Boolean
open fun deploy(): Unit
var downloadDir: File
var greedy: Boolean
const val GROUP_CMD: String
var groupFilter: FileGroup.() -> Boolean
var groupName: String
var listRefresh: Boolean
var listRetry: Retry
const val NAME: String
val outputDirs: List<File>
class PackageAction

PackageAction(pkg: File, instance: Instance)
val instance: Instance
val pkg: File

val packageGroups: List<PackageGroup>
val packageProvider: PackageResolver
fun packages(configurer: PackageResolver.() -> Unit): Unit
fun resolvePackages(): Unit

open class InstanceService

InstanceService(sync: InstanceSync)
val aem: AemExtension
val instance: Instance
val logger: Logger!
val project: Project
val sync: InstanceSync

open class InstanceSetup : AemDefaultTask

InstanceSetup()
const val NAME: String

class InstanceStep

InstanceStep(instance: Instance, definition: Step)
val counter: Long
const val COUNTER_PROP: String
val definition: Step
val duration: Long
val durationString: String
val ended: Boolean
const val ENDED_AT_PROP: String
val endedAt: Date
val failed: Boolean
const val FAILED_PROP: String
val instance: Instance
fun isPerformable(): Boolean
fun perform(): Unit
val started: Boolean
const val STARTED_AT_PROP: String
val startedAt: Date
fun toString(): String
fun update(): Unit

class InstanceSync

InstanceSync(aem: AemExtension, instance: Instance)
val aem: AemExtension
val crx: Crx
fun <T> crx(callback: Crx.() -> T): T
val groovyConsole: GroovyConsole
fun <T> groovyConsole(callback: GroovyConsole.() -> T): T
val http: InstanceHttpClient
fun <T> http(callback: InstanceHttpClient.() -> T): T
val instance: Instance
val osgiFramework: OsgiFramework
fun <T> osgiFramework(callback: OsgiFramework.() -> T): T
val packageManager: PackageManager
fun <T> packageManager(callback: PackageManager.() -> T): T
val repository: Repository
fun <T> repository(callback: Repository.() -> T): T
val status: Status
fun <T> status(callback: Status.() -> T): T
var workflowManager: WorkflowManager
fun <T> workflowManager(callback: WorkflowManager.() -> T): T

open class InstanceTail : InstanceTask

InstanceTail()
const val NAME: String
open fun projectEvaluated(): Unit
fun tail(): Unit
val tailer: InstanceTailer
fun tailer(options: InstanceTailer.() -> Unit): Unit

class InstanceTailer

InstanceTailer(aem: AemExtension)
val aem: AemExtension
var console: Boolean
const val ENDPOINT_PATH: String
const val ENDPOINT_PATH_OLD: String
fun errorLogEndpoint(instance: Instance): String
var fetchInterval: Long
val INCIDENT_LEVELS_DEFAULT: List<String>
const val INCIDENT_OLD_DEFAULT: Long
var incidentChecker: Log.(Instance) -> Boolean
var incidentDelay: Long
var incidentFilter: File
fun incidentFilter(options: LogFilter.() -> Unit): Unit
var instances: List<Instance>
var linesChunkSize: Long
var lockInterval: Long
val logFile: String
var logFilePath: String
val logFilter: LogFilter
fun logFilter(options: LogFilter.() -> Unit): Unit
var logListener: Log.(Instance) -> Unit
var rootDir: File
fun tail(): Unit

class InstanceTailerException : AemException

InstanceTailerException(message: String)

open class InstanceTask : AemDefaultTask

InstanceTask()
var instances: List<Instance>
open fun projectsEvaluated(): Unit

open class InstanceUp : LocalInstanceTask

InstanceUp()
fun await(options: AwaitUpAction.() -> Unit): Unit
const val NAME: String
fun up(): Unit

class InstanceUrl

InstanceUrl(raw: String)
val basicAuth: String
fun basicAuth(user: String, password: String): String
val config: URL
val debugPort: Int
fun decode(text: String): String
fun encode(text: String): String
const val HTTP_DEBUG_PORT: Int
const val HTTP_PORT: Int
val httpPort: Int
const val HTTPS_DEBUG_PORT: Int
const val HTTPS_PORT: Int
val httpUrl: String
val id: String
fun parse(raw: String): InstanceUrl
val password: String
val type: IdType
val user: String

open class InternalApi

InternalApi(project: Project)
operator fun invoke(obj: Any, method: String, vararg args: Any): Any
fun invoke(obj: Any, method: String, args: List<Any?>, argTypes: List<Class<out Any>>): Any
val project: Project
fun <T : Any> service(clazz: KClass<T>): T
val serviceFactory: Any

class JsonPassword : JsonSerializer<String>

JsonPassword()
fun serialize(value: String?, generator: JsonGenerator, serializers: SerializerProvider): Unit

kotlin.collections.Collection

fun Collection<Instance>.checkAvailable(): Unit
val Collection<Instance>.names: String

kotlin.collections.Collection

val Collection<File>.fileNames: String

kotlin.collections.Collection

val Collection<Container>.names: String

kotlin.collections.Iterable

fun <T> Iterable<T>.onEachApply(block: T.() -> Unit): Iterable<T>

enum class LineSeparator

CR
CRLF
LF
LFCR
fun string(name: String): String
SYSTEM
val value: String

class ListResponse

fun resolvePackage(expected: Package): Package?
lateinit var results: List<Package>

class LocalInstance : AbstractInstance, Serializable

fun checkStatus(): Status
fun create(): Unit
fun create(aem: AemExtension, httpUrl: String, configurer: LocalInstance.() -> Unit): LocalInstance
fun create(aem: AemExtension, httpUrl: String): LocalInstance
val created: Boolean
fun customize(): Unit
var debugPort: Int
fun destroy(): Unit
val dir: File
fun down(): Unit
const val ENVIRONMENT: String
const val FILES_PATH: String
fun init(): Unit
val initialized: Boolean
val installDir: File
val jar: File
var jvmOpts: List<String>
val jvmOptsDefaults: List<String>
val jvmOptsString: String
val license: File
fun lock(name: String): Unit
const val LOCK_CREATE: String
const val LOCK_INIT: String
fun locked(name: String): Boolean
val manager: LocalInstanceManager
val overridesDirs: List<File>
lateinit var password: String
val quickstartDir: File
var runModes: List<String>
val runModesDefault: List<String>
val runModesString: String
val running: Boolean
fun saveVersion(): Unit
var startOpts: List<String>
val startOptsString: String
val startScript: Script
val status: Status
val statusScript: Script
val stopScript: Script
fun toString(): String
fun up(): Unit
val user: String
const val USER: String
val version: String
val versionFile: File
val windowTitle: String

abstract class LocalInstanceAction : AbstractAction

LocalInstanceAction(aem: AemExtension)
var instances: List<LocalInstance>

class LocalInstanceManager : Serializable

LocalInstanceManager(aem: AemExtension)
val backup: BackupResolver
fun backup(options: BackupResolver.() -> Unit): Unit
val backupZip: File?
fun create(instances: List<LocalInstance>): Unit
fun createFromBackup(instances: List<LocalInstance>, backupZip: File): Unit
fun createFromScratch(instances: List<LocalInstance>): Unit
var expandFiles: List<String>
var expandProperties: Map<String, Any>
fun init(options: LocalInstance.() -> Unit): Unit
val install: InstallResolver
fun install(options: InstallResolver.() -> Unit): Unit
var overridesDir: File
val quickstart: QuickstartResolver
fun quickstart(options: QuickstartResolver.() -> Unit): Unit
fun resolveSourceFiles(): Unit
var rootDir: File
var scriptTimeout: Long
var source: Source
fun source(name: String): Unit
val sourceFiles: List<File>

open class LocalInstanceTask : AemDefaultTask

LocalInstanceTask()
var instances: List<LocalInstance>
val manager: LocalInstanceManager
open fun projectsEvaluated(): Unit

class Log

Log(instance: InstanceLogInfo = InstanceLogInfo.none(), text: String, timestamp: ZonedDateTime, level: String, source: String, messageLines: List<String>)
val cause: String
val checksum: String
fun create(instance: InstanceLogInfo, logLines: List<String>): Log
val instance: InstanceLogInfo
fun isFirstLineOfLog(text: String): Boolean
fun isLevel(vararg levels: String): Boolean
fun isLevel(levels: Iterable<String>): Boolean
fun isOlderThan(millis: Long): Boolean
val level: String
val logWithLocalTimestamp: String
val message: String
fun parseTimestamp(timestamp: String, instance: InstanceLogInfo = InstanceLogInfo.none()): ZonedDateTime
val source: String
val text: String
val timestamp: ZonedDateTime

class LogChunk

LogChunk(instance: Instance, logs: List<Log>)
val instance: Instance
val logs: List<Log>
val size: Int

interface LogDestination

abstract fun dump(logs: List<Log>): Unit

class LogFiles

LogFiles(tailer: InstanceTailer)
fun clearIncidents(instanceName: String): Unit
fun clearMain(instanceName: String): Unit
const val INCIDENT_DIR: String
fun incidentDir(instanceName: String): File
fun incidentFile(instanceName: String): File
fun isLocked(): Boolean
fun lock(): Unit
const val LOCK_FILE: String
fun main(instanceName: String): File
fun writeToIncident(instanceName: String, writerBlock: (BufferedWriter) -> Unit): URI
fun writeToMain(instanceName: String, writerBlock: (FileWriter) -> Unit): Unit

class LogFilter

LogFilter()
fun excludeFile(file: File): Unit
val excludeFiles: MutableList<File>
fun excludeRule(predicate: Log.() -> Boolean): Unit
val excludeRules: MutableList<Log.() -> Boolean>
fun excludeWildcard(vararg matchers: String): Unit
fun excludeWildcard(matchers: Iterable<String>): Unit
fun excludeWildcard(matchers: Sequence<String>): Unit
fun excludeWildcard(matcher: String): Unit
const val FILE_COMMENT_PREFIX: String
fun isExcluded(log: Log): Boolean

class LogNotifier

LogNotifier(notificationChannel: ReceiveChannel<LogChunk>, notifier: NotifierFacade, logFiles: LogFiles)
fun listenTailed(): Unit

class LogParser

LogParser(instance: InstanceLogInfo = InstanceLogInfo.none())
fun parse(reader: BufferedReader): List<Log>

interface LogSource

abstract fun <T> readChunk(parser: (BufferedReader) -> List<T>): List<T>

class LogTailer

LogTailer(source: LogSource, destination: LogDestination, instance: InstanceLogInfo = InstanceLogInfo.none(), logsAnalyzerChannel: SendChannel<Log>? = null, printer: ConsolePrinter = ConsolePrinter.none())
fun tail(): Unit

class Node : Serializable

Node(repository: Repository, path: String)
val children: List<Node>
fun children(): Sequence<Node>
fun copy(targetPath: String): Unit
fun copyFrom(sourcePath: String): Unit
fun copyTo(targetDir: String): Unit
fun delete(): RepositoryResult
fun deleteProperties(vararg names: String): RepositoryResult
fun deleteProperties(names: Iterable<String>): RepositoryResult
fun deleteProperty(name: String): RepositoryResult
fun download(options: PackageDefinition.() -> Unit = {}): File
val exists: Boolean
fun exists(recheck: Boolean = false): Boolean
fun hasProperties(vararg names: String): Boolean
fun hasProperties(names: Iterable<String>): Boolean
fun hasProperty(name: String): Boolean
val json: String
val name: String
val parent: Node
val path: String
val properties: Properties
enum class Property

CHILDREN
NAME
val value: String

fun reload(): Unit
fun replace(properties: Map<String, Any?>): RepositoryResult
val repository: Repository
fun save(properties: Map<String, Any?>): RepositoryResult
fun saveProperty(name: String, value: Any?): RepositoryResult
fun toString(): String
fun traverse(self: Boolean = false): Sequence<Node>
val type: String
val TYPE_UNSTRUCTURED: Pair<String, String>

enum class NodeTypesSync

ALWAYS
AUTO
FALLBACK
fun find(name: String): NodeTypesSync?
NEVER
fun of(name: String): NodeTypesSync
PRESERVE_AUTO
PRESERVE_FALLBACK

interface Notifier

abstract fun notify(title: String, text: String, level: LogLevel, onClick: (Notify) -> Unit = {}): Unit

class NotifierFacade

var config: NotifierFacade.() -> Notifier
fun custom(notifier: (title: String, text: String, level: LogLevel, onClick: (Notify) -> Unit) -> Unit): Notifier
fun dorkbox(): Notifier
fun dorkbox(configurer: Notify.() -> Unit): Notifier
val DORKBOX_DARK_LIGHT_THEME: Theme
const val DORKBOX_HIDE_AFTER_SECONDS: Long
var enabled: Boolean
val image: URL
fun log(title: String): Unit
fun log(title: String, message: String): Unit
fun log(title: String, message: String, level: LogLevel): Unit
fun notify(title: String): Unit
fun notify(title: String, text: String): Unit
fun notify(title: String, text: String, level: LogLevel): Unit
fun notifyLogError(title: String, message: String, file: URI): Unit
fun of(aem: AemExtension): NotifierFacade

class OsgiFramework : InstanceService

OsgiFramework(sync: InstanceSync)
val bundles: List<Bundle>
const val BUNDLES_LIST_JSON: String
const val BUNDLES_PATH: String
val components: List<Component>
const val COMPONENTS_LIST_JSON: String
const val COMPONENTS_PATH: String
const val CONFIGURATION_PATH: String
val configurations: Sequence<Configuration>
val CONFIGURATIONS_REGEX: Regex
fun configure(pid: String, properties: Map<String, Any?>): Unit
fun deleteConfiguration(pid: String): Unit
fun deleteConfiguration(pid: String, service: String): Unit
fun determineBundleState(): BundleState
fun determineComponentState(): ComponentState
fun determineConfigurationState(): ConfigurationState
fun determineEventState(): EventState
fun disableComponent(pid: String): Unit
fun enableComponent(pid: String): Unit
val events: List<Event>
const val EVENTS_LIST_JSON: String
fun findBundle(symbolicName: String): Bundle?
fun findComponent(pid: String): Component?
fun findConfiguration(pid: String, metatypeChecking: Boolean = true): Configuration?
fun getBundle(symbolicName: String): Bundle
fun getComponent(pid: String): Component
fun getConfiguration(pid: String): Configuration
fun getConfigurations(fpid: String): Sequence<Configuration>
fun installBundle(bundle: File, start: Boolean = true, startLevel: Int = 20, refreshPackages: Boolean = true, retry: Retry = aem.retry()): Unit
fun refreshBundle(symbolicName: String): Unit
fun restart(): Unit
fun restartBundle(symbolicName: String): Unit
fun restartComponent(pid: String): Unit
fun saveConfiguration(pid: String, properties: Map<String, Any?>): Unit
fun saveConfiguration(pid: String, service: String, properties: Map<String, Any>): Unit
fun startBundle(symbolicName: String): Unit
fun stop(): Unit
fun stopBundle(symbolicName: String): Unit
fun uninstallBundle(bundle: File): Unit
fun uninstallBundle(symbolicName: String): Unit
fun updateBundle(symbolicName: String): Unit
fun updateConfiguration(pid: String, properties: Map<String, Any?>): Unit
fun updateConfiguration(pid: String, service: String, properties: Map<String, Any>): Unit
const val VMSTAT_PATH: String

class Package

Package(compose: PackageCompose)
Package(group: String, name: String, version: String)
fun bundlePath(path: String, runMode: String?): String
var conventionPaths: List<String>
val coordinates: String
fun coordinates(group: String, name: String, version: String): String
lateinit var downloadName: String
lateinit var group: String
val installed: Boolean
const val JCR_ROOT: String
var lastUnpacked: Long?
const val META_PATH: String
const val META_RESOURCES_PATH: String
lateinit var name: String
const val NODE_TYPES_SYNC_PATH: String
const val OAKPAL_OPEAR_PATH: String
const val OAKPAL_OPEAR_RESOURCES_PATH: String
lateinit var path: String
lateinit var version: String
const val VLT_DIR: String
const val VLT_HOOKS_PATH: String
const val VLT_NODETYPES_FILE: String
const val VLT_PATH: String
const val VLT_PROPERTIES: String

open class PackageActivate : PackageTask

PackageActivate()
fun activate(): Unit
const val NAME: String

open class PackageCompose : ZipTask

PackageCompose()
var bundlePath: String
val composedDir: File
val composedFile: File
var contentDir: File
protected open fun copy(): Unit
val fileFilter: PackageFileFilter
fun fileFilter(configurer: PackageFileFilter.() -> Unit): Unit
var fileFilterDelegate: (CopySpec) -> Unit
val fileProperties: Map<String, VltDefinition>
fun fromBundle(composeTaskPath: String): Unit
var fromConvention: Boolean
fun fromConvention(): Unit
fun fromJar(dependencyOptions: DependencyOptions.() -> Unit, installPath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromJar(dependencyNotation: Any, installPath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromJar(jar: Jar, bundlePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromJar(jar: File, bundlePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromJars(jars: Collection<File>, bundlePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromMeta(): Unit
fun fromMeta(metaDir: File): Unit
fun fromPackage(composeTaskPath: String): Unit
fun fromProject(): Unit
fun fromProject(path: String, options: ProjectMergingOptions.() -> Unit): Unit
fun fromProject(path: String, options: ProjectMergingOptions = ProjectMergingOptions()): Unit
fun fromProject(project: Project, options: ProjectMergingOptions.() -> Unit): Unit
fun fromProject(project: Project, options: ProjectMergingOptions = ProjectMergingOptions()): Unit
fun fromProjects(pathFilter: String, options: ProjectMergingOptions.() -> Unit): Unit
fun fromProjects(pathFilter: String, options: ProjectMergingOptions = ProjectMergingOptions()): Unit
fun fromSubpackage(composeTaskPath: String, storagePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromSubprojects(options: ProjectMergingOptions.() -> Unit): Unit
fun fromSubprojects(options: ProjectMergingOptions = ProjectMergingOptions()): Unit
fun fromZip(dependencyOptions: DependencyOptions.() -> Unit, storagePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromZip(dependencyNotation: String, storagePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromZip(dependencyNotation: Any, storagePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromZip(zip: File, packagePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromZips(zips: Collection<File>, packagePath: String? = null, vaultFilter: Boolean? = null): Unit
val inputFiles: List<File>
fun merging(options: ProjectMergingOptions.() -> Unit): Unit
var metaDir: File
const val NAME: String
var packagePath: String
open fun projectEvaluated(): Unit
open fun projectsEvaluated(): Unit
var validator: PackageValidator
fun validator(options: PackageValidator.() -> Unit): Unit
val vaultDefinition: VltDefinition
fun vaultDefinition(options: VltDefinition.() -> Unit): Unit
val vaultDir: File
val vaultFilterFile: File
val vaultFilterOriginFile: File
val vaultNodeTypesFile: File
val vaultNodeTypesSyncFile: File

class PackageDefinition : VltDefinition

PackageDefinition(aem: AemExtension)
var archiveAppendix: String?
var archiveBaseName: String
var archiveClassifier: String?
var archiveExtension: String
var archiveFileName: String
var archivePath: File
var archiveVersion: String
fun compose(definition: PackageDefinition.() -> Unit): File
fun content(options: PackageDefinition.() -> Unit): Unit
fun copyJcrFile(file: File, path: String): Unit
fun copyMetaFiles(skipExisting: Boolean = true): Unit
var destinationDirectory: File
fun expandFiles(dir: File, filePatterns: List<String> = PackageFileFilter.EXPAND_FILES_DEFAULT): Unit
fun expandMetaFiles(filePatterns: List<String> = PackageFileFilter.EXPAND_FILES_DEFAULT): Unit
val jcrDir: File
val metaDir: File
val pkgDir: File
fun process(options: PackageDefinition.() -> Unit): Unit

open class PackageDelete : PackageTask

PackageDelete()
fun delete(): Unit
const val NAME: String
open fun taskGraphReady(graph: TaskExecutionGraph): Unit

class PackageDependency

PackageDependency(aem: AemExtension, notation: Any, storagePath: String, vaultFilter: Boolean)
val file: File
var storagePath: String
var vaultFilter: Boolean

open class PackageDeploy : PackageTask

PackageDeploy()
var awaited: Boolean
fun awaitUp(options: AwaitUpAction.() -> Unit): Unit
fun awaitUp(): Unit
var completer: () -> Unit
open fun deploy(): Unit
var distributed: Boolean
var finalizer: InstanceSync.() -> Unit
var initializer: InstanceSync.() -> Unit
var installRecursive: Boolean
var installRetry: Retry
const val NAME: String
open fun projectsEvaluated(): Unit
var uploadForce: Boolean
var uploadRetry: Retry
var workflowToggle: Map<String, Boolean>

class PackageException : AemException

PackageException(message: String, cause: Throwable)
PackageException(message: String)

class PackageFile : Serializable

PackageFile(file: File)
val file: File
val group: String
val name: String
val properties: Document
fun property(name: String): String?
fun toString(): String
val version: String

class PackageFileFilter : Serializable

PackageFileFilter(aem: AemExtension)
var bundleChecking: Boolean
val EXCLUDE_FILES_DEFAULT: List<String>
var excludeFiles: List<String>
var excluding: Boolean
val EXPAND_FILES_DEFAULT: List<String>
var expandFiles: List<String>
var expanding: Boolean
var expandProperties: Map<String, Any>
fun expandProperty(name: String, value: String): Unit
fun filter(spec: CopySpec, expandProperties: Map<String, Any> = mapOf()): Unit

class PackageGroup : FileGroup

PackageGroup(resolver: PackageResolver, name: String)
fun completer(callback: () -> Unit): Unit
protected fun createResolution(id: String, resolver: (FileResolution) -> File): FileResolution
var distributed: Boolean?
fun finalizer(callback: InstanceSync.() -> Unit): Unit
var greedy: Boolean
fun initializer(callback: InstanceSync.() -> Unit): Unit
var installRecursive: Boolean?
var installRetry: Retry?
var instanceName: String
val resolver: PackageResolver
var uploadForce: Boolean?
var uploadRetry: Retry?
var workflowToggle: MutableMap<String, Boolean>
fun workflowToggle(id: String, flag: Boolean): Unit

open class PackageInstall : PackageTask

PackageInstall()
fun install(): Unit
const val NAME: String

class PackageManager : InstanceService

PackageManager(sync: InstanceSync)
fun activate(remotePath: String): UploadResponse
fun build(remotePath: String): BuildResponse
fun delete(remotePath: String): DeleteResponse
fun deploy(file: File, uploadForce: Boolean = true, uploadRetry: Retry = aem.retry(), installRecursive: Boolean = true, installRetry: Retry = aem.retry(), activate: Boolean = false): Unit
fun distribute(file: File, uploadForce: Boolean = true, uploadRetry: Retry = aem.retry(), installRecursive: Boolean = true, installRetry: Retry = aem.retry()): Unit
fun download(definition: PackageDefinition.() -> Unit, retry: Retry): File
fun download(definition: PackageDefinition.() -> Unit): File
fun download(remotePath: String, targetFile: File = aem.temporaryFile(FilenameUtils.getName(remotePath)), retry: Retry = aem.retry()): Unit
fun find(file: File, refresh: Boolean = true, retry: Retry = aem.retry()): Package?
fun find(group: String, name: String, version: String, refresh: Boolean = true, retry: Retry = aem.retry()): Package?
fun get(file: File, refresh: Boolean = true, retry: Retry = aem.retry()): Package
fun get(group: String, name: String, version: String, refresh: Boolean = true, retry: Retry = aem.retry()): Package
const val HTML_PATH: String
fun install(remotePath: String, recursive: Boolean = true, retry: Retry = aem.retry()): InstallResponse
fun isSnapshot(file: File): Boolean
const val JSON_PATH: String
fun list(retry: Retry = aem.retry()): ListResponse
const val LIST_JSON: String
const val PATH: String
fun uninstall(remotePath: String): UninstallResponse
fun upload(file: File, force: Boolean = true, retry: Retry = aem.retry()): UploadResponse

class PackageOptions : Serializable

PackageOptions(aem: AemExtension)
var contentDir: File
var errors: List<String>
var installPath: String
var installRepository: Boolean
val jcrRootDir: File
var metaCommonDir: File
var nodeTypesSync: NodeTypesSync
fun nodeTypesSync(name: String): Unit
var nodeTypesSyncFile: File
var responseBuffer: Int
var snapshots: List<String>
var storageDir: PackageFile.() -> String
var storagePath: String
fun validator(options: PackageValidator.() -> Unit): Unit
val vltDir: File

class PackagePlugin : AemPlugin

PackagePlugin()
fun Project.configure(): Unit
const val ID: String

open class PackagePrepare : AemDefaultTask

PackagePrepare()
var contentDir: File
var metaDefaults: Boolean
val metaDir: File
val metaDirs: List<File>
const val NAME: String
fun prepare(): Unit
fun syncNodeTypesFallback(): Unit
fun syncNodeTypesOrElse(action: () -> Unit): Boolean?
fun syncNodeTypesOrFallback(): Boolean?
val vaultFilterOriginFile: File
val vaultFilterTemplateFile: File
var vaultNodeTypesSync: NodeTypesSync
var vaultNodeTypesSyncFile: File

open class PackagePurge : PackageTask

PackagePurge()
const val NAME: String
fun purge(): Unit
open fun taskGraphReady(graph: TaskExecutionGraph): Unit

class PackageResolution : FileResolution

PackageResolution(group: PackageGroup, id: String, action: (FileResolution) -> File)

enum class PackageResolver

BY_CONVENTION_PATH

fun resolve(response: ListResponse, expected: Package): Package?

BY_COORDINATES

fun resolve(response: ListResponse, expected: Package): Package?

abstract fun resolve(response: ListResponse, expected: Package): Package?

class PackageResolver : Resolver<PackageGroup>

PackageResolver(aem: AemExtension, downloadDir: File)
var bundleDefinition: PackageDefinition.(BundleFile) -> Unit
var bundlePath: String
fun createGroup(name: String): PackageGroup

class PackageState

PackageState(file: File, state: Package?)
val file: File
val installed: Boolean
val name: String
val state: Package?
val uploaded: Boolean

open class PackageTask : AemDefaultTask

PackageTask()
fun instance(urlOrName: String): Unit
var instances: List<Instance>
fun package(path: String): Unit
var packages: List<File>
fun pkg(path: String): Unit
open fun projectsEvaluated(): Unit

open class PackageUninstall : PackageTask

PackageUninstall()
const val NAME: String
open fun taskGraphReady(graph: TaskExecutionGraph): Unit
fun uninstall(): Unit

open class PackageUpload : PackageTask

PackageUpload()
const val NAME: String
fun upload(): Unit

class PackageValidator

PackageValidator(aem: AemExtension)
val aem: AemExtension
fun base(value: Any): Unit
fun base(provider: () -> File?): Unit
val baseFile: File?
fun classLoader(provider: () -> ClassLoader): Unit
const val CONFIG_DIR_PATH: String
fun configDir(dir: File): Unit
val configDirs: List<File>
fun configDirs(dirs: Iterable<File>): Unit
fun configDirs(vararg dirs: File): Unit
var enabled: Boolean
fun perform(vararg packages: File): Unit
fun perform(packages: Iterable<File>): Unit
val planFile: File
var planName: String
val reportFile: File
var severity: Severity
fun severity(name: String): Unit
var verbose: Boolean
var workDir: File

object Parallel

fun <A> each(iterable: Iterable<A>, callback: CoroutineScope.(A) -> Unit): Unit
fun <A, B : Any> map(iterable: Iterable<A>, mapper: CoroutineScope.(A) -> B): Collection<B>
fun <A, B : Any> map(iterable: Iterable<A>, filter: (A) -> Boolean, mapper: CoroutineScope.(A) -> B): List<B>
fun <A> poolEach(threads: Int, name: String, iterable: Iterable<A>, callback: CoroutineScope.(A) -> Unit): Unit
fun <A, B : Any> poolMap(threads: Int, name: String, iterable: Iterable<A>, mapper: CoroutineScope.(A) -> B): List<B>
fun <A> with(iterable: Iterable<A>, callback: A.() -> Unit): Unit

class PathFileTransfer : AbstractFileTransfer

PathFileTransfer(aem: AemExtension)
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun handles(fileUrl: String): Boolean
fun list(dirUrl: String): List<FileEntry>
val name: String
const val NAME: String
fun stat(dirUrl: String, fileName: String): FileEntry?
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit

object Patterns

const val WILDCARD: String
fun wildcard(file: File, matcher: String): Boolean
fun wildcard(file: File, matchers: Iterable<String>): Boolean
fun wildcard(path: String, matcher: String): Boolean
fun wildcard(path: String, matchers: Iterable<String>): Boolean
const val WILDCARD_NEGATION: String
const val WILDCARD_SEPARATOR: String

enum class PhysicalType

LOCAL
fun of(type: String?): PhysicalType?
REMOTE

class PreemptiveAuthInterceptor : HttpRequestInterceptor

PreemptiveAuthInterceptor()
fun process(request: HttpRequest, context: HttpContext): Unit

class ProgressCountdown

ProgressCountdown(project: Project)
var loggerInterval: Int
fun progress(messageComposer: (Long) -> String): Unit
fun run(): Unit
var time: Long
var timePrefix: String

class ProgressIndicator

ProgressIndicator(project: Project)
var count: Long
fun increment(): Unit
fun increment(message: String): Unit
fun <T> increment(message: String, block: () -> T): T
fun <T> launch(block: ProgressIndicator.() -> T): T
var message: String
fun reset(): Unit
var step: String
var total: Long
fun update(): Unit
fun update(message: String): Unit
fun updater(updater: ProgressIndicator.() -> Unit): Unit

open class ProgressLogger

var header: String
fun <T> launch(block: ProgressLogger.() -> T): T
fun of(project: Project): ProgressLogger
fun parents(project: Project): Queue<ProgressLogger>
fun progress(message: String): Unit
var progressEach: (String) -> Unit
var progressWindow: Long

class ProjectMergingOptions

ProjectMergingOptions()
var bundleBuilt: Boolean
var bundleDependent: Boolean
var bundleTasks: AemExtension.() -> Collection<BundleCompose>
var composeContent: Boolean
var composeTasks: AemExtension.() -> Collection<PackageCompose>
var extraTasks: AemExtension.() -> Collection<Task>
var packageDependent: Boolean
var vaultFilters: Boolean
var vaultHooks: Boolean
var vaultNodeTypes: Boolean
var vaultProperties: Boolean

class Properties : LinkedHashMap<String, Any>

Properties(node: Node, props: Map<String, Any>)
fun boolean(name: String): Boolean?
fun booleans(name: String): List<Boolean>?
fun calendar(name: String): Calendar?
fun calendars(name: String): List<Calendar>?
fun date(name: String): Date?
fun dates(name: String): List<Date>?
fun double(name: String): Double?
fun doubles(name: String): List<Double>?
val json: String
fun long(name: String): Long?
fun longs(name: String): List<Long>?
val node: Node
fun string(name: String): String?
fun strings(name: String): List<String>?
fun toString(): String

class PropertyParser

PropertyParser(aem: AemExtension)
fun boolean(name: String): Boolean?
fun checkForce(): Unit
val commonProps: Map<String, Any>
val envProps: MutableMap<String!, String!>!
fun expand(file: File, props: Map<String, Any?>): Unit
fun expand(source: String, props: Map<String, Any?>, context: String? = null): String
fun expandPackage(source: String, props: Map<String, Any?>, context: String? = null): String
fun flag(vararg names: String): Boolean
fun flag(name: String): Boolean
const val FORCE_PROP: String
fun int(name: String): Int?
fun isForce(): Boolean
fun list(name: String, delimiter: String = ","): List<String>?
fun long(name: String): Long?
fun map(name: String, valueDelimiter: String = ",", keyDelimiter: String = "="): Map<String, String>?
val projectProps: Map<String, Any>
fun string(name: String): String?
val systemProps: Map<String, String>

abstract class ProtocolFileTransfer : AbstractFileTransfer

ProtocolFileTransfer(aem: AemExtension)
open fun handles(fileUrl: String): Boolean
abstract val protocols: List<String>

class Provisioner

Provisioner(aem: AemExtension)
val aem: AemExtension
var greedy: Boolean
var instances: List<Instance>
var path: String
fun provision(): List<Action>
fun step(id: String, options: Step.() -> Unit): Unit
var stepName: String

open class ProvisionException : InstanceException

ProvisionException(message: String, cause: Throwable)
ProvisionException(message: String)

class QuickstartResolver

QuickstartResolver(aem: AemExtension)
var downloadDir: File
val files: List<File>
val jar: File?
var jarUrl: String?
val license: File?
var licenseUrl: String?
const val TEMPORARY_DIR: String

open class Rcp : AemDefaultTask

Rcp()
const val NAME: String
fun options(configurer: RcpClient.() -> Unit): Unit
fun run(): Unit

class RcpClient

RcpClient(aem: AemExtension)
var copiedPaths: Long
fun copy(): Unit
fun copy(pathsFile: File): Unit
fun copy(paths: Sequence<String>): Unit
fun copy(paths: Iterable<String>): Unit
fun copy(paths: Map<String, String>): Unit
fun copy(path: String): Unit
fun copy(sourcePath: String, targetPath: String): Unit
var opts: String
var paths: List<String>?
var pathsFile: File?
var sourceInstance: Instance?
val stopWatch: StopWatch
fun summary(): RcpSummary
var targetInstance: Instance?

data class RcpSummary

RcpSummary(source: Instance, target: Instance, copiedPaths: Long, duration: Long)
val copiedPaths: Long
val duration: Long
val durationString: String
val source: Instance
val target: Instance
fun toString(): String

class ReloadAction : AnyInstanceAction

ReloadAction(aem: AemExtension)
fun perform(): Unit

open class Reloader

Reloader(environment: Environment)
val configured: Boolean
val environment: Environment
fun start(): Unit

class RemoteInstance : AbstractInstance, Serializable

fun create(aem: AemExtension, httpUrl: String, configurer: RemoteInstance.() -> Unit = {}): RemoteInstance
lateinit var password: String
fun toString(): String
lateinit var user: String

class Repository : InstanceService

Repository(sync: InstanceSync)
fun node(path: String): Node
fun <T> node(path: String, options: Node.() -> T): T
fun node(path: String, properties: Map<String, Any?>): RepositoryResult
var responseChecks: Boolean
var typeHints: Boolean
var verboseLogging: Boolean

class RepositoryChange

RepositoryChange()
lateinit var argument: String
fun toString(): String
lateinit var type: String

class RepositoryError

RepositoryError()
lateinit var className: String
lateinit var message: String
fun toString(): String

class RepositoryException : InstanceException

RepositoryException(message: String, cause: Throwable)
RepositoryException(message: String)

class RepositoryHttpClient : InstanceHttpClient

RepositoryHttpClient(aem: AemExtension, instance: Instance)
fun throwStatusException(response: HttpResponse): Unit

class RepositoryResult

RepositoryResult()
lateinit var changes: List<RepositoryChange>
var error: RepositoryError?
val fail: Boolean
lateinit var location: String
lateinit var parentLocation: String
lateinit var path: String
lateinit var referer: String
var statusCode: Int
var statusMessage: String?
val success: Boolean
lateinit var title: String
fun toString(): String

object RepositoryType

fun dateFormat(): SimpleDateFormat
fun hint(value: Any?): String?
fun hintSimpleType(value: Any?): String?
fun normalize(value: Any?): Any?
fun normalizeSimpleType(value: Any?): Any?

class RequestException : AemException

RequestException(message: String, cause: Throwable)
RequestException(message: String)

open class Resetup : AemDefaultTask

Resetup()
const val NAME: String

open class Resolve : AemDefaultTask

Resolve()
const val NAME: String

class ResolveFileException : FileException

ResolveFileException(message: String, cause: Throwable)
ResolveFileException(message: String)

class ResolveFileTransfer : ProtocolFileTransfer

ResolveFileTransfer(aem: AemExtension)
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun handles(fileUrl: String): Boolean
val name: String
const val NAME: String
val parallelable: Boolean
val protocols: List<String>
fun resolve(value: Any): File

abstract class Resolver<G : FileGroup>

Resolver(aem: AemExtension, downloadDir: File)
val aem: AemExtension
val allFiles: List<File>
fun allFiles(filter: G.() -> Boolean): List<File>
fun allGroups(filter: G.() -> Boolean): List<G>
fun config(configurer: G.() -> Unit): Unit
abstract fun createGroup(name: String): G
fun download(urlDir: String, vararg fileNames: String): List<FileResolution>
fun download(urlDir: String, fileNames: Iterable<String>): List<FileResolution>
fun download(url: String): FileResolution
val downloadDir: File
fun downloadHttp(url: String, options: HttpFileTransfer.() -> Unit): FileResolution
fun downloadSftp(url: String, options: SftpFileTransfer.() -> Unit): FileResolution
fun downloadSmb(url: String, options: SmbFileTransfer.() -> Unit): FileResolution
fun get(value: Any): FileResolution
fun group(name: String): G
@Synchronized fun group(name: String, configurer: Resolver<G>.() -> Unit): Unit
fun group(name: String, downloadUrl: String): Unit
const val GROUP_DEFAULT: String
val groups: List<G>
operator fun String.invoke(value: Any): Unit
operator fun String.invoke(url: String, vararg fileNames: String): Unit
operator fun String.invoke(configurer: Resolver<G>.() -> Unit): Unit
var localFilePatterns: List<String>
val outputDirs: List<File>
fun outputDirs(filter: G.() -> Boolean): List<File>
var parallelLevel: Int
fun resolve(dependencyNotation: String): FileResolution
fun resolve(dependencyOptions: DependencyOptions.() -> Unit): FileResolution
fun useLocal(path: String): FileResolution
fun useLocal(sourceFile: File): FileResolution
fun useLocalBy(dir: Any, filePatterns: Iterable<String>, selector: Iterable<File>.() -> File?): FileResolution?
fun useLocalBy(dir: Any, selector: Iterable<File>.() -> File?): FileResolution?
fun useLocalLastModified(dir: Any): FileResolution?
fun useLocalLastNamed(dir: Any): FileResolution?
fun useLocalRecent(dir: Any): FileResolution?

class ResponseException : AemException

ResponseException(message: String, cause: Throwable)
ResponseException(message: String)

open class Restart : AemDefaultTask

Restart()
const val NAME: String

class Retry

val aem: AemExtension
fun after(times: Long, delay: (Long) -> Long): Unit
fun afterSecond(times: Long): Unit
fun afterSquaredSecond(times: Long): Unit
var delay: (Long) -> Long
fun none(aem: AemExtension): Retry
const val SECOND_MILIS: Long
var times: Long
inline fun <T, reified E> withCountdown(operation: String, block: (Long) -> T): T
inline fun <T, reified E> withSleep(block: (Long) -> T): T

open class RunSpec : DockerDefaultSpec

RunSpec(aem: AemExtension)
var cleanup: Boolean
var detached: Boolean
var image: String
var indicator: Boolean
var name: String?
val operation: String
fun operation(textProvider: () -> String): Unit
fun operation(text: String): Unit
fun port(hostPort: Int, containerPort: Int): Unit
fun port(hostPort: String, containerPort: String): Unit
fun port(port: Int): Unit
var ports: Map<String, String>
fun volume(localFile: File, containerPath: String): Unit
fun volume(localPath: String, containerPath: String): Unit
var volumes: Map<String, String>

interface Runtime

fun detect(aem: AemExtension): Runtime?
fun determine(aem: AemExtension): Runtime
abstract fun determinePath(path: String): String
open fun determinePath(file: File): String
abstract val hostInternalIp: String?
abstract val hostIp: String
abstract val name: String
fun of(aem: AemExtension, name: String): Runtime?
abstract val safeVolumes: Boolean

class Script

Script(instance: LocalInstance, shellCommand: List<String>, wrapper: File, bin: File)
val args: List<String>
val bin: File
val command: String
val commandLine: List<String>
fun executeAsync(): Unit
fun executeSync(options: ProcBuilder.() -> Unit = {}): ProcResult
val instance: LocalInstance
val shellCommand: List<String>
fun toString(): String
val wrapper: File

open class Setup : AemDefaultTask

Setup()
const val NAME: String

class SftpFileException : FileException

SftpFileException(message: String, cause: Throwable)
SftpFileException(message: String)

class SftpFileTransfer : ProtocolFileTransfer

SftpFileTransfer(aem: AemExtension)
fun client(options: SshClient.() -> Unit): Unit
var clientOptions: SshClient.() -> Unit
fun <T> connect(url: String, callback: SftpClient.(String) -> T): T
fun <T> connectDir(dirUrl: String, callback: SftpClient.(String) -> T): T
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun list(dirUrl: String): List<FileEntry>
val name: String
const val NAME: String
var password: String?
const val PORT_DEFAULT: Int
val protocols: List<String>
fun session(options: ClientSession.() -> Unit): Unit
var sessionOptions: ClientSession.() -> Unit
fun stat(dirUrl: String, fileName: String): FileEntry?
val STATUS_NOT_EXISTS: Array<Int>
var timeout: Long
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
var user: String?

class SmbFileException : FileException

SmbFileException(message: String, cause: Throwable)
SmbFileException(message: String)

class SmbFileTransfer : ProtocolFileTransfer

SmbFileTransfer(aem: AemExtension)
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun dir(dirUrl: String): SmbFile
var domain: String?
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun file(dirUrl: String, fileName: String): SmbFile
fun list(dirUrl: String): List<FileEntry>
val name: String
const val NAME: String
var password: String?
val protocols: List<String>
fun stat(dirUrl: String, fileName: String): FileEntry?
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
var user: String?

enum class Source

AUTO
BACKUP_ANY
BACKUP_LOCAL
BACKUP_REMOTE
fun of(name: String): Source
SCRATCH

class Stack

Stack(environment: Environment)
fun deploy(): Unit
var deployRetry: Retry
val environment: Environment
val initialized: Boolean
var initTimeout: Long
val internalName: String!
val networkAvailable: Boolean
var networkTimeout: Long
fun reset(): Unit
val running: Boolean
fun undeploy(): Unit
var undeployRetry: Retry

class StackException : DockerException

StackException(message: String, cause: Throwable)
StackException(message: String)

enum class Status

fun byExitCode(exitStatus: Int): Status
DEAD
val exitStatus: Int
NOT_RUNNING
fun of(name: String): Status
RUNNING
UNKNOWN

class Status : InstanceService

Status(sync: InstanceSync)
const val PRODUCT_INFO_PATH: String
val PRODUCT_VERSION_REGEX: Regex
val PRODUCT_VERSION_UNKNOWN: String!
val productVersion: String
fun readProductVersion(): String
fun readSystemProperties(): Map<String, String>
const val SYSTEM_PROPERTIES_PATH: String
val systemProperties: Map<String, String>

enum class Status

ENDED
FAILED
SKIPPED

class StatusException : InstanceException

StatusException(message: String, cause: Throwable)
StatusException(message: String)

class Step

Step(provisioner: Provisioner, id: String)
fun action(callback: Instance.() -> Unit): Unit
fun condition(callback: Condition.() -> Boolean): Unit
var conditionCallback: Condition.() -> Boolean
var continueOnFail: Boolean
var description: String?
val id: String
val provisioner: Provisioner
var rerunOnFail: Boolean
var retry: Retry
fun retry(options: Retry.() -> Unit): Unit
fun toString(): String
fun validate(): Unit

open class Sync : AemDefaultTask

Sync()
fun cleaner(options: Cleaner.() -> Unit): Unit
var contentDir: File
fun downloader(options: Downloader.() -> Unit): Unit
var filter: FilterFile
var instance: Instance
var mode: Mode
fun mode(name: String): Unit
enum class Mode

CLEAN_ONLY
COPY_AND_CLEAN
COPY_ONLY
fun of(name: String): Mode

const val NAME: String
fun sync(): Unit
var transfer: Transfer
fun transfer(name: String): Unit
enum class Transfer

fun of(name: String): Transfer
PACKAGE_DOWNLOAD
VLT_CHECKOUT

fun vlt(options: VltClient.() -> Unit): Unit

class TaskSequence

TaskSequence()
var afterTasks: Collection<Any>
var dependentTasks: Collection<Any>
fun dependsOn(vararg tasks: Any): Unit
fun dependsOn(tasks: Collection<Any>): Unit
fun dependsOrdered(vararg tasks: Any): Unit
fun mustRunAfter(vararg tasks: Any): Unit
fun mustRunAfter(tasks: Collection<Any>): Unit

class TimeoutCheck : DefaultCheck

TimeoutCheck(group: CheckGroup)
fun check(): Unit
var constantTime: Long
var stateTime: Long

class Toolbox : Base

Toolbox(aem: AemExtension)
var cygpathPath: String
fun detectHostIp(): String?
fun determinePath(path: String): String
fun executeCygpath(path: String): String
val hostInternalIp: String?
val hostIp: String
fun imitateCygpath(path: String): String
val name: String
const val NAME: String
val safeVolumes: Boolean

class ToolingPlugin : AemPlugin

ToolingPlugin()
fun Project.configure(): Unit
const val ID: String

class UnavailableCheck : DefaultCheck

UnavailableCheck(group: CheckGroup)
fun check(): Unit
val STATUS_EXPECTED: List<Status>
var utilisationTime: Long

class UnchangedCheck : DefaultCheck

UnchangedCheck(group: CheckGroup)
var awaitTime: Long
fun check(): Unit

class UninstallResponse : HtmlResponse

fun from(input: InputStream, bufferSize: Int): UninstallResponse
protected fun getErrorPatterns(): List<ErrorPattern>
val status: Status

open class Up : AemDefaultTask

Up()
const val NAME: String

class UploadResponse

fun fromJson(json: InputStream): UploadResponse
var isSuccess: Boolean
lateinit var msg: String
lateinit var path: String

class UrlCheck

UrlCheck(url: String)
fun check(spec: HttpClient.(HttpResponse) -> Unit): Unit
fun containsText(text: String, statusCode: Int = HttpStatus.SC_OK): Unit
var method: String
fun options(options: HttpClient.() -> Unit): Unit
val url: String

class UrlFileTransfer : ProtocolFileTransfer

UrlFileTransfer(aem: AemExtension)
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
val name: String
const val NAME: String
const val PROTOCOL: String
val protocols: List<String>

class UrlSource : LogSource

UrlSource(tailer: InstanceTailer, instance: Instance)
fun <T> readChunk(parser: (BufferedReader) -> List<T>): List<T>

object Utils

fun mapOfNonNullValues(vararg entries: Pair<String, String?>): Map<String, String>
fun unroll(value: Any?, callback: (Any?) -> Unit): Unit

open class Vlt : AemDefaultTask

Vlt()
const val NAME: String
fun options(configurer: VltClient.() -> Unit): Unit
open fun run(): Unit

class VltApp : VaultFsApp

VltApp(project: Project)
const val CURRENT_WORKING_DIR: String
fun execute(command: String, workingPath: String): Unit
fun execute(command: String, workingDir: File): Unit
fun execute(args: List<String>, workingDir: File): Unit
@Synchronized fun execute(args: List<String>, workingPath: String): Unit
protected fun getDefaultContext(): ExecutionContext
val project: Project

class VltClient

VltClient(aem: AemExtension)
val aem: AemExtension
var command: String
val commandEffective: String
var commandProperties: Map<String, Any>
var contentDir: File
val contentDirEffective: File
var contentRelativePath: String
fun run(): VltSummary

open class VltDefinition

VltDefinition(aem: AemExtension)
var createdBy: String?
var description: String?
fun ensureDefaults(): Unit
fun filter(root: String, definition: FilterElement.() -> Unit = {}): Unit
val filterEffectives: Collection<FilterElement>
var filterElements: MutableList<FilterElement>
fun filterElements(file: File): Unit
val filterRoots: Collection<String>
val filters: Collection<String>
fun filters(vararg roots: String): Unit
fun filters(roots: Iterable<String>): Unit
var group: String
var name: String
val NODE_TYPES_LIB: Pattern
var nodeTypeLibs: MutableList<String>
var nodeTypeLines: MutableList<String>
val nodeTypes: String
fun nodeTypes(file: File): Unit
fun nodeTypes(text: String): Unit
var properties: MutableMap<String, Any>
fun property(name: String, value: String): Unit
var version: String

class VltException : AemException

VltException(message: String, cause: Throwable)
VltException(message: String)

class VltExecutionContext : VltExecutionContext

VltExecutionContext(app: VltApp)
fun execute(commandLine: CommandLine): Boolean

data class VltSummary

VltSummary(command: String, contentDir: File, duration: Long)
val command: String
val contentDir: File
val duration: Long
val durationString: String
fun toString(): String

class Workflow

Workflow(manager: WorkflowManager, id: String)
fun disable(): Unit
fun enable(): Unit
val enabled: Boolean
const val ENABLED_PROP: String
val exists: Boolean
val id: String
val launcher: Node
val launcherFrozen: Node
val manager: WorkflowManager
fun restore(): Unit
fun toggle(): Unit
fun toggle(flag: Boolean): Unit

class WorkflowManager : InstanceService

WorkflowManager(sync: InstanceSync)
val configFrozen: Boolean
val repository: Repository
var restoreIntended: Boolean
var restoreRetry: Retry
fun toggle(typeFlags: Map<String, Boolean>): Unit
fun toggle(type: String, flag: Boolean): Unit
fun toggle(types: Iterable<String>, flag: Boolean): Unit
fun toggle(vararg types: String, flag: Boolean): Unit
fun toggleTemporarily(type: String, flag: Boolean, action: () -> Unit): Unit
fun toggleTemporarily(typeFlags: Map<String, Boolean>, action: () -> Unit): Unit
fun workflow(id: String): Workflow
fun workflows(type: String): List<Workflow>
fun workflows(types: Iterable<String>): List<Workflow>
fun workflows(vararg types: String): List<Workflow>

enum class WorkflowType

DAM_ASSET
val ids: List<String>
fun ids(type: String): List<String>
fun ids(types: Iterable<String>): List<String>
fun of(type: String): WorkflowType?

open class ZipTask : Zip, AemTask

ZipTask()
val aem: AemExtension
protected open fun copy(): Unit
var copyProgress: ProgressIndicator.() -> Unit

package com.cognifide.gradle.aem

open class AemDefaultTask : DefaultTask, AemTask

AemDefaultTask()
val aem: AemExtension
fun checkForce(): Unit
open fun projectEvaluated(): Unit
fun projectEvaluated(callback: () -> Unit): Unit
open fun projectsEvaluated(): Unit
fun projectsEvaluated(callback: () -> Unit): Unit
open fun taskGraphReady(graph: TaskExecutionGraph): Unit
fun taskGraphReady(callback: (TaskExecutionGraph) -> Unit): Unit

open class AemException : GradleException

AemException(message: String, cause: Throwable)
AemException(message: String)

class AemExtension : Serializable

AemExtension(project: Project)
val anyInstance: Instance
val authorInstance: Instance
val authorInstances: List<Instance>
fun authorInstances(consumer: (Instance) -> Unit): Unit
val availableInstance: Instance?
val baseName: String
val buildScope: BuildScope
val bundle: File
val bundles: List<File>
fun composePackage(definition: PackageDefinition.() -> Unit): File
val configCommonDir: File
val configDir: File
fun dependentBundles(task: Task): List<File>
fun dependentPackages(task: Task): List<File>
fun dockerDaemon(spec: DaemonSpec.() -> Unit): Unit
fun dockerRun(spec: RunSpec.() -> Unit): DockerResult
val env: String
val environment: Environment
fun environment(configurer: Environment.() -> Unit): Unit
val fileTransfer: FileTransferManager
fun fileTransfer(options: FileTransferManager.() -> Unit): Unit
val filter: FilterFile
fun filter(file: File): FilterFile
fun filter(path: String): FilterFile
fun filterInstances(nameMatcher: String = props.string("instance.name") ?: "$env-*"): List<Instance>
val formats: Formats
fun <T> http(consumer: HttpClient.() -> T): T
fun <T> httpFile(consumer: HttpFileTransfer.() -> T): T
fun instance(options: InstanceOptions.() -> Unit): Unit
fun instance(urlOrName: String): Instance
val instanceActions: InstanceActionPerformer
val instanceOptions: InstanceOptions
val instances: List<Instance>
fun instances(consumer: (Instance) -> Unit): Unit
fun instances(filter: String, consumer: (Instance) -> Unit): Unit
fun instances(urlsOrNames: Iterable<String>): List<Instance>
val javaPackages: List<String>
var lineSeparator: String
val lineSeparatorString: String
fun localInstance(options: LocalInstanceManager.() -> Unit): LocalInstanceManager
val localInstanceManager: LocalInstanceManager
val localInstances: List<LocalInstance>
fun localInstances(consumer: LocalInstance.() -> Unit): Unit
val logger: Logger!
val main: AemExtension
const val NAME: String
fun namedInstance(desiredName: String? = props.string("instance.name"), defaultName: String = "$env-*"): Instance
val notifier: NotifierFacade
fun notifier(configurer: NotifierFacade.() -> Unit): Unit
fun of(project: Project): AemExtension
val offline: Boolean
fun package(options: PackageOptions.() -> Unit): Unit
fun package(file: File): PackageFile
val package: File
val packageOptions: PackageOptions
val packages: List<File>
val parallel: Parallel
val patterns: Patterns
fun pkg(options: PackageOptions.() -> Unit): Unit
fun pkg(file: File): PackageFile
val pkg: File
fun <T> progress(total: Int, action: ProgressIndicator.() -> T): T
fun <T> progress(total: Long, action: ProgressIndicator.() -> T): T
fun <T> progress(action: ProgressIndicator.() -> T): T
fun progressCountdown(time: Long): Unit
fun progressCountdown(options: ProgressCountdown.() -> Unit): Unit
fun <T> progressIndicator(action: ProgressIndicator.() -> T): T
fun <T> progressLogger(action: ProgressLogger.() -> T): T
val project: Project
val projectMain: Project
val projectName: String
val projectPrefixes: List<String>
val props: PropertyParser
val publishInstance: Instance
val publishInstances: List<Instance>
fun publishInstances(consumer: Instance.() -> Unit): Unit
fun <T> rcp(options: RcpClient.() -> T): T
val remoteInstances: List<RemoteInstance>
fun remoteInstances(consumer: RemoteInstance.() -> Unit): Unit
fun resolveFile(value: Any): File
fun resolveFile(options: FileResolver.() -> Unit): File
fun resolveFiles(options: FileResolver.() -> Unit): List<File>
fun resolveFiles(downloadDir: File, options: FileResolver.() -> Unit): List<File>
fun retry(configurer: Retry.() -> Unit): Retry
fun retry(): Retry
fun <T> sftpFile(consumer: SftpFileTransfer.() -> T): T
fun <T> smbFile(consumer: SmbFileTransfer.() -> T): T
fun sync(action: InstanceSync.() -> Unit): Unit
fun <T> sync(instance: Instance, action: InstanceSync.() -> T): T
fun sync(instances: Iterable<Instance>, action: InstanceSync.() -> Unit): Unit
fun syncBundles(action: InstanceSync.(File) -> Unit): Unit
fun syncFiles(instances: Iterable<Instance>, packages: Iterable<File>, action: InstanceSync.(File) -> Unit): Unit
fun <T> syncInstance(instance: Instance, action: InstanceSync.() -> T): T
fun syncInstances(action: InstanceSync.() -> Unit): Unit
fun syncInstances(instances: Iterable<Instance>, action: InstanceSync.() -> Unit): Unit
fun syncPackages(action: InstanceSync.(File) -> Unit): Unit
val tasks: AemTaskFacade
fun tasks(configurer: AemTaskFacade.() -> Unit): Unit
const val TEMPORARY_DIR: String
fun temporaryDir(task: Task): File
fun temporaryDir(name: String): File
val temporaryDir: File
fun temporaryFile(name: String): File
val userInput: UserInputHandler
fun validatePackage(vararg packages: File, options: PackageValidator.() -> Unit): Unit
fun validatePackage(packages: Iterable<File>, options: PackageValidator.() -> Unit): Unit
fun vlt(command: String): VltSummary
fun <T> vlt(options: VltClient.() -> T): T
fun waitFor(time: Long): Unit
fun watchFiles(options: FileWatcher.() -> Unit): Unit

abstract class AemPlugin : Plugin<Project>

AemPlugin()
open fun apply(project: Project): Unit
class Build : Serializable

Build()
lateinit var gradleVersion: String
lateinit var pluginVersion: String

val BUILD: Build
abstract fun Project.configure(): Unit
val ID: String
val NAME: String
val NAME_WITH_VERSION: String
@Synchronized fun once(callback: (Build) -> Unit): Unit
const val PKG: String
protected fun Project.tasks(configurer: AemTaskFacade.() -> Unit): Unit
fun withId(project: Project, id: String): List<Project>

interface AemTask : Task

abstract val aem: AemExtension
const val GROUP: String
open fun projectEvaluated(): Unit
open fun projectsEvaluated(): Unit
open fun taskGraphReady(graph: TaskExecutionGraph): Unit
fun temporaryDir(project: Project, taskName: String): File
fun temporaryDir(project: Project, taskName: String, path: String): File
fun temporaryFile(project: Project, taskName: String, name: String): File

class AemTaskFacade : Serializable

AemTaskFacade(aem: AemExtension)
val aem: AemExtension
fun bundleCompose(configurer: BundleCompose.() -> Unit): TaskProvider<BundleCompose>
fun bundleEmbed(dependencyOptions: DependencyOptions.() -> Unit, export: Boolean, pkgs: Iterable<String>): Unit
fun bundleEmbed(dependencyNotation: Any, export: Boolean, pkgs: Iterable<String>): Unit
fun bundleExportEmbed(dependencyNotation: Any, vararg pkgs: String): Unit
fun bundleExportEmbed(dependencyNotation: Any, pkgs: Iterable<String>): Unit
fun bundlePrivateEmbed(dependencyNotation: Any, vararg pkgs: String): Unit
fun bundlePrivateEmbed(dependencyNotation: Any, pkgs: Iterable<String>): Unit
val bundles: List<BundleCompose!>
val checks: List<Task>
fun debug(configurer: Debug.() -> Unit): TaskProvider<Debug>
fun destroy(configurer: Destroy.() -> Unit): TaskProvider<Destroy>
fun down(configurer: Down.() -> Unit): TaskProvider<Down>
fun environmentAwait(configurer: EnvironmentAwait.() -> Unit): TaskProvider<EnvironmentAwait>
fun environmentDestroy(configurer: EnvironmentDestroy.() -> Unit): TaskProvider<EnvironmentDestroy>
fun environmentDev(configurer: EnvironmentDev.() -> Unit): TaskProvider<EnvironmentDev>
fun environmentDown(configurer: EnvironmentDown.() -> Unit): TaskProvider<EnvironmentDown>
fun environmentHosts(configurer: EnvironmentHosts.() -> Unit): TaskProvider<EnvironmentHosts>
fun environmentRestart(configurer: EnvironmentRestart.() -> Unit): TaskProvider<EnvironmentRestart>
fun environmentUp(configurer: EnvironmentUp.() -> Unit): TaskProvider<EnvironmentUp>
fun <reified T : Task> get(path: String): T
fun <T : Task> get(path: String, type: Class<T>): T
fun <reified T : Task> getAll(): List<T!>
fun <T : Task> getAll(type: Class<T>): List<T!>
fun instanceAwait(configurer: InstanceAwait.() -> Unit): TaskProvider<InstanceAwait>
fun instanceBackup(configurer: InstanceBackup.() -> Unit): TaskProvider<InstanceBackup>
fun instanceCreate(configurer: InstanceCreate.() -> Unit): TaskProvider<InstanceCreate>
fun instanceDestroy(configurer: InstanceDestroy.() -> Unit): TaskProvider<InstanceDestroy>
fun instanceDown(configurer: InstanceDown.() -> Unit): TaskProvider<InstanceDown>
fun instanceProvision(configurer: InstanceProvision.() -> Unit): TaskProvider<InstanceProvision>
fun instanceReload(configurer: InstanceReload.() -> Unit): TaskProvider<InstanceReload>
fun instanceResetup(configurer: InstanceResetup.() -> Unit): TaskProvider<InstanceResetup>
fun instanceRestart(configurer: InstanceRestart.() -> Unit): TaskProvider<InstanceRestart>
val instanceSatisfy: InstanceSatisfy
fun instanceSatisfy(configurer: InstanceSatisfy.() -> Unit): TaskProvider<InstanceSatisfy>
fun instanceSetup(configurer: InstanceSetup.() -> Unit): TaskProvider<InstanceSetup>
fun instanceTail(configurer: InstanceTail.() -> Unit): TaskProvider<InstanceTail>
fun instanceUp(configurer: InstanceUp.() -> Unit): TaskProvider<InstanceUp>
fun named(name: String): TaskProvider<Task>
inline fun <reified T : Task> named(name: String, noinline configurer: T.() -> Unit = {}): TaskProvider<T>
fun <T : Task> named(name: String, type: Class<T>, configurer: T.() -> Unit): TaskProvider<T>
fun packageActivate(configurer: PackageActivate.() -> Unit): TaskProvider<PackageActivate>
fun packageCompose(configurer: PackageCompose.() -> Unit): TaskProvider<PackageCompose>
fun packageDelete(configurer: PackageDelete.() -> Unit): TaskProvider<PackageDelete>
fun packageDeploy(configurer: PackageDeploy.() -> Unit): TaskProvider<PackageDeploy>
fun packageInstall(configurer: PackageInstall.() -> Unit): TaskProvider<PackageInstall>
fun packagePurge(configurer: PackagePurge.() -> Unit): TaskProvider<PackagePurge>
val packages: List<PackageCompose!>
fun packageUninstall(configurer: PackageUninstall.() -> Unit): TaskProvider<PackageUninstall>
fun packageUpload(configurer: PackageUpload.() -> Unit): TaskProvider<PackageUpload>
fun pathed(path: String): TaskProvider<Task>
fun pathed(paths: Collection<Any>): List<TaskProvider<out Task>>
val project: Project
fun rcp(configurer: Rcp.() -> Unit): TaskProvider<Rcp>
inline fun <reified T : Task> register(name: String, noinline configurer: T.() -> Unit = {}): TaskProvider<T>
fun <T : Task> register(name: String, clazz: Class<T>, configurer: T.() -> Unit = {}): TaskProvider<T>
fun register(name: String, configurer: AemDefaultTask.() -> Unit): Unit
inline fun <reified T : Task> registerOrConfigure(name: String, noinline configurer: T.() -> Unit = {}): TaskProvider<T>
inline fun <reified T : Task> registerOrConfigure(vararg names: String, noinline configurer: T.() -> Unit = {}): Unit
fun registerSequence(name: String, sequenceOptions: TaskSequence.() -> Unit): TaskProvider<Task>
fun registerSequence(name: String, taskOptions: Task.() -> Unit, sequenceOptions: TaskSequence.() -> Unit): TaskProvider<Task>
fun resetup(configurer: Resetup.() -> Unit): TaskProvider<Resetup>
fun restart(configurer: Restart.() -> Unit): TaskProvider<Restart>
fun setup(configurer: Setup.() -> Unit): TaskProvider<Setup>
fun sync(configurer: Sync.() -> Unit): TaskProvider<Sync>
val tests: List<Test!>
inline fun <reified T : Task> typed(noinline configurer: T.() -> Unit): Unit
fun <T : Task> typed(type: Class<T>, configurer: T.() -> Unit): Unit
fun up(configurer: Up.() -> Unit): TaskProvider<Up>
fun vlt(configurer: Vlt.() -> Unit): TaskProvider<Vlt>

package com.cognifide.gradle.aem.bundle

class BundleException : AemException

BundleException(message: String, cause: Throwable)
BundleException(message: String)

class BundlePlugin : AemPlugin

BundlePlugin()
fun Project.configure(): Unit
const val ID: String

package com.cognifide.gradle.aem.bundle.tasks

open class BundleCompose : Jar, AemTask

BundleCompose()
var activator: String?
val ACTIVATOR_CLASSES: List<String>
val aem: AemExtension
fun attribute(name: String, value: String?): Manifest!
fun attribute(name: String): String?
var attributes: MutableMap<String, Any?>
var attributesConvention: Boolean
fun bndTool(options: BundleTaskConvention.() -> Unit): Unit
val bundleConvention: BundleTaskConvention
var category: String?
val composedDir: File
val composedFile: File
var contributors: String?
protected open fun copy(): Unit
var copyright: String?
var developers: String?
var displayName: String?
var docUrl: String?
fun excludePackage(pkgs: Iterable<String>): Unit
fun excludePackage(vararg pkgs: String): Unit
fun exportPackage(pkgs: Iterable<String>): Unit
fun exportPackage(vararg pkgs: String): Unit
var exportPackages: List<String>
var fragmentHost: String?
fun hasAttribute(name: String): Boolean
fun importPackage(pkgs: Iterable<String>): Unit
fun importPackage(vararg pkgs: String): Unit
var importPackages: List<String>
var installPath: String
var installRunMode: String?
val javaConvention: JavaPluginConvention!
var javaPackage: String?
var javaPackageOptions: String
var license: String?
const val NAME: String
fun privatePackage(pkgs: Iterable<String>): Unit
fun privatePackage(vararg pkgs: String): Unit
var privatePackages: List<String>
open fun projectEvaluated(): Unit
var slingModelPackages: String?
val SOURCE_SETS: Map<String, String>
var symbolicName: String?
var vaultFilter: Boolean
var vendor: String?
fun wildcardPackage(pkgs: Iterable<String>): List<String>
fun wildcardPackage(vararg pkgs: String): List<String>

open class BundleInstall : BundleTask

BundleInstall()
var awaited: Boolean
fun awaitUp(options: AwaitUpAction.() -> Unit): Unit
fun awaitUp(): Unit
var completer: () -> Unit
var finalizer: InstanceSync.() -> Unit
var initializer: InstanceSync.() -> Unit
open fun install(): Unit
const val NAME: String
var refreshPackages: Boolean
var retry: Retry
var start: Boolean
var startLevel: Int

open class BundleUninstall : BundleTask

BundleUninstall()
const val NAME: String
fun uninstall(): Unit

package com.cognifide.gradle.aem.common

class CommonPlugin : AemPlugin

CommonPlugin()
fun Project.configure(): Unit
const val ID: String
const val STRUCTURE_PROPERTIES_FILE: String

package com.cognifide.gradle.aem.common.build

object Behaviors

class Timer

Timer()
val elapsed: Long
fun reset(): Unit
val started: Long
fun tick(): Unit
val ticks: Long

fun waitFor(duration: Int): Unit
fun waitFor(duration: Long): Unit
fun waitUntil(interval: Int, condition: (Timer) -> Boolean): Unit
fun waitUntil(interval: Long, condition: (Timer) -> Boolean): Unit
fun waitUntil(interval: (Long) -> Long, condition: (Timer) -> Boolean): Unit

class BuildScope

BuildScope()
@Synchronized fun doOnce(operation: String, action: () -> Unit): Boolean?
fun <T : Any> get(key: String): T?
fun <T : Any> getOrPut(key: String, defaultValue: () -> T): T
fun <T : Any> getOrPut(key: String, defaultValue: () -> T, invalidate: Boolean): T
fun of(project: Project): BuildScope
fun <T : Any> put(key: String, value: T): Unit
fun <T : Any> tryGetOrPut(key: String, defaultValue: () -> T?): T?

class CollectingLogger

CollectingLogger()
fun debug(message: String): Unit
fun debug(summary: String, details: String): Unit
val entries: MutableList<LogEntry>
fun error(message: String): Unit
fun error(summary: String, details: String): Unit
fun info(message: String): Unit
fun info(summary: String, details: String): Unit
fun lifecycle(message: String): Unit
fun lifecycle(summary: String, details: String): Unit
fun log(level: LogLevel, details: String, summary: String? = null): Unit
data class LogEntry

LogEntry(level: LogLevel, details: String, summary: String? = null)
val details: String
val level: LogLevel
val summary: String?

fun logTo(logger: Logger, levelMapper: (LogLevel) -> LogLevel = { it }): Unit
fun warn(message: String): Unit
fun warn(summary: String, details: String): Unit

class DependencyOptions

DependencyOptions()
fun add(aem: AemExtension, configuration: String, options: DependencyOptions.() -> Unit): Unit
fun add(aem: AemExtension, configuration: String, notation: Any): Unit
var classifier: String?
var configuration: String?
fun create(aem: AemExtension, notation: Any): Dependency
fun create(aem: AemExtension, options: DependencyOptions.() -> Unit): Dependency
fun dependency(group: String, name: String, version: String? = null, configuration: String? = null, classifier: String? = null, ext: String? = null): Unit
var ext: String?
lateinit var group: String
fun isNotation(text: String): Boolean
lateinit var name: String
val notation: String
fun resolve(aem: AemExtension, notation: Any): File
var version: String?

open class InternalApi

InternalApi(project: Project)
operator fun invoke(obj: Any, method: String, vararg args: Any): Any
fun invoke(obj: Any, method: String, args: List<Any?>, argTypes: List<Class<out Any>>): Any
val project: Project
fun <T : Any> service(clazz: KClass<T>): T
val serviceFactory: Any

object Parallel

fun <A> each(iterable: Iterable<A>, callback: CoroutineScope.(A) -> Unit): Unit
fun <A, B : Any> map(iterable: Iterable<A>, mapper: CoroutineScope.(A) -> B): Collection<B>
fun <A, B : Any> map(iterable: Iterable<A>, filter: (A) -> Boolean, mapper: CoroutineScope.(A) -> B): List<B>
fun <A> poolEach(threads: Int, name: String, iterable: Iterable<A>, callback: CoroutineScope.(A) -> Unit): Unit
fun <A, B : Any> poolMap(threads: Int, name: String, iterable: Iterable<A>, mapper: CoroutineScope.(A) -> B): List<B>
fun <A> with(iterable: Iterable<A>, callback: A.() -> Unit): Unit

class ProgressCountdown

ProgressCountdown(project: Project)
var loggerInterval: Int
fun progress(messageComposer: (Long) -> String): Unit
fun run(): Unit
var time: Long
var timePrefix: String

class ProgressIndicator

ProgressIndicator(project: Project)
var count: Long
fun increment(): Unit
fun increment(message: String): Unit
fun <T> increment(message: String, block: () -> T): T
fun <T> launch(block: ProgressIndicator.() -> T): T
var message: String
fun reset(): Unit
var step: String
var total: Long
fun update(): Unit
fun update(message: String): Unit
fun updater(updater: ProgressIndicator.() -> Unit): Unit

open class ProgressLogger

var header: String
fun <T> launch(block: ProgressLogger.() -> T): T
fun of(project: Project): ProgressLogger
fun parents(project: Project): Queue<ProgressLogger>
fun progress(message: String): Unit
var progressEach: (String) -> Unit
var progressWindow: Long

class PropertyParser

PropertyParser(aem: AemExtension)
fun boolean(name: String): Boolean?
fun checkForce(): Unit
val commonProps: Map<String, Any>
val envProps: MutableMap<String!, String!>!
fun expand(file: File, props: Map<String, Any?>): Unit
fun expand(source: String, props: Map<String, Any?>, context: String? = null): String
fun expandPackage(source: String, props: Map<String, Any?>, context: String? = null): String
fun flag(vararg names: String): Boolean
fun flag(name: String): Boolean
const val FORCE_PROP: String
fun int(name: String): Int?
fun isForce(): Boolean
fun list(name: String, delimiter: String = ","): List<String>?
fun long(name: String): Long?
fun map(name: String, valueDelimiter: String = ",", keyDelimiter: String = "="): Map<String, String>?
val projectProps: Map<String, Any>
fun string(name: String): String?
val systemProps: Map<String, String>

class Retry

val aem: AemExtension
fun after(times: Long, delay: (Long) -> Long): Unit
fun afterSecond(times: Long): Unit
fun afterSquaredSecond(times: Long): Unit
var delay: (Long) -> Long
fun none(aem: AemExtension): Retry
const val SECOND_MILIS: Long
var times: Long
inline fun <T, reified E> withCountdown(operation: String, block: (Long) -> T): T
inline fun <T, reified E> withSleep(block: (Long) -> T): T

package com.cognifide.gradle.aem.common.bundle

class BundleException : AemException

BundleException(message: String, cause: Throwable)
BundleException(message: String)

class BundleFile : Serializable

BundleFile(file: File)
val description: String
val file: File
val group: String
val jar: Jar
val symbolicName: String
fun toString(): String
val version: String

package com.cognifide.gradle.aem.common.file

class FileContentReader : BaseFilterReader, ChainableReader

FileContentReader(input: Reader)
fun chain(reader: Reader): Reader
fun filter(filterable: ContentFilterable, filter: (String) -> String): Unit
fun props(filter: (String) -> String): Map<String, (String) -> String>
fun read(): Int

open class FileException : AemException

FileException(message: String, cause: Throwable)
FileException(message: String)

object FileOperations

fun amendFile(file: File, amender: (String) -> String): Unit
fun amendFiles(dir: File, wildcardFilters: List<String>, amender: (File, String) -> String): Unit
fun copyResources(resourceRoot: String, targetDir: File, skipExisting: Boolean = false): Unit
fun eachResource(resourceRoot: String, targetDir: File, callback: (String, File) -> Unit): Unit
fun find(project: Project, dirIfFileName: String, pathOrFileNames: List<String>): File?
fun find(project: Project, dirIfFileName: String, pathOrFileName: String): File?
fun find(dir: File, pattern: String): File?
fun find(dir: File, patterns: List<String>): File?
fun getResources(path: String): List<String>
fun isDirEmpty(dir: File): Boolean
fun isDirEmpty(dir: Path): Boolean
fun lock(file: File): Unit
fun lock(file: File, callback: () -> Unit): Unit
fun readResource(path: String): InputStream?
fun removeDirContents(dir: File): Boolean
fun zipContains(zip: File, fileName: String): Boolean
fun zipPack(zip: File, sourceDir: File): Unit
fun zipUnpackAll(zip: File, targetDir: File): Unit
fun zipUnpackDir(zip: File, dirName: String, dir: File): Unit

open class FileWatcher

FileWatcher(aem: AemExtension)
val aem: AemExtension
lateinit var dirs: List<File>
fun ignore(vararg paths: String): Unit
fun ignore(paths: Iterable<String>): Unit
var ignores: MutableList<String>
var interval: Long
lateinit var onChange: (Event) -> Unit
fun start(): Unit

package com.cognifide.gradle.aem.common.file.resolver

open class FileGroup

FileGroup(aem: AemExtension, downloadDir: File, name: String)
val aem: AemExtension
protected open fun createResolution(id: String, resolver: (FileResolution) -> File): FileResolution
val dirs: List<File>
val downloadDir: File
val files: List<File>
val name: String
val resolutions: List<FileResolution>
fun resolve(id: String, resolver: (FileResolution) -> File): FileResolution
fun resolve(): List<File>

open class FileResolution

FileResolution(group: FileGroup, id: String, resolver: (FileResolution) -> File)
fun archiveFile(archive: File, entryPattern: String): File
fun archiveFiles(archive: File, entriesPattern: String): Sequence<File>
fun archiveTree(archive: File): FileTree
fun copyArchiveFile(archive: File, entryPattern: String, target: File): File
fun copyArchiveFiles(archive: File, entriesPattern: String, targetDir: File): Unit
fun copyFile(source: File, target: File): Unit
fun copyToDirectory(source: File, targetDir: File): Unit
val dir: File
val file: File
val group: FileGroup
val id: String
fun resolve(): File
fun then(operation: FileResolution.(File) -> File): Unit
fun use(operation: FileResolution.(File) -> Unit): Unit

open class FileResolver : Resolver<FileGroup>

FileResolver(aem: AemExtension, downloadDir: File)
open fun createGroup(name: String): FileGroup

abstract class Resolver<G : FileGroup>

Resolver(aem: AemExtension, downloadDir: File)
val aem: AemExtension
val allFiles: List<File>
fun allFiles(filter: G.() -> Boolean): List<File>
fun allGroups(filter: G.() -> Boolean): List<G>
fun config(configurer: G.() -> Unit): Unit
abstract fun createGroup(name: String): G
fun download(urlDir: String, vararg fileNames: String): List<FileResolution>
fun download(urlDir: String, fileNames: Iterable<String>): List<FileResolution>
fun download(url: String): FileResolution
val downloadDir: File
fun downloadHttp(url: String, options: HttpFileTransfer.() -> Unit): FileResolution
fun downloadSftp(url: String, options: SftpFileTransfer.() -> Unit): FileResolution
fun downloadSmb(url: String, options: SmbFileTransfer.() -> Unit): FileResolution
fun get(value: Any): FileResolution
fun group(name: String): G
@Synchronized fun group(name: String, configurer: Resolver<G>.() -> Unit): Unit
fun group(name: String, downloadUrl: String): Unit
const val GROUP_DEFAULT: String
val groups: List<G>
operator fun String.invoke(value: Any): Unit
operator fun String.invoke(url: String, vararg fileNames: String): Unit
operator fun String.invoke(configurer: Resolver<G>.() -> Unit): Unit
var localFilePatterns: List<String>
val outputDirs: List<File>
fun outputDirs(filter: G.() -> Boolean): List<File>
var parallelLevel: Int
fun resolve(dependencyNotation: String): FileResolution
fun resolve(dependencyOptions: DependencyOptions.() -> Unit): FileResolution
fun useLocal(path: String): FileResolution
fun useLocal(sourceFile: File): FileResolution
fun useLocalBy(dir: Any, filePatterns: Iterable<String>, selector: Iterable<File>.() -> File?): FileResolution?
fun useLocalBy(dir: Any, selector: Iterable<File>.() -> File?): FileResolution?
fun useLocalLastModified(dir: Any): FileResolution?
fun useLocalLastNamed(dir: Any): FileResolution?
fun useLocalRecent(dir: Any): FileResolution?

package com.cognifide.gradle.aem.common.file.transfer

abstract class AbstractFileTransfer : FileTransferHandler, Serializable

AbstractFileTransfer(aem: AemExtension)
protected val aem: AemExtension
open fun deleteFrom(dirUrl: String, fileName: String): Unit
open fun download(fileUrl: String): Unit
fun downloader(): FileDownloader
open fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
open var enabled: Boolean
open fun list(dirUrl: String): List<FileEntry>
open val parallelable: Boolean
open fun stat(dirUrl: String, fileName: String): FileEntry?
open fun truncate(dirUrl: String): Unit
fun uploader(): FileUploader
open fun uploadTo(dirUrl: String, fileName: String, source: File): Unit

class FileDownloader

FileDownloader(aem: AemExtension)
fun download(size: Long, input: InputStream, target: File): Unit
const val KILOBYTE: Int
fun ProgressLogger.logProgress(operation: String, readLength: Long, fullLength: Long, file: File, startDownloadTime: Long): Unit
fun remainingDownloadTime(startDownloadTime: Long, fullLength: Long): Long
const val TRANSFER_CHUNK_100_KB: Int

data class FileEntry

FileEntry(name: String, size: Long? = null, modified: Long? = null)
val modified: Long?
val name: String
fun of(file: File): FileEntry
val size: Long?

interface FileTransfer

open fun delete(fileUrl: String): Unit
abstract fun deleteFrom(dirUrl: String, fileName: String): Unit
open fun download(fileUrl: String, target: File): Unit
abstract fun download(fileUrl: String): Unit
abstract fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
open fun downloadTo(fileUrl: String, dir: File): File
open fun exists(fileUrl: String): Boolean
open fun exists(dirUrl: String, fileName: String): Boolean
abstract fun handles(fileUrl: String): Boolean
abstract fun list(dirUrl: String): List<FileEntry>
fun splitFileUrl(fileUrl: String): Pair<String, String>
abstract fun stat(dirUrl: String, fileName: String): FileEntry?
open fun stat(fileUrl: String): FileEntry?
abstract fun truncate(dirUrl: String): Unit
open fun upload(fileUrl: String, source: File): Unit
abstract fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
open fun uploadTo(dirUrl: String, source: File): Unit

class FileTransferFactory

FileTransferFactory(aem: AemExtension)
fun <T> http(options: HttpFileTransfer.() -> T): T
fun <T> sftp(options: SftpFileTransfer.() -> T): T
fun <T> smb(options: SmbFileTransfer.() -> T): T

interface FileTransferHandler : FileTransfer

abstract val enabled: Boolean
abstract val name: String
abstract val parallelable: Boolean

class FileTransferManager : FileTransfer

FileTransferManager(aem: AemExtension)
val credentials: Pair<String, String>
fun credentials(user: String?, password: String?, domain: String? = null): Unit
val credentialsString: String
fun custom(name: String, definition: CustomFileTransfer.() -> Unit): Unit
fun deleteFrom(dirUrl: String, fileName: String): Unit
var domain: String?
fun download(fileUrl: String): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun downloadUsing(transfer: FileTransfer, fileUrl: String, target: File): Unit
fun downloadUsing(transfer: FileTransfer, dirUrl: String, fileName: String, target: File): Unit
val factory: FileTransferFactory
fun handles(fileUrl: String): Boolean
fun handling(fileUrl: String): FileTransferHandler
val http: HttpFileTransfer
fun http(options: HttpFileTransfer.() -> Unit): Unit
fun list(dirUrl: String): List<FileEntry>
const val NAME: String
fun named(name: String): FileTransfer
var password: String?
val path: PathFileTransfer
fun path(options: PathFileTransfer.() -> Unit): Unit
val resolve: ResolveFileTransfer
fun resolve(options: ResolveFileTransfer.() -> Unit): Unit
val sftp: SftpFileTransfer
fun sftp(options: SftpFileTransfer.() -> Unit): Unit
val smb: SmbFileTransfer
fun smb(options: SmbFileTransfer.() -> Unit): Unit
fun stat(dirUrl: String, fileName: String): FileEntry?
const val TMP_SUFFIX: String
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
fun uploadUsing(transfer: FileTransfer, fileUrl: String, source: File): Unit
fun uploadUsing(transfer: FileTransfer, dirUrl: String, fileName: String, source: File): Unit
val url: UrlFileTransfer
fun url(options: UrlFileTransfer.() -> Unit): Unit
var user: String?

class FileUploader

FileUploader(aem: AemExtension)
const val KILOBYTE: Int
fun ProgressLogger.logProgress(operation: String, readLength: Long, fullLength: Long, file: File): Unit
const val TRANSFER_CHUNK_100_KB: Int
fun upload(file: File, output: OutputStream, cleanup: (File) -> Unit = {}): Unit

abstract class ProtocolFileTransfer : AbstractFileTransfer

ProtocolFileTransfer(aem: AemExtension)
open fun handles(fileUrl: String): Boolean
abstract val protocols: List<String>

package com.cognifide.gradle.aem.common.file.transfer.generic

class CustomFileTransfer : ProtocolFileTransfer

CustomFileTransfer(aem: AemExtension)
fun delete(callback: (dirUrl: String, fileName: String) -> Unit): Unit
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun download(callback: (dirUrl: String, fileName: String, target: File) -> Unit): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun exists(callback: (dirUrl: String, fileName: String) -> Boolean): Unit
fun exists(dirUrl: String, fileName: String): Boolean
fun list(callback: (dirUrl: String) -> List<FileEntry>): Unit
fun list(dirUrl: String): List<FileEntry>
lateinit var name: String
var parallelable: Boolean
lateinit var protocols: List<String>
fun truncate(callback: (dirUrl: String) -> Unit): Unit
fun truncate(dirUrl: String): Unit
fun upload(callback: (dirUrl: String, fileName: String, target: File) -> Unit): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit

class PathFileTransfer : AbstractFileTransfer

PathFileTransfer(aem: AemExtension)
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun handles(fileUrl: String): Boolean
fun list(dirUrl: String): List<FileEntry>
val name: String
const val NAME: String
fun stat(dirUrl: String, fileName: String): FileEntry?
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit

class UrlFileTransfer : ProtocolFileTransfer

UrlFileTransfer(aem: AemExtension)
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
val name: String
const val NAME: String
const val PROTOCOL: String
val protocols: List<String>

package com.cognifide.gradle.aem.common.file.transfer.http

class HttpFileException : FileException

HttpFileException(message: String, cause: Throwable)
HttpFileException(message: String)

class HttpFileTransfer : ProtocolFileTransfer

HttpFileTransfer(aem: AemExtension, client: HttpClient = client(aem))
fun client(configurer: HttpClient.() -> Unit): Unit
var client: HttpClient
fun client(aem: AemExtension): HttpClient
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
val name: String
const val NAME: String
val protocols: List<String>

package com.cognifide.gradle.aem.common.file.transfer.resolve

class ResolveFileException : FileException

ResolveFileException(message: String, cause: Throwable)
ResolveFileException(message: String)

class ResolveFileTransfer : ProtocolFileTransfer

ResolveFileTransfer(aem: AemExtension)
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun handles(fileUrl: String): Boolean
val name: String
const val NAME: String
val parallelable: Boolean
val protocols: List<String>
fun resolve(value: Any): File

package com.cognifide.gradle.aem.common.file.transfer.sftp

class SftpFileException : FileException

SftpFileException(message: String, cause: Throwable)
SftpFileException(message: String)

class SftpFileTransfer : ProtocolFileTransfer

SftpFileTransfer(aem: AemExtension)
fun client(options: SshClient.() -> Unit): Unit
var clientOptions: SshClient.() -> Unit
fun <T> connect(url: String, callback: SftpClient.(String) -> T): T
fun <T> connectDir(dirUrl: String, callback: SftpClient.(String) -> T): T
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun list(dirUrl: String): List<FileEntry>
val name: String
const val NAME: String
var password: String?
const val PORT_DEFAULT: Int
val protocols: List<String>
fun session(options: ClientSession.() -> Unit): Unit
var sessionOptions: ClientSession.() -> Unit
fun stat(dirUrl: String, fileName: String): FileEntry?
val STATUS_NOT_EXISTS: Array<Int>
var timeout: Long
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
var user: String?

package com.cognifide.gradle.aem.common.file.transfer.smb

class SmbFileException : FileException

SmbFileException(message: String, cause: Throwable)
SmbFileException(message: String)

class SmbFileTransfer : ProtocolFileTransfer

SmbFileTransfer(aem: AemExtension)
fun deleteFrom(dirUrl: String, fileName: String): Unit
fun dir(dirUrl: String): SmbFile
var domain: String?
fun downloadFrom(dirUrl: String, fileName: String, target: File): Unit
fun file(dirUrl: String, fileName: String): SmbFile
fun list(dirUrl: String): List<FileEntry>
val name: String
const val NAME: String
var password: String?
val protocols: List<String>
fun stat(dirUrl: String, fileName: String): FileEntry?
fun truncate(dirUrl: String): Unit
fun uploadTo(dirUrl: String, fileName: String, source: File): Unit
var user: String?

package com.cognifide.gradle.aem.common.file.watcher

class DelegatingFileAlterationListener : FileAlterationListener

DelegatingFileAlterationListener(notify: (Event) -> Unit)
fun onDirectoryChange(directory: File?): Unit
fun onDirectoryCreate(directory: File): Unit
fun onDirectoryDelete(directory: File): Unit
fun onFileChange(file: File): Unit
fun onFileCreate(file: File): Unit
fun onFileDelete(file: File): Unit
fun onStart(observer: FileAlterationObserver?): Unit
fun onStop(observer: FileAlterationObserver?): Unit

class Event

Event(file: File, type: EventType)
val file: File
fun toString(): String
val type: EventType

enum class EventType

DIR_CREATED
DIR_DELETED
FILE_CHANGED
FILE_CREATED
FILE_DELETED

package com.cognifide.gradle.aem.common.http

open class HttpClient : Serializable

HttpClient(aem: AemExtension)
fun asJson(response: HttpResponse): DocumentContext
fun asJson(jsonString: String): DocumentContext
fun <reified T : Any> asObjectFromJson(response: HttpResponse): T
fun <T> asObjectFromJson(response: HttpResponse, clazz: Class<T>): T
fun asStream(response: HttpResponse): InputStream
fun asString(response: HttpResponse): String
var authorizationPreemptive: Boolean
var baseUrl: String
open fun baseUrl(uri: String): String
var basicCredentials: Pair<String?, String?>
var basicPassword: String?
var basicUser: String?
fun checkHtml(response: HttpResponse, validator: Document.() -> Boolean): Unit
fun checkStatus(response: HttpResponse, statusCodes: IntRange = STATUS_CODE_VALID): Unit
fun checkStatus(response: HttpResponse, statusCode: Int): Unit
fun checkStatus(response: HttpResponse, statusCodes: List<Int>): Unit
fun checkText(response: HttpResponse, containedText: String, ignoreCase: Boolean = true): Unit
val client: CloseableHttpClient!
var clientBuilder: HttpClientBuilder.() -> Unit
var connectionIgnoreSsl: Boolean
var connectionRetries: Boolean
var connectionTimeout: Int
open fun createEntityMultipart(params: Map<String, Any?>): HttpEntity
open fun createEntityUrlencoded(params: Map<String, Any?>): HttpEntity
fun delete(uri: String): Unit
fun <T> delete(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> delete(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpDelete.() -> Unit): T
open fun <T> execute(method: HttpRequestBase, handler: HttpClient.(HttpResponse) -> T): T
fun execute(method: HttpRequestBase): Unit
fun <T> fileTransfer(operation: HttpFileTransfer.() -> T): T
fun get(uri: String): Unit
fun <T> get(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> get(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpGet.() -> Unit): T
fun head(uri: String): Unit
fun <T> head(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> head(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpHead.() -> Unit): T
fun patch(path: String): Unit
fun <T> patch(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> patch(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpPatch.() -> Unit): T
fun post(url: String, params: Map<String, Any?> = mapOf()): Unit
fun <T> post(uri: String, params: Map<String, Any?> = mapOf(), handler: HttpClient.(HttpResponse) -> T): T
fun <T> post(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> post(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpPost.() -> Unit): T
fun postMultipart(uri: String, params: Map<String, Any?> = mapOf()): Unit
fun <T> postMultipart(uri: String, params: Map<String, Any?> = mapOf(), handler: HttpClient.(HttpResponse) -> T): T
fun postUrlencoded(uri: String, params: Map<String, Any?> = mapOf()): Unit
fun <T> postUrlencoded(uri: String, params: Map<String, Any?> = mapOf(), handler: HttpClient.(HttpResponse) -> T): T
var proxyHost: String?
var proxyPort: Int?
var proxyScheme: String?
fun put(uri: String): Unit
fun <T> put(uri: String, handler: HttpClient.(HttpResponse) -> T): T
fun <T> put(uri: String, handler: HttpClient.(HttpResponse) -> T, options: HttpPut.() -> Unit): T
fun <T> request(method: String, uri: String, handler: HttpClient.(HttpResponse) -> T): T
var requestConfigurer: HttpRequestBase.() -> Unit
var responseChecker: (HttpResponse) -> Unit
var responseChecks: Boolean
var responseHandler: (HttpResponse) -> Unit
val STATUS_CODE_VALID: IntRange
open fun throwStatusException(response: HttpResponse): Unit

class PreemptiveAuthInterceptor : HttpRequestInterceptor

PreemptiveAuthInterceptor()
fun process(request: HttpRequest, context: HttpContext): Unit

class RequestException : AemException

RequestException(message: String, cause: Throwable)
RequestException(message: String)

class ResponseException : AemException

ResponseException(message: String, cause: Throwable)
ResponseException(message: String)

package com.cognifide.gradle.aem.common.instance

abstract class AbstractInstance : Instance

AbstractInstance(aem: AemExtension)
protected val aem: AemExtension
open val available: Boolean
fun awaitUp(options: AwaitUpAction.() -> Unit = {}): Unit
open lateinit var environment: String
open fun equals(other: Any?): Boolean
open fun hashCode(): Int
open lateinit var httpUrl: String
open lateinit var id: String
protected val logger: Logger!
open var name: String
open var properties: MutableMap<String, String?>
open fun property(key: String, value: String?): Unit
fun property(key: String): String?
fun reload(options: ReloadAction.() -> Unit = {}): Unit
fun reloadAndAwaitUp(): Unit
open val sync: InstanceSync
open val systemProperties: Map<String, String>
open val version: String
open val zoneId: ZoneId

enum class IdType

AUTHOR
fun byId(id: String): IdType
fun byUrl(url: String): IdType
PUBLISH
val type: String

interface Instance : Serializable

open val author: Boolean
abstract val available: Boolean
open val cmd: Boolean
open val credentials: Pair<String, String>
open val credentialsString: String
fun defaults(aem: AemExtension, configurer: RemoteInstance.() -> Unit = {}): List<RemoteInstance>
abstract val environment: String
const val ENVIRONMENT_CMD: String
const val FILTER_ANY: String
open val hiddenPassword: String
open val httpBasicAuthUrl: String
open val httpPort: Int
abstract val httpUrl: String
abstract val id: String
open val json: String
val LOCAL_PROPS: List<String>
abstract val name: String
fun parse(aem: AemExtension, str: String, configurer: RemoteInstance.() -> Unit = {}): List<RemoteInstance>
abstract val password: String
const val PASSWORD_DEFAULT: String
abstract val properties: Map<String, String?>
fun properties(aem: AemExtension): List<Instance>
abstract fun property(key: String, value: String?): Unit
abstract fun property(key: String): String?
open val publish: Boolean
val REMOTE_PROPS: List<String>
abstract val sync: InstanceSync
open fun <T> sync(action: InstanceSync.() -> T): T
abstract val systemProperties: Map<String, String>
open val type: IdType
const val URL_AUTHOR_DEFAULT: String
const val URL_PUBLISH_DEFAULT: String
abstract val user: String
const val USER_DEFAULT: String
open fun validate(): Unit
abstract val version: String
abstract val zoneId: ZoneId

interface InstanceAction : Serializable

abstract fun perform(): Unit

class InstanceActionPerformer

InstanceActionPerformer(aem: AemExtension)
fun awaitDown(options: AwaitDownAction.() -> Unit = {}): Unit
fun awaitUp(options: AwaitUpAction.() -> Unit = {}): Unit
fun check(options: CheckAction.() -> Unit): Unit
fun reload(options: ReloadAction.() -> Unit = {}): Unit
fun reloadAndAwaitUp(): Unit

open class InstanceException : AemException

InstanceException(message: String, cause: Throwable)
InstanceException(message: String)

open class InstanceHttpClient : HttpClient

InstanceHttpClient(aem: AemExtension, instance: Instance)
val instance: Instance
open fun throwStatusException(response: HttpResponse): Unit

open class InstanceOptions : Serializable

InstanceOptions(aem: AemExtension)
val defined: MutableMap<String, Instance>
fun local(httpUrl: String): Unit
fun local(httpUrl: String, name: String): Unit
fun local(httpUrl: String, options: LocalInstance.() -> Unit): Unit
fun parse(urlOrName: String): Instance
fun remote(httpUrl: String): Unit
fun remote(httpUrl: String, name: String): Unit
fun remote(httpUrl: String, options: RemoteInstance.() -> Unit): Unit
fun sync(options: InstanceSync.() -> Unit): Unit

open class InstanceService

InstanceService(sync: InstanceSync)
val aem: AemExtension
val instance: Instance
val logger: Logger!
val project: Project
val sync: InstanceSync

class InstanceSync

InstanceSync(aem: AemExtension, instance: Instance)
val aem: AemExtension
val crx: Crx
fun <T> crx(callback: Crx.() -> T): T
val groovyConsole: GroovyConsole
fun <T> groovyConsole(callback: GroovyConsole.() -> T): T
val http: InstanceHttpClient
fun <T> http(callback: InstanceHttpClient.() -> T): T
val instance: Instance
val osgiFramework: OsgiFramework
fun <T> osgiFramework(callback: OsgiFramework.() -> T): T
val packageManager: PackageManager
fun <T> packageManager(callback: PackageManager.() -> T): T
val repository: Repository
fun <T> repository(callback: Repository.() -> T): T
val status: Status
fun <T> status(callback: Status.() -> T): T
var workflowManager: WorkflowManager
fun <T> workflowManager(callback: WorkflowManager.() -> T): T

class InstanceUrl

InstanceUrl(raw: String)
val basicAuth: String
fun basicAuth(user: String, password: String): String
val config: URL
val debugPort: Int
fun decode(text: String): String
fun encode(text: String): String
const val HTTP_DEBUG_PORT: Int
const val HTTP_PORT: Int
val httpPort: Int
const val HTTPS_DEBUG_PORT: Int
const val HTTPS_PORT: Int
val httpUrl: String
val id: String
fun parse(raw: String): InstanceUrl
val password: String
val type: IdType
val user: String

kotlin.collections.Collection

fun Collection<Instance>.checkAvailable(): Unit
val Collection<Instance>.names: String

class LocalInstance : AbstractInstance, Serializable

fun checkStatus(): Status
fun create(): Unit
fun create(aem: AemExtension, httpUrl: String, configurer: LocalInstance.() -> Unit): LocalInstance
fun create(aem: AemExtension, httpUrl: String): LocalInstance
val created: Boolean
fun customize(): Unit
var debugPort: Int
fun destroy(): Unit
val dir: File
fun down(): Unit
const val ENVIRONMENT: String
const val FILES_PATH: String
fun init(): Unit
val initialized: Boolean
val installDir: File
val jar: File
var jvmOpts: List<String>
val jvmOptsDefaults: List<String>
val jvmOptsString: String
val license: File
fun lock(name: String): Unit
const val LOCK_CREATE: String
const val LOCK_INIT: String
fun locked(name: String): Boolean
val manager: LocalInstanceManager
val overridesDirs: List<File>
lateinit var password: String
val quickstartDir: File
var runModes: List<String>
val runModesDefault: List<String>
val runModesString: String
val running: Boolean
fun saveVersion(): Unit
var startOpts: List<String>
val startOptsString: String
val startScript: Script
val status: Status
val statusScript: Script
val stopScript: Script
fun toString(): String
fun up(): Unit
val user: String
const val USER: String
val version: String
val versionFile: File
val windowTitle: String

class LocalInstanceManager : Serializable

LocalInstanceManager(aem: AemExtension)
val backup: BackupResolver
fun backup(options: BackupResolver.() -> Unit): Unit
val backupZip: File?
fun create(instances: List<LocalInstance>): Unit
fun createFromBackup(instances: List<LocalInstance>, backupZip: File): Unit
fun createFromScratch(instances: List<LocalInstance>): Unit
var expandFiles: List<String>
var expandProperties: Map<String, Any>
fun init(options: LocalInstance.() -> Unit): Unit
val install: InstallResolver
fun install(options: InstallResolver.() -> Unit): Unit
var overridesDir: File
val quickstart: QuickstartResolver
fun quickstart(options: QuickstartResolver.() -> Unit): Unit
fun resolveSourceFiles(): Unit
var rootDir: File
var scriptTimeout: Long
var source: Source
fun source(name: String): Unit
val sourceFiles: List<File>

enum class PhysicalType

LOCAL
fun of(type: String?): PhysicalType?
REMOTE

class RemoteInstance : AbstractInstance, Serializable

fun create(aem: AemExtension, httpUrl: String, configurer: RemoteInstance.() -> Unit = {}): RemoteInstance
lateinit var password: String
fun toString(): String
lateinit var user: String

package com.cognifide.gradle.aem.common.instance.action

abstract class AbstractAction : InstanceAction

AbstractAction(aem: AemExtension)
protected val aem: AemExtension
var enabled: Boolean
var notify: Boolean
fun notify(title: String, text: String, enabled: Boolean = this.notify): Unit

abstract class AnyInstanceAction : AbstractAction

AnyInstanceAction(aem: AemExtension)
var instances: List<Instance>

class AwaitDownAction : LocalInstanceAction

AwaitDownAction(aem: AemExtension)
fun perform(): Unit
fun timeout(options: TimeoutCheck.() -> Unit): Unit
fun unavailable(options: UnavailableCheck.() -> Unit): Unit
fun unchanged(options: UnchangedCheck.() -> Unit): Unit

class AwaitUpAction : AnyInstanceAction

AwaitUpAction(aem: AemExtension)
fun bundles(options: BundlesCheck.() -> Unit): Unit
fun components(options: ComponentsCheck.() -> Unit): Unit
fun events(options: EventsCheck.() -> Unit): Unit
fun perform(): Unit
fun timeout(options: TimeoutCheck.() -> Unit): Unit
fun unchanged(options: UnchangedCheck.() -> Unit): Unit

class CheckAction : AnyInstanceAction

CheckAction(aem: AemExtension)
fun perform(): Unit
val runner: CheckRunner
fun runner(options: CheckRunner.() -> Unit): Unit

abstract class LocalInstanceAction : AbstractAction

LocalInstanceAction(aem: AemExtension)
var instances: List<LocalInstance>

class ReloadAction : AnyInstanceAction

ReloadAction(aem: AemExtension)
fun perform(): Unit

package com.cognifide.gradle.aem.common.instance.check

class BundlesCheck : DefaultCheck

BundlesCheck(group: CheckGroup)
fun check(): Unit
var symbolicNamesIgnored: List<String>

interface Check

abstract fun check(): Unit
open val failure: Boolean
abstract val status: String
abstract val success: Boolean

class CheckFactory

CheckFactory(group: CheckGroup)
fun bundles(options: BundlesCheck.() -> Unit): BundlesCheck
fun components(options: ComponentsCheck.() -> Unit): ComponentsCheck
fun custom(callback: CustomCheck.() -> Unit): CustomCheck
fun events(options: EventsCheck.() -> Unit): EventsCheck
val group: CheckGroup
fun timeout(options: TimeoutCheck.() -> Unit): TimeoutCheck
fun unavailable(options: UnavailableCheck.() -> Unit): UnavailableCheck
fun unchanged(options: UnchangedCheck.() -> Unit): UnchangedCheck

class CheckGroup

CheckGroup(runner: CheckRunner, instance: Instance, checkFactory: CheckFactory.() -> List<Check>)
fun check(): Unit
var checks: List<Check>
val done: Boolean
val instance: Instance
fun log(): Unit
val runner: CheckRunner
fun state(value: Any): Unit
val state: Int
val stateBuilder: HashCodeBuilder
val statusLogger: CollectingLogger
val summary: String

class CheckProgress

CheckProgress(instance: Instance)
var currentCheck: CheckGroup?
var previousCheck: CheckGroup?
val stateChanged: Boolean
var stateChanges: Int
val stateTime: Long
val summary: String

class CheckRunner

CheckRunner(aem: AemExtension)
var abortCause: Exception?
val aborted: Boolean
fun check(instances: Collection<Instance>): Unit
fun checks(definitions: CheckFactory.() -> List<Check>): Unit
var delay: Long
var logInstantly: Boolean
fun progress(instance: Instance): CheckProgress
val runningTime: Long
var verbose: Boolean

class ComponentsCheck : DefaultCheck

ComponentsCheck(group: CheckGroup)
fun check(): Unit
var platformComponents: List<String>
var specificComponents: List<String>

class CustomCheck : DefaultCheck

CustomCheck(group: CheckGroup, callback: CustomCheck.() -> Unit)
fun check(): Unit

abstract class DefaultCheck : Check

DefaultCheck(group: CheckGroup)
protected val aem: AemExtension
protected val group: CheckGroup
val instance: Instance
const val LOG_VALUES_COUNT: Int
fun logValues(values: Collection<Any>): String
val progress: CheckProgress
val runner: CheckRunner
fun <T : Any> state(value: T): T
open val status: String
val statusLogger: CollectingLogger
open val success: Boolean
var sync: InstanceSync

class EventsCheck : DefaultCheck

EventsCheck(group: CheckGroup)
fun check(): Unit
const val EVENT_DETAILS_LENGTH: Int
var unstableAgeMillis: Long
var unstableTopics: List<String>

class TimeoutCheck : DefaultCheck

TimeoutCheck(group: CheckGroup)
fun check(): Unit
var constantTime: Long
var stateTime: Long

class UnavailableCheck : DefaultCheck

UnavailableCheck(group: CheckGroup)
fun check(): Unit
val STATUS_EXPECTED: List<Status>
var utilisationTime: Long

class UnchangedCheck : DefaultCheck

UnchangedCheck(group: CheckGroup)
var awaitTime: Long
fun check(): Unit

package com.cognifide.gradle.aem.common.instance.local

class BackupResolver

BackupResolver(aem: AemExtension)
val any: File?
var downloadUrl: String?
val local: File?
var localDir: File
var namer: () -> String
val remote: File?
var remoteDir: File
var selector: Collection<BackupSource>.() -> BackupSource?
var suffix: String
var uploadUrl: String?

class BackupSource

BackupSource(type: BackupType, fileEntry: FileEntry, fileResolver: () -> File)
val file: File
val fileEntry: FileEntry
val fileResolver: () -> File
val type: BackupType

enum class BackupType

LOCAL
REMOTE

class InstallResolver

InstallResolver(aem: AemExtension)
var downloadDir: File
fun files(configurer: FileResolver.() -> Unit): Unit
val files: List<File>

class QuickstartResolver

QuickstartResolver(aem: AemExtension)
var downloadDir: File
val files: List<File>
val jar: File?
var jarUrl: String?
val license: File?
var licenseUrl: String?
const val TEMPORARY_DIR: String

class Script

Script(instance: LocalInstance, shellCommand: List<String>, wrapper: File, bin: File)
val args: List<String>
val bin: File
val command: String
val commandLine: List<String>
fun executeAsync(): Unit
fun executeSync(options: ProcBuilder.() -> Unit = {}): ProcResult
val instance: LocalInstance
val shellCommand: List<String>
fun toString(): String
val wrapper: File

enum class Source

AUTO
BACKUP_ANY
BACKUP_LOCAL
BACKUP_REMOTE
fun of(name: String): Source
SCRATCH

enum class Status

fun byExitCode(exitStatus: Int): Status
DEAD
val exitStatus: Int
NOT_RUNNING
fun of(name: String): Status
RUNNING
UNKNOWN

package com.cognifide.gradle.aem.common.instance.service.crx

class Crx : InstanceService

Crx(sync: InstanceSync)
const val EXPORT_NODE_TYPE_PATH: String
const val NODE_TYPES_UNKNOWN: String
val nodeTypes: String
fun readNodeTypes(): String

class CrxException : InstanceException

CrxException(message: String, cause: Throwable)
CrxException(message: String)

package com.cognifide.gradle.aem.common.instance.service.groovy

class GroovyConsole : InstanceService

GroovyConsole(sync: InstanceSync)
const val EVAL_PATH: String
fun evalCode(code: String, data: Map<String, Any> = mapOf()): GroovyConsoleResult
fun evalScript(file: File, data: Map<String, Any> = mapOf()): GroovyConsoleResult
fun evalScript(fileName: String, data: Map<String, Any> = mapOf()): GroovyConsoleResult
fun evalScripts(fileNamePattern: String = "**/*.groovy", data: Map<String, Any> = mapOf()): Sequence<GroovyConsoleResult>
fun evalScripts(scripts: Iterable<File>, data: Map<String, Any> = mapOf()): Sequence<GroovyConsoleResult>
var scriptRootDir: File
var verbose: Boolean

class GroovyConsoleResult

GroovyConsoleResult()
lateinit var data: String
lateinit var exceptionStackTrace: String
lateinit var output: String
var result: String?
lateinit var runningTime: String
lateinit var script: String
fun toString(): String

package com.cognifide.gradle.aem.common.instance.service.osgi

class Bundle

Bundle()
const val ATTRIBUTE_ACTIVATOR: String
const val ATTRIBUTE_CATEGORY: String
const val ATTRIBUTE_CONTRIBUTORS: String
const val ATTRIBUTE_COPYRIGHT: String
const val ATTRIBUTE_DESCRIPTION: String
const val ATTRIBUTE_DEVELOPERS: String
const val ATTRIBUTE_DOC_URL: String
const val ATTRIBUTE_EXPORT_PACKAGE: String
const val ATTRIBUTE_FRAGMENT_HOST: String
const val ATTRIBUTE_IMPORT_PACKAGE: String
const val ATTRIBUTE_LICENSE: String
const val ATTRIBUTE_NAME: String
const val ATTRIBUTE_PRIVATE_PACKAGE: String
const val ATTRIBUTE_SLING_MODEL_PACKAGES: String
const val ATTRIBUTE_SYMBOLIC_NAME: String
const val ATTRIBUTE_VENDOR: String
const val ATTRIBUTE_VERSION: String
fun equals(other: Any?): Boolean
var fragment: Boolean
fun hashCode(): Int
lateinit var id: String
lateinit var name: String
val stable: Boolean
val state: String
var stateRaw: Int
lateinit var symbolicName: String
fun toString(): String
lateinit var version: String

class BundleState

val activeBundles: Int
val activeFragments: Int
lateinit var bundles: List<Bundle>
fun bundlesExcept(symbolicNames: Iterable<String>): List<Bundle>
fun equals(other: Any?): Boolean
fun hashCode(): Int
val installedBundles: Int
val resolvedBundles: Int
val stable: Boolean
fun stable(symbolicNames: Iterable<String>): Boolean
fun stable(symbolicName: String): Boolean
fun stableExcept(symbolicNames: Iterable<String>): Boolean
fun stableExcept(symbolicName: String): Boolean
val stablePercent: String
lateinit var stats: List<Int>
val statsWithLabels: String
lateinit var status: String
fun toString(): String
val total: Int
val unknown: Boolean
fun unknown(e: Exception): BundleState

class Component

Component()
val active: Boolean
var bundleId: Int?
val disabled: Boolean
fun equals(other: Any?): Boolean
val failedActivation: Boolean
fun hashCode(): Int
lateinit var id: String
lateinit var name: String
val noConfig: Boolean
val notUnsatisfied: Boolean
var pid: String?
val satisfied: Boolean
lateinit var state: String
val STATE_ACTIVE: String
val STATE_DISABLED: String
val STATE_NO_CONFIG: String
val STATE_RAW_ACTIVE: Int
val STATE_RAW_DISABLED_OR_NO_CONFIG: Int
val STATE_RAW_FAILED_ACTIVATION: Int
val STATE_RAW_SATISTIED: Int
val STATE_RAW_UNSATISFIED: Int
val STATE_SATISFIED: String
var stateRaw: Int
fun toString(): String
val uid: String
val unsatisfied: Boolean

class ComponentState

fun check(pids: Collection<String>, predicate: (Component) -> Boolean): Boolean
fun check(pids: Collection<String>, ignoredPids: Collection<String>, predicate: (Component) -> Boolean): Boolean
lateinit var components: List<Component>
fun equals(other: Any?): Boolean
fun find(pids: Collection<String>): List<Component>
fun find(pids: Collection<String>, ignoredPids: Collection<String>): List<Component>
fun hashCode(): Int
fun toString(): String
var total: Int
val unknown: Boolean
fun unknown(): ComponentState

class Configuration

Configuration()
var bundleLocation: String?
class ConfigurationProperty

ConfigurationProperty()
val value: Any?

const val DESCRIPTION_METATYPE_ABSENCE: String
fun equals(other: Any?): Boolean
fun hashCode(): Int
val metatypeAbsence: Boolean
lateinit var pid: String
val properties: Map<String, Any?>
var serviceLocation: String?
fun toString(): String

class ConfigurationState

ConfigurationState()
class Pid

Pid()
var fpid: String?
var hasConfig: Boolean
lateinit var id: String
lateinit var name: String
var nameHint: String?

lateinit var pids: List<Pid>
fun toString(): String
val unknown: Boolean
fun unknown(): ConfigurationState

class Event

Event()
var category: String?
val details: String
fun equals(other: Any?): Boolean
fun hashCode(): Int
lateinit var id: String
var info: String?
lateinit var received: String
val service: String?
lateinit var topic: String
fun toString(): String

class EventState

fun equals(other: Any?): Boolean
lateinit var events: List<Event>
fun hashCode(): Int
fun matching(topics: Iterable<String>, ageMillis: Long, ageZoneId: ZoneId): List<Event>
lateinit var status: String
fun toString(): String
val unknown: Boolean
fun unknown(): EventState

class OsgiFramework : InstanceService

OsgiFramework(sync: InstanceSync)
val bundles: List<Bundle>
const val BUNDLES_LIST_JSON: String
const val BUNDLES_PATH: String
val components: List<Component>
const val COMPONENTS_LIST_JSON: String
const val COMPONENTS_PATH: String
const val CONFIGURATION_PATH: String
val configurations: Sequence<Configuration>
val CONFIGURATIONS_REGEX: Regex
fun configure(pid: String, properties: Map<String, Any?>): Unit
fun deleteConfiguration(pid: String): Unit
fun deleteConfiguration(pid: String, service: String): Unit
fun determineBundleState(): BundleState
fun determineComponentState(): ComponentState
fun determineConfigurationState(): ConfigurationState
fun determineEventState(): EventState
fun disableComponent(pid: String): Unit
fun enableComponent(pid: String): Unit
val events: List<Event>
const val EVENTS_LIST_JSON: String
fun findBundle(symbolicName: String): Bundle?
fun findComponent(pid: String): Component?
fun findConfiguration(pid: String, metatypeChecking: Boolean = true): Configuration?
fun getBundle(symbolicName: String): Bundle
fun getComponent(pid: String): Component
fun getConfiguration(pid: String): Configuration
fun getConfigurations(fpid: String): Sequence<Configuration>
fun installBundle(bundle: File, start: Boolean = true, startLevel: Int = 20, refreshPackages: Boolean = true, retry: Retry = aem.retry()): Unit
fun refreshBundle(symbolicName: String): Unit
fun restart(): Unit
fun restartBundle(symbolicName: String): Unit
fun restartComponent(pid: String): Unit
fun saveConfiguration(pid: String, properties: Map<String, Any?>): Unit
fun saveConfiguration(pid: String, service: String, properties: Map<String, Any>): Unit
fun startBundle(symbolicName: String): Unit
fun stop(): Unit
fun stopBundle(symbolicName: String): Unit
fun uninstallBundle(bundle: File): Unit
fun uninstallBundle(symbolicName: String): Unit
fun updateBundle(symbolicName: String): Unit
fun updateConfiguration(pid: String, properties: Map<String, Any?>): Unit
fun updateConfiguration(pid: String, service: String, properties: Map<String, Any>): Unit
const val VMSTAT_PATH: String

package com.cognifide.gradle.aem.common.instance.service.pkg

class BuildResponse

var isSuccess: Boolean
lateinit var msg: String
lateinit var path: String

class DeleteResponse : HtmlResponse

fun from(input: InputStream, bufferSize: Int): DeleteResponse
protected fun getErrorPatterns(): List<ErrorPattern>
val status: Status

data class ErrorPattern

ErrorPattern(pattern: Pattern, printStackTrace: Boolean, message: String = "")
val message: String
val pattern: Pattern
val printStackTrace: Boolean

abstract class HtmlResponse

HtmlResponse(rawHtml: String)
val errors: List<String>
fun filter(input: InputStream, errorPatterns: List<ErrorPattern>, statusTags: List<String>, bufferSize: Int): String
protected abstract fun getErrorPatterns(): List<ErrorPattern>
enum class Status

FAIL
SUCCESS
SUCCESS_WITH_ERRORS

abstract val status: Status
val success: Boolean

class InstallResponse : HtmlResponse

fun from(input: InputStream, bufferSize: Int): InstallResponse
protected fun getErrorPatterns(): List<ErrorPattern>
fun hasPackageErrors(patterns: Collection<String>): Boolean
val status: Status

class ListResponse

fun resolvePackage(expected: Package): Package?
lateinit var results: List<Package>

class Package

Package(compose: PackageCompose)
Package(group: String, name: String, version: String)
fun bundlePath(path: String, runMode: String?): String
var conventionPaths: List<String>
val coordinates: String
fun coordinates(group: String, name: String, version: String): String
lateinit var downloadName: String
lateinit var group: String
val installed: Boolean
const val JCR_ROOT: String
var lastUnpacked: Long?
const val META_PATH: String
const val META_RESOURCES_PATH: String
lateinit var name: String
const val NODE_TYPES_SYNC_PATH: String
const val OAKPAL_OPEAR_PATH: String
const val OAKPAL_OPEAR_RESOURCES_PATH: String
lateinit var path: String
lateinit var version: String
const val VLT_DIR: String
const val VLT_HOOKS_PATH: String
const val VLT_NODETYPES_FILE: String
const val VLT_PATH: String
const val VLT_PROPERTIES: String

class PackageManager : InstanceService

PackageManager(sync: InstanceSync)
fun activate(remotePath: String): UploadResponse
fun build(remotePath: String): BuildResponse
fun delete(remotePath: String): DeleteResponse
fun deploy(file: File, uploadForce: Boolean = true, uploadRetry: Retry = aem.retry(), installRecursive: Boolean = true, installRetry: Retry = aem.retry(), activate: Boolean = false): Unit
fun distribute(file: File, uploadForce: Boolean = true, uploadRetry: Retry = aem.retry(), installRecursive: Boolean = true, installRetry: Retry = aem.retry()): Unit
fun download(definition: PackageDefinition.() -> Unit, retry: Retry): File
fun download(definition: PackageDefinition.() -> Unit): File
fun download(remotePath: String, targetFile: File = aem.temporaryFile(FilenameUtils.getName(remotePath)), retry: Retry = aem.retry()): Unit
fun find(file: File, refresh: Boolean = true, retry: Retry = aem.retry()): Package?
fun find(group: String, name: String, version: String, refresh: Boolean = true, retry: Retry = aem.retry()): Package?
fun get(file: File, refresh: Boolean = true, retry: Retry = aem.retry()): Package
fun get(group: String, name: String, version: String, refresh: Boolean = true, retry: Retry = aem.retry()): Package
const val HTML_PATH: String
fun install(remotePath: String, recursive: Boolean = true, retry: Retry = aem.retry()): InstallResponse
fun isSnapshot(file: File): Boolean
const val JSON_PATH: String
fun list(retry: Retry = aem.retry()): ListResponse
const val LIST_JSON: String
const val PATH: String
fun uninstall(remotePath: String): UninstallResponse
fun upload(file: File, force: Boolean = true, retry: Retry = aem.retry()): UploadResponse

enum class PackageResolver

BY_CONVENTION_PATH

fun resolve(response: ListResponse, expected: Package): Package?

BY_COORDINATES

fun resolve(response: ListResponse, expected: Package): Package?

abstract fun resolve(response: ListResponse, expected: Package): Package?

class PackageState

PackageState(file: File, state: Package?)
val file: File
val installed: Boolean
val name: String
val state: Package?
val uploaded: Boolean

class UninstallResponse : HtmlResponse

fun from(input: InputStream, bufferSize: Int): UninstallResponse
protected fun getErrorPatterns(): List<ErrorPattern>
val status: Status

class UploadResponse

fun fromJson(json: InputStream): UploadResponse
var isSuccess: Boolean
lateinit var msg: String
lateinit var path: String

package com.cognifide.gradle.aem.common.instance.service.repository

class Node : Serializable

Node(repository: Repository, path: String)
val children: List<Node>
fun children(): Sequence<Node>
fun copy(targetPath: String): Unit
fun copyFrom(sourcePath: String): Unit
fun copyTo(targetDir: String): Unit
fun delete(): RepositoryResult
fun deleteProperties(vararg names: String): RepositoryResult
fun deleteProperties(names: Iterable<String>): RepositoryResult
fun deleteProperty(name: String): RepositoryResult
fun download(options: PackageDefinition.() -> Unit = {}): File
val exists: Boolean
fun exists(recheck: Boolean = false): Boolean
fun hasProperties(vararg names: String): Boolean
fun hasProperties(names: Iterable<String>): Boolean
fun hasProperty(name: String): Boolean
val json: String
val name: String
val parent: Node
val path: String
val properties: Properties
enum class Property

CHILDREN
NAME
val value: String

fun reload(): Unit
fun replace(properties: Map<String, Any?>): RepositoryResult
val repository: Repository
fun save(properties: Map<String, Any?>): RepositoryResult
fun saveProperty(name: String, value: Any?): RepositoryResult
fun toString(): String
fun traverse(self: Boolean = false): Sequence<Node>
val type: String
val TYPE_UNSTRUCTURED: Pair<String, String>

class Properties : LinkedHashMap<String, Any>

Properties(node: Node, props: Map<String, Any>)
fun boolean(name: String): Boolean?
fun booleans(name: String): List<Boolean>?
fun calendar(name: String): Calendar?
fun calendars(name: String): List<Calendar>?
fun date(name: String): Date?
fun dates(name: String): List<Date>?
fun double(name: String): Double?
fun doubles(name: String): List<Double>?
val json: String
fun long(name: String): Long?
fun longs(name: String): List<Long>?
val node: Node
fun string(name: String): String?
fun strings(name: String): List<String>?
fun toString(): String

class Repository : InstanceService

Repository(sync: InstanceSync)
fun node(path: String): Node
fun <T> node(path: String, options: Node.() -> T): T
fun node(path: String, properties: Map<String, Any?>): RepositoryResult
var responseChecks: Boolean
var typeHints: Boolean
var verboseLogging: Boolean

class RepositoryChange

RepositoryChange()
lateinit var argument: String
fun toString(): String
lateinit var type: String

class RepositoryError

RepositoryError()
lateinit var className: String
lateinit var message: String
fun toString(): String

class RepositoryException : InstanceException

RepositoryException(message: String, cause: Throwable)
RepositoryException(message: String)

class RepositoryHttpClient : InstanceHttpClient

RepositoryHttpClient(aem: AemExtension, instance: Instance)
fun throwStatusException(response: HttpResponse): Unit

class RepositoryResult

RepositoryResult()
lateinit var changes: List<RepositoryChange>
var error: RepositoryError?
val fail: Boolean
lateinit var location: String
lateinit var parentLocation: String
lateinit var path: String
lateinit var referer: String
var statusCode: Int
var statusMessage: String?
val success: Boolean
lateinit var title: String
fun toString(): String

object RepositoryType

fun dateFormat(): SimpleDateFormat
fun hint(value: Any?): String?
fun hintSimpleType(value: Any?): String?
fun normalize(value: Any?): Any?
fun normalizeSimpleType(value: Any?): Any?

package com.cognifide.gradle.aem.common.instance.service.status

class Status : InstanceService

Status(sync: InstanceSync)
const val PRODUCT_INFO_PATH: String
val PRODUCT_VERSION_REGEX: Regex
val PRODUCT_VERSION_UNKNOWN: String!
val productVersion: String
fun readProductVersion(): String
fun readSystemProperties(): Map<String, String>
const val SYSTEM_PROPERTIES_PATH: String
val systemProperties: Map<String, String>

class StatusException : InstanceException

StatusException(message: String, cause: Throwable)
StatusException(message: String)

package com.cognifide.gradle.aem.common.instance.service.workflow

class Workflow

Workflow(manager: WorkflowManager, id: String)
fun disable(): Unit
fun enable(): Unit
val enabled: Boolean
const val ENABLED_PROP: String
val exists: Boolean
val id: String
val launcher: Node
val launcherFrozen: Node
val manager: WorkflowManager
fun restore(): Unit
fun toggle(): Unit
fun toggle(flag: Boolean): Unit

class WorkflowManager : InstanceService

WorkflowManager(sync: InstanceSync)
val configFrozen: Boolean
val repository: Repository
var restoreIntended: Boolean
var restoreRetry: Retry
fun toggle(typeFlags: Map<String, Boolean>): Unit
fun toggle(type: String, flag: Boolean): Unit
fun toggle(types: Iterable<String>, flag: Boolean): Unit
fun toggle(vararg types: String, flag: Boolean): Unit
fun toggleTemporarily(type: String, flag: Boolean, action: () -> Unit): Unit
fun toggleTemporarily(typeFlags: Map<String, Boolean>, action: () -> Unit): Unit
fun workflow(id: String): Workflow
fun workflows(type: String): List<Workflow>
fun workflows(types: Iterable<String>): List<Workflow>
fun workflows(vararg types: String): List<Workflow>

enum class WorkflowType

DAM_ASSET
val ids: List<String>
fun ids(type: String): List<String>
fun ids(types: Iterable<String>): List<String>
fun of(type: String): WorkflowType?

package com.cognifide.gradle.aem.common.notifier

class DorkboxNotifier : Notifier

DorkboxNotifier(aem: AemExtension, configurer: Notify.() -> Unit)
val aem: AemExtension
val configurer: Notify.() -> Unit
fun notify(title: String, text: String, level: LogLevel, onClick: (Notify) -> Unit): Unit

interface Notifier

abstract fun notify(title: String, text: String, level: LogLevel, onClick: (Notify) -> Unit = {}): Unit

class NotifierFacade

var config: NotifierFacade.() -> Notifier
fun custom(notifier: (title: String, text: String, level: LogLevel, onClick: (Notify) -> Unit) -> Unit): Notifier
fun dorkbox(): Notifier
fun dorkbox(configurer: Notify.() -> Unit): Notifier
val DORKBOX_DARK_LIGHT_THEME: Theme
const val DORKBOX_HIDE_AFTER_SECONDS: Long
var enabled: Boolean
val image: URL
fun log(title: String): Unit
fun log(title: String, message: String): Unit
fun log(title: String, message: String, level: LogLevel): Unit
fun notify(title: String): Unit
fun notify(title: String, text: String): Unit
fun notify(title: String, text: String, level: LogLevel): Unit
fun notifyLogError(title: String, message: String, file: URI): Unit
fun of(aem: AemExtension): NotifierFacade

package com.cognifide.gradle.aem.common.pkg

class PackageDefinition : VltDefinition

PackageDefinition(aem: AemExtension)
var archiveAppendix: String?
var archiveBaseName: String
var archiveClassifier: String?
var archiveExtension: String
var archiveFileName: String
var archivePath: File
var archiveVersion: String
fun compose(definition: PackageDefinition.() -> Unit): File
fun content(options: PackageDefinition.() -> Unit): Unit
fun copyJcrFile(file: File, path: String): Unit
fun copyMetaFiles(skipExisting: Boolean = true): Unit
var destinationDirectory: File
fun expandFiles(dir: File, filePatterns: List<String> = PackageFileFilter.EXPAND_FILES_DEFAULT): Unit
fun expandMetaFiles(filePatterns: List<String> = PackageFileFilter.EXPAND_FILES_DEFAULT): Unit
val jcrDir: File
val metaDir: File
val pkgDir: File
fun process(options: PackageDefinition.() -> Unit): Unit

class PackageException : AemException

PackageException(message: String, cause: Throwable)
PackageException(message: String)

class PackageFile : Serializable

PackageFile(file: File)
val file: File
val group: String
val name: String
val properties: Document
fun property(name: String): String?
fun toString(): String
val version: String

class PackageFileFilter : Serializable

PackageFileFilter(aem: AemExtension)
var bundleChecking: Boolean
val EXCLUDE_FILES_DEFAULT: List<String>
var excludeFiles: List<String>
var excluding: Boolean
val EXPAND_FILES_DEFAULT: List<String>
var expandFiles: List<String>
var expanding: Boolean
var expandProperties: Map<String, Any>
fun expandProperty(name: String, value: String): Unit
fun filter(spec: CopySpec, expandProperties: Map<String, Any> = mapOf()): Unit

class PackageOptions : Serializable

PackageOptions(aem: AemExtension)
var contentDir: File
var errors: List<String>
var installPath: String
var installRepository: Boolean
val jcrRootDir: File
var metaCommonDir: File
var nodeTypesSync: NodeTypesSync
fun nodeTypesSync(name: String): Unit
var nodeTypesSyncFile: File
var responseBuffer: Int
var snapshots: List<String>
var storageDir: PackageFile.() -> String
var storagePath: String
fun validator(options: PackageValidator.() -> Unit): Unit
val vltDir: File

class PackageValidator

PackageValidator(aem: AemExtension)
val aem: AemExtension
fun base(value: Any): Unit
fun base(provider: () -> File?): Unit
val baseFile: File?
fun classLoader(provider: () -> ClassLoader): Unit
const val CONFIG_DIR_PATH: String
fun configDir(dir: File): Unit
val configDirs: List<File>
fun configDirs(dirs: Iterable<File>): Unit
fun configDirs(vararg dirs: File): Unit
var enabled: Boolean
fun perform(vararg packages: File): Unit
fun perform(packages: Iterable<File>): Unit
val planFile: File
var planName: String
val reportFile: File
var severity: Severity
fun severity(name: String): Unit
var verbose: Boolean
var workDir: File

package com.cognifide.gradle.aem.common.pkg.vlt

class FilterElement

FilterElement(root: String)
val element: Element
const val EXCLUDE_TAG: String
var excludes: Collection<String>
const val FILTER_TAG: String
const val INCLUDE_TAG: String
var includes: Collection<String>
var mode: String?
const val MODE_ATTR: String
fun of(root: String, definition: FilterElement.() -> Unit): FilterElement
fun parse(xml: String): List<FilterElement>
const val PATTERN_ATTR: String
val root: String
const val ROOT_ATTR: String
var type: FilterType

class FilterFile : Closeable

FilterFile(file: File, temporary: Boolean = false)
const val BUILD_NAME: String
fun close(): Unit
val elements: List<FilterElement>
val file: File
const val ORIGIN_NAME: String
fun rootDirs(contentDir: File): List<File>
val roots: Set<String>
const val SYNC_NAME: String
fun temporary(project: Project, paths: List<String>): FilterFile
const val TEMPORARY_NAME: String
fun toString(): String

enum class FilterType

DIR
FILE
UNKNOWN

enum class NodeTypesSync

ALWAYS
AUTO
FALLBACK
fun find(name: String): NodeTypesSync?
NEVER
fun of(name: String): NodeTypesSync
PRESERVE_AUTO
PRESERVE_FALLBACK

open class VltDefinition

VltDefinition(aem: AemExtension)
var createdBy: String?
var description: String?
fun ensureDefaults(): Unit
fun filter(root: String, definition: FilterElement.() -> Unit = {}): Unit
val filterEffectives: Collection<FilterElement>
var filterElements: MutableList<FilterElement>
fun filterElements(file: File): Unit
val filterRoots: Collection<String>
val filters: Collection<String>
fun filters(vararg roots: String): Unit
fun filters(roots: Iterable<String>): Unit
var group: String
var name: String
val NODE_TYPES_LIB: Pattern
var nodeTypeLibs: MutableList<String>
var nodeTypeLines: MutableList<String>
val nodeTypes: String
fun nodeTypes(file: File): Unit
fun nodeTypes(text: String): Unit
var properties: MutableMap<String, Any>
fun property(name: String, value: String): Unit
var version: String

package com.cognifide.gradle.aem.common.tasks

open class BundleTask : AemDefaultTask

BundleTask()
fun bundle(path: String): Unit
var bundles: List<File>
fun instance(urlOrName: String): Unit
var instances: List<Instance>
open fun projectsEvaluated(): Unit

open class Debug : AemDefaultTask

Debug()
val buildProperties: Map<String, Any>
fun debug(): Unit
val file: File
const val NAME: String
var packageDeployed: Boolean
val packageProperties: Map<String, Package?>
val projectProperties: Map<String, String>
val properties: Map<String, Any>

open class InstanceTask : AemDefaultTask

InstanceTask()
var instances: List<Instance>
open fun projectsEvaluated(): Unit

open class LocalInstanceTask : AemDefaultTask

LocalInstanceTask()
var instances: List<LocalInstance>
val manager: LocalInstanceManager
open fun projectsEvaluated(): Unit

open class PackageTask : AemDefaultTask

PackageTask()
fun instance(urlOrName: String): Unit
var instances: List<Instance>
fun package(path: String): Unit
var packages: List<File>
fun pkg(path: String): Unit
open fun projectsEvaluated(): Unit

class TaskSequence

TaskSequence()
var afterTasks: Collection<Any>
var dependentTasks: Collection<Any>
fun dependsOn(vararg tasks: Any): Unit
fun dependsOn(tasks: Collection<Any>): Unit
fun dependsOrdered(vararg tasks: Any): Unit
fun mustRunAfter(vararg tasks: Any): Unit
fun mustRunAfter(tasks: Collection<Any>): Unit

open class ZipTask : Zip, AemTask

ZipTask()
val aem: AemExtension
protected open fun copy(): Unit
var copyProgress: ProgressIndicator.() -> Unit

package com.cognifide.gradle.aem.common.tasks.lifecycle

open class Await : AemDefaultTask

Await()
const val NAME: String

open class Destroy : AemDefaultTask

Destroy()
const val NAME: String

open class Down : AemDefaultTask

Down()
const val NAME: String

open class Resetup : AemDefaultTask

Resetup()
const val NAME: String

open class Resolve : AemDefaultTask

Resolve()
const val NAME: String

open class Restart : AemDefaultTask

Restart()
const val NAME: String

open class Setup : AemDefaultTask

Setup()
const val NAME: String

open class Up : AemDefaultTask

Up()
const val NAME: String

package com.cognifide.gradle.aem.common.utils

object Formats

fun asJson(input: InputStream): DocumentContext!
fun asJson(value: String): DocumentContext!
fun asPassword(value: String): String
fun asVersion(value: String): GradleVersion
fun bytesToHuman(bytes: Long): String
fun calculateChecksum(text: String): String
fun commandToArgs(command: String): List<String>
fun date(date: Date = Date()): String
fun dateFileName(date: Date = Date()): String
fun dateTime(timestamp: Long, zoneId: ZoneId): LocalDateTime
fun dateToCalendar(date: Date): Calendar
fun duration(millis: Long): String
fun durationFit(thenMillis: Long, thenZoneId: ZoneId, durationMillis: Long): Boolean
fun durationSince(millis: Long): String
fun <reified T : Any> fromJson(json: String): T
fun <T> fromJson(json: String, clazz: Class<T>): T
fun fromJsonToMap(json: String): Map<String, Any?>
fun jsonMapper(pretty: Boolean): ObjectMapper
fun manglePath(path: String): String
fun noLineBreaks(text: String): String
fun normalizePath(path: String): String
fun normalizeSeparators(name: String, separator: String): String
fun percent(current: Int, total: Int): String
fun percent(current: Long, total: Long): String
fun percentExplained(current: Int, total: Int): String
fun percentExplained(current: Long, total: Long): String
fun projectPath(file: File, project: Project): String
fun projectPath(path: String, project: Project): String
fun relativePath(path: String, basePath: String): String
fun rootProjectPath(file: File, project: Project): String
fun rootProjectPath(path: String, project: Project): String
fun size(file: File): String
fun timestamp(): String
fun toBase64(value: String): String
fun toJson(value: Any, pretty: Boolean = true): String
fun toJson(value: Map<String, Any?>, pretty: Boolean = true): String
fun toList(value: String?, delimiter: String = ","): List<String>?
fun toMap(value: String?, valueDelimiter: String = ",", keyDelimiter: String = "="): Map<String, String>?
val URL_VALIDATOR: UrlValidator
val VERSION_UNKNOWN: GradleVersion!
fun versionAtLeast(actual: String, required: String): Boolean

kotlin.collections.Collection

val Collection<File>.fileNames: String

kotlin.collections.Iterable

fun <T> Iterable<T>.onEachApply(block: T.() -> Unit): Iterable<T>

enum class LineSeparator

CR
CRLF
LF
LFCR
fun string(name: String): String
SYSTEM
val value: String

object Patterns

const val WILDCARD: String
fun wildcard(file: File, matcher: String): Boolean
fun wildcard(file: File, matchers: Iterable<String>): Boolean
fun wildcard(path: String, matcher: String): Boolean
fun wildcard(path: String, matchers: Iterable<String>): Boolean
const val WILDCARD_NEGATION: String
const val WILDCARD_SEPARATOR: String

object Utils

fun mapOfNonNullValues(vararg entries: Pair<String, String?>): Map<String, String>
fun unroll(value: Any?, callback: (Any?) -> Unit): Unit

package com.cognifide.gradle.aem.common.utils.formats

class JsonPassword : JsonSerializer<String>

JsonPassword()
fun serialize(value: String?, generator: JsonGenerator, serializers: SerializerProvider): Unit

package com.cognifide.gradle.aem.environment

class Environment : Serializable

Environment(aem: AemExtension)
val aem: AemExtension
fun check(verbose: Boolean = true): List<HealthStatus>
val configDir: File
val created: Boolean
fun destroy(): Unit
val docker: Docker
fun docker(options: Docker.() -> Unit): Unit
fun down(): Unit
const val ENVIRONMENT_DIR: String
var healthChecker: HealthChecker
fun healthChecks(options: HealthChecker.() -> Unit): Unit
val hosts: HostOptions
fun hosts(options: HostOptions.() -> Unit): Unit
fun hosts(vararg values: String): Unit
fun hosts(names: Iterable<String>): Unit
fun reload(): Unit
fun resolve(): Unit
fun restart(): Unit
var rootDir: File
val running: Boolean
fun toString(): String
val up: Boolean
fun up(): Unit

class EnvironmentException : AemException

EnvironmentException(message: String, cause: Throwable)
EnvironmentException(message: String)

class EnvironmentPlugin : AemPlugin

EnvironmentPlugin()
fun Project.configure(): Unit
const val ID: String

package com.cognifide.gradle.aem.environment.docker

class Container

Container(docker: Docker, name: String)
val aem: AemExtension
fun await(): Unit
var awaitRetry: Retry
fun cleanDir(vararg paths: String): Unit
fun dev(options: DevOptions.() -> Unit): Unit
val devOptions: DevOptions
val docker: Docker
fun ensureDir(vararg paths: String): Unit
fun exec(execSpec: ExecSpec.() -> Unit): DockerResult
fun exec(command: String, exitCode: Int? = 0): DockerResult
fun exec(operation: String, command: String, exitCode: Int? = 0): DockerResult
fun execShell(command: String, exitCode: Int? = 0): DockerResult
fun execShell(operation: String, command: String, exitCode: Int? = 0): DockerResult
fun execShellQuiet(command: String, exitCode: Int? = 0): DockerResult
val host: HostFileManager
fun host(options: HostFileManager.() -> Unit): Unit
val id: String?
val internalName: String
fun isLocked(name: String): Boolean
fun lock(name: String): Unit
const val LOCK_ROOT: String
const val LOCK_UP: String
val name: String
fun reload(action: Container.() -> Unit): Unit
fun reload(): Unit
var reloadAction: Container.() -> Unit
fun resolve(action: HostFileManager.() -> Unit): Unit
fun resolve(): Unit
var resolveAction: HostFileManager.() -> Unit
val running: Boolean
var runningTimeout: Long
fun up(action: Container.() -> Unit): Unit
fun up(): Unit
val up: Boolean
var upAction: Container.() -> Unit

class ContainerManager

ContainerManager(docker: Docker)
fun define(name: String, definition: Container.() -> Unit): Container
val defined: MutableList<Container>
operator fun String.invoke(definition: Container.() -> Unit): Container
fun named(name: String): Container
fun reload(): Unit
fun resolve(): Unit
val running: Boolean
val up: Boolean
fun up(): Unit
fun use(name: String, action: Container.() -> Unit): Unit

class DaemonSpec : RunSpec

DaemonSpec(aem: AemExtension)
var id: String?
var initTime: Long
val outputFile: File!
var stopPrevious: Boolean
var unique: Boolean

class Docker

Docker(environment: Environment)
val aem: AemExtension
val composeFile: File
val composeTemplateFile: File
val configPath: String
val containers: ContainerManager
fun containers(options: ContainerManager.() -> Unit): Unit
fun daemon(spec: DaemonSpec.() -> Unit): Unit
fun down(): Unit
val environment: Environment
fun init(): Unit
fun reload(): Unit
val rootPath: String
fun run(spec: RunSpec.() -> Unit): DockerResult
fun run(image: String, command: String, exitCode: Int = 0): DockerResult
fun run(operation: String, image: String, command: String, exitCode: Int = 0): DockerResult
val running: Boolean
fun runShell(image: String, command: String, exitCode: Int = 0): DockerResult
fun runShell(operation: String, image: String, command: String, exitCode: Int = 0): DockerResult
val runtime: Runtime
val stack: Stack
val up: Boolean
fun up(): Unit

class DockerCustomSpec : DockerSpec

DockerCustomSpec(base: DockerDefaultSpec, argsOverride: List<String>)
val args: List<String>
val argsOverride: List<String>
val base: DockerDefaultSpec

open class DockerDefaultSpec : DockerSpec

DockerDefaultSpec(aem: AemExtension)
protected val aem: AemExtension
open val args: List<String>
open var command: String
open var errors: OutputStream?
fun exitCode(code: Int): Unit
open var exitCodes: List<Int>
open val fullCommand: String
open fun ignoreExitCodes(): Unit
open var input: InputStream?
open fun option(value: String): Unit
open var options: List<String>
open var output: OutputStream?

open class DockerException : AemException

DockerException(message: String, cause: Throwable)
DockerException(message: String)

object DockerProcess

const val COMMAND: String
fun exec(options: ProcBuilder.() -> Unit): ProcResult
fun execQuietly(options: ProcBuilder.() -> Unit): ProcResult
fun execSpec(spec: DockerSpec): DockerResult
fun execString(options: ProcBuilder.() -> Unit): String

class DockerResult

DockerResult(base: ProcResult)
val base: ProcResult
val errorBytes: ByteArray
val errorString: String
val executionTime: Long
val exitCode: Int
val outputBytes: ByteArray
val outputString: String
val procString: String

interface DockerSpec

abstract val args: List<String>
abstract var command: String
abstract var errors: OutputStream?
abstract var exitCodes: List<Int>
abstract val fullCommand: String
abstract fun ignoreExitCodes(): Unit
abstract var input: InputStream?
abstract fun option(value: String): Unit
abstract var options: List<String>
abstract var output: OutputStream?

kotlin.collections.Collection

val Collection<Container>.names: String

open class RunSpec : DockerDefaultSpec

RunSpec(aem: AemExtension)
var cleanup: Boolean
var detached: Boolean
var image: String
var indicator: Boolean
var name: String?
val operation: String
fun operation(textProvider: () -> String): Unit
fun operation(text: String): Unit
fun port(hostPort: Int, containerPort: Int): Unit
fun port(hostPort: String, containerPort: String): Unit
fun port(port: Int): Unit
var ports: Map<String, String>
fun volume(localFile: File, containerPath: String): Unit
fun volume(localPath: String, containerPath: String): Unit
var volumes: Map<String, String>

interface Runtime

fun detect(aem: AemExtension): Runtime?
fun determine(aem: AemExtension): Runtime
abstract fun determinePath(path: String): String
open fun determinePath(file: File): String
abstract val hostInternalIp: String?
abstract val hostIp: String
abstract val name: String
fun of(aem: AemExtension, name: String): Runtime?
abstract val safeVolumes: Boolean

class Stack

Stack(environment: Environment)
fun deploy(): Unit
var deployRetry: Retry
val environment: Environment
val initialized: Boolean
var initTimeout: Long
val internalName: String!
val networkAvailable: Boolean
var networkTimeout: Long
fun reset(): Unit
val running: Boolean
fun undeploy(): Unit
var undeployRetry: Retry

class StackException : DockerException

StackException(message: String, cause: Throwable)
StackException(message: String)

package com.cognifide.gradle.aem.environment.docker.container

class ContainerException : DockerException

ContainerException(message: String, cause: Throwable)
ContainerException(message: String)

class DevOptions

DevOptions(container: Container)
val container: Container
fun watchConfigDir(vararg paths: String): Unit
fun watchDir(vararg files: File): Unit
var watchDirs: MutableList<File>

class ExecSpec : DockerDefaultSpec

ExecSpec(aem: AemExtension)
fun env(vars: Map<String, String>): Unit
fun env(varName: String, varValue: String): Unit
var indicator: Boolean
var operation: () -> String
fun operation(operation: () -> String): Unit
fun operation(text: String): Unit
fun privileged(): Unit
fun user(id: String): Unit
fun workDir(path: String): Unit

class HostFileManager

HostFileManager(container: Container)
fun cleanDir(vararg paths: String): Unit
val configDir: File
fun configFile(path: String): File
val container: Container
fun ensureDir(): Unit
fun ensureDir(vararg paths: String): Unit
fun file(path: String): File
var fileDir: File
fun resolveFiles(options: FileResolver.() -> Unit): List<File>
val rootDir: File

package com.cognifide.gradle.aem.environment.docker.runtime

abstract class Base : Runtime

Base(aem: AemExtension)
protected val aem: AemExtension
protected val logger: Logger!
open fun toString(): String

class Desktop : Base

Desktop(aem: AemExtension)
fun determinePath(path: String): String
val hostInternalIp: String?
val hostIp: String
val name: String
const val NAME: String
val safeVolumes: Boolean

class Toolbox : Base

Toolbox(aem: AemExtension)
var cygpathPath: String
fun detectHostIp(): String?
fun determinePath(path: String): String
fun executeCygpath(path: String): String
val hostInternalIp: String?
val hostIp: String
fun imitateCygpath(path: String): String
val name: String
const val NAME: String
val safeVolumes: Boolean

package com.cognifide.gradle.aem.environment.health

class HealthCheck

HealthCheck(name: String, action: () -> Any?)
val action: () -> Any?
val name: String
fun perform(): HealthStatus
fun toString(): String

class HealthChecker

HealthChecker(environment: Environment)
fun check(verbose: Boolean = true): List<HealthStatus>
fun define(name: String, check: () -> Unit): Unit
val environment: Environment
fun http(options: HttpClient.() -> Unit): Unit
var retry: Retry
fun url(checkName: String, url: String, criteria: UrlCheck.() -> Unit): Unit

class HealthStatus

HealthStatus(check: HealthCheck, cause: Exception? = null)
val cause: Exception?
val check: HealthCheck
val passed: Boolean
val status: String
fun toString(): String

class UrlCheck

UrlCheck(url: String)
fun check(spec: HttpClient.(HttpResponse) -> Unit): Unit
fun containsText(text: String, statusCode: Int = HttpStatus.SC_OK): Unit
var method: String
fun options(options: HttpClient.() -> Unit): Unit
val url: String

package com.cognifide.gradle.aem.environment.hosts

class Host : Serializable

Host(url: String)
val config: URL
var ip: String
fun tag(id: String): Unit
fun tag(ids: Iterable<String>): Unit
fun tag(vararg ids: String): Unit
var tags: MutableSet<String>
val text: String
val url: String

class HostOptions : Serializable

HostOptions(environment: Environment)
fun all(vararg tags: String): List<Host>
fun all(tags: Iterable<String>): List<Host>
val appendix: String
val author: Host
fun author(vararg urls: String, options: Host.() -> Unit = {}): Unit
fun author(urls: Iterable<String>, options: Host.() -> Unit = {}): Unit
val authors: List<Host>
fun define(url: String, options: Host.() -> Unit = {}): Unit
fun define(vararg urls: String, options: Host.() -> Unit = {}): Unit
fun define(urls: Iterable<String>, options: Host.() -> Unit = {}): Unit
var defined: MutableList<Host>
fun find(vararg tags: String): Host
fun find(tags: Iterable<String>): Host
var ipDefault: String
val osFile: String
fun other(vararg urls: String, options: Host.() -> Unit = {}): Unit
fun other(urls: Iterable<String>, options: Host.() -> Unit = {}): Unit
val others: List<Host>
val publish: Host
fun publish(vararg urls: String, options: Host.() -> Unit = {}): Unit
fun publish(urls: Iterable<String>, options: Host.() -> Unit = {}): Unit
val publishes: List<Host>
val TAG_AUTHOR: String
val TAG_OTHER: String
val TAG_PUBLISH: String

package com.cognifide.gradle.aem.environment.reloader

class ContainerFileEvent

ContainerFileEvent(container: Container, event: Event)
val container: Container
val event: Event

open class Reloader

Reloader(environment: Environment)
val configured: Boolean
val environment: Environment
fun start(): Unit

package com.cognifide.gradle.aem.environment.tasks

open class EnvironmentAwait : AemDefaultTask

EnvironmentAwait()
fun await(): Unit
const val NAME: String

open class EnvironmentDestroy : AemDefaultTask

EnvironmentDestroy()
fun destroy(): Unit
const val NAME: String
open fun taskGraphReady(graph: TaskExecutionGraph): Unit

open class EnvironmentDev : AemDefaultTask

EnvironmentDev()
fun dev(): Unit
const val NAME: String
val reloader: Reloader

open class EnvironmentDown : AemDefaultTask

EnvironmentDown()
fun down(): Unit
const val NAME: String

open class EnvironmentHosts : AemDefaultTask

EnvironmentHosts()
fun appendHosts(): Unit
const val NAME: String

open class EnvironmentReload : AemDefaultTask

EnvironmentReload()
const val NAME: String
fun reload(): Unit

open class EnvironmentResetup : AemDefaultTask

EnvironmentResetup()
const val NAME: String

open class EnvironmentResolve : AemDefaultTask

EnvironmentResolve()
const val NAME: String
fun resolve(): Unit

open class EnvironmentRestart : AemDefaultTask

EnvironmentRestart()
const val NAME: String

open class EnvironmentUp : AemDefaultTask

EnvironmentUp()
const val NAME: String
fun up(): Unit

package com.cognifide.gradle.aem.instance

class InstancePlugin : AemPlugin

InstancePlugin()
fun Project.configure(): Unit
const val ID: String

package com.cognifide.gradle.aem.instance.provision

class Action

Action(step: InstanceStep, status: Status)
val status: Status
val step: InstanceStep

class Condition

Condition(step: InstanceStep)
fun always(): Boolean
fun failSafeOnce(): Boolean
val instance: Instance
fun never(): Boolean
fun once(): Boolean
fun repeatAfter(millis: Long): Boolean
fun repeatAfterDays(count: Long): Boolean
fun repeatAfterHours(count: Long): Boolean
fun repeatAfterMinutes(count: Long): Boolean
fun repeatAfterSeconds(count: Long): Boolean
fun repeatEvery(counterPredicate: (Long) -> Boolean): Boolean
fun repeatEvery(times: Long): Boolean
fun repeatProbably(probability: Double): Boolean
fun rerunOnFail(): Boolean
fun sinceEndedMoreThan(millis: Long): Boolean
val step: InstanceStep
fun ultimateOnce(): Boolean

open class InstanceProvision : AemDefaultTask

InstanceProvision()
const val NAME: String
fun provision(): Unit
val provisioner: Provisioner
fun provisioner(options: Provisioner.() -> Unit): Unit
fun step(id: String, options: Step.() -> Unit): Unit

class InstanceStep

InstanceStep(instance: Instance, definition: Step)
val counter: Long
const val COUNTER_PROP: String
val definition: Step
val duration: Long
val durationString: String
val ended: Boolean
const val ENDED_AT_PROP: String
val endedAt: Date
val failed: Boolean
const val FAILED_PROP: String
val instance: Instance
fun isPerformable(): Boolean
fun perform(): Unit
val started: Boolean
const val STARTED_AT_PROP: String
val startedAt: Date
fun toString(): String
fun update(): Unit

class Provisioner

Provisioner(aem: AemExtension)
val aem: AemExtension
var greedy: Boolean
var instances: List<Instance>
var path: String
fun provision(): List<Action>
fun step(id: String, options: Step.() -> Unit): Unit
var stepName: String

open class ProvisionException : InstanceException

ProvisionException(message: String, cause: Throwable)
ProvisionException(message: String)

enum class Status

ENDED
FAILED
SKIPPED

class Step

Step(provisioner: Provisioner, id: String)
fun action(callback: Instance.() -> Unit): Unit
fun condition(callback: Condition.() -> Boolean): Unit
var conditionCallback: Condition.() -> Boolean
var continueOnFail: Boolean
var description: String?
val id: String
val provisioner: Provisioner
var rerunOnFail: Boolean
var retry: Retry
fun retry(options: Retry.() -> Unit): Unit
fun toString(): String
fun validate(): Unit

package com.cognifide.gradle.aem.instance.satisfy

open class InstanceSatisfy : PackageDeploy

InstanceSatisfy()
val allFiles: List<File>
val cmdGroups: Boolean
open fun deploy(): Unit
var downloadDir: File
var greedy: Boolean
const val GROUP_CMD: String
var groupFilter: FileGroup.() -> Boolean
var groupName: String
var listRefresh: Boolean
var listRetry: Retry
const val NAME: String
val outputDirs: List<File>
class PackageAction

PackageAction(pkg: File, instance: Instance)
val instance: Instance
val pkg: File

val packageGroups: List<PackageGroup>
val packageProvider: PackageResolver
fun packages(configurer: PackageResolver.() -> Unit): Unit
fun resolvePackages(): Unit

class PackageGroup : FileGroup

PackageGroup(resolver: PackageResolver, name: String)
fun completer(callback: () -> Unit): Unit
protected fun createResolution(id: String, resolver: (FileResolution) -> File): FileResolution
var distributed: Boolean?
fun finalizer(callback: InstanceSync.() -> Unit): Unit
var greedy: Boolean
fun initializer(callback: InstanceSync.() -> Unit): Unit
var installRecursive: Boolean?
var installRetry: Retry?
var instanceName: String
val resolver: PackageResolver
var uploadForce: Boolean?
var uploadRetry: Retry?
var workflowToggle: MutableMap<String, Boolean>
fun workflowToggle(id: String, flag: Boolean): Unit

class PackageResolution : FileResolution

PackageResolution(group: PackageGroup, id: String, action: (FileResolution) -> File)

class PackageResolver : Resolver<PackageGroup>

PackageResolver(aem: AemExtension, downloadDir: File)
var bundleDefinition: PackageDefinition.(BundleFile) -> Unit
var bundlePath: String
fun createGroup(name: String): PackageGroup

package com.cognifide.gradle.aem.instance.tail

class InstanceAnalyzer

InstanceAnalyzer(tailer: InstanceTailer, instance: Instance, logsChannel: ReceiveChannel<Log>, notificationChannel: SendChannel<LogChunk>)
fun listenTailed(): Unit

data class InstanceLogInfo

InstanceLogInfo(name: String, zoneId: ZoneId)
val name: String
fun none(): InstanceLogInfo
fun of(instance: Instance): InstanceLogInfo
val zoneId: ZoneId

open class InstanceTail : InstanceTask

InstanceTail()
const val NAME: String
open fun projectEvaluated(): Unit
fun tail(): Unit
val tailer: InstanceTailer
fun tailer(options: InstanceTailer.() -> Unit): Unit

class InstanceTailer

InstanceTailer(aem: AemExtension)
val aem: AemExtension
var console: Boolean
const val ENDPOINT_PATH: String
const val ENDPOINT_PATH_OLD: String
fun errorLogEndpoint(instance: Instance): String
var fetchInterval: Long
val INCIDENT_LEVELS_DEFAULT: List<String>
const val INCIDENT_OLD_DEFAULT: Long
var incidentChecker: Log.(Instance) -> Boolean
var incidentDelay: Long
var incidentFilter: File
fun incidentFilter(options: LogFilter.() -> Unit): Unit
var instances: List<Instance>
var linesChunkSize: Long
var lockInterval: Long
val logFile: String
var logFilePath: String
val logFilter: LogFilter
fun logFilter(options: LogFilter.() -> Unit): Unit
var logListener: Log.(Instance) -> Unit
var rootDir: File
fun tail(): Unit

class InstanceTailerException : AemException

InstanceTailerException(message: String)

class Log

Log(instance: InstanceLogInfo = InstanceLogInfo.none(), text: String, timestamp: ZonedDateTime, level: String, source: String, messageLines: List<String>)
val cause: String
val checksum: String
fun create(instance: InstanceLogInfo, logLines: List<String>): Log
val instance: InstanceLogInfo
fun isFirstLineOfLog(text: String): Boolean
fun isLevel(vararg levels: String): Boolean
fun isLevel(levels: Iterable<String>): Boolean
fun isOlderThan(millis: Long): Boolean
val level: String
val logWithLocalTimestamp: String
val message: String
fun parseTimestamp(timestamp: String, instance: InstanceLogInfo = InstanceLogInfo.none()): ZonedDateTime
val source: String
val text: String
val timestamp: ZonedDateTime

class LogChunk

LogChunk(instance: Instance, logs: List<Log>)
val instance: Instance
val logs: List<Log>
val size: Int

interface LogDestination

abstract fun dump(logs: List<Log>): Unit

class LogFilter

LogFilter()
fun excludeFile(file: File): Unit
val excludeFiles: MutableList<File>
fun excludeRule(predicate: Log.() -> Boolean): Unit
val excludeRules: MutableList<Log.() -> Boolean>
fun excludeWildcard(vararg matchers: String): Unit
fun excludeWildcard(matchers: Iterable<String>): Unit
fun excludeWildcard(matchers: Sequence<String>): Unit
fun excludeWildcard(matcher: String): Unit
const val FILE_COMMENT_PREFIX: String
fun isExcluded(log: Log): Boolean

class LogNotifier

LogNotifier(notificationChannel: ReceiveChannel<LogChunk>, notifier: NotifierFacade, logFiles: LogFiles)
fun listenTailed(): Unit

class LogParser

LogParser(instance: InstanceLogInfo = InstanceLogInfo.none())
fun parse(reader: BufferedReader): List<Log>

interface LogSource

abstract fun <T> readChunk(parser: (BufferedReader) -> List<T>): List<T>

class LogTailer

LogTailer(source: LogSource, destination: LogDestination, instance: InstanceLogInfo = InstanceLogInfo.none(), logsAnalyzerChannel: SendChannel<Log>? = null, printer: ConsolePrinter = ConsolePrinter.none())
fun tail(): Unit

package com.cognifide.gradle.aem.instance.tail.io

class ConsolePrinter

ConsolePrinter(instance: InstanceLogInfo, log: (String) -> Unit, incidentMaxAgeInMillis: Long = 5000)
fun dump(newLogs: List<Log>): Unit
fun none(): ConsolePrinter

class FileDestination : LogDestination

FileDestination(instanceName: String, logFiles: LogFiles)
fun dump(logs: List<Log>): Unit

class LogFiles

LogFiles(tailer: InstanceTailer)
fun clearIncidents(instanceName: String): Unit
fun clearMain(instanceName: String): Unit
const val INCIDENT_DIR: String
fun incidentDir(instanceName: String): File
fun incidentFile(instanceName: String): File
fun isLocked(): Boolean
fun lock(): Unit
const val LOCK_FILE: String
fun main(instanceName: String): File
fun writeToIncident(instanceName: String, writerBlock: (BufferedWriter) -> Unit): URI
fun writeToMain(instanceName: String, writerBlock: (FileWriter) -> Unit): Unit

class UrlSource : LogSource

UrlSource(tailer: InstanceTailer, instance: Instance)
fun <T> readChunk(parser: (BufferedReader) -> List<T>): List<T>

package com.cognifide.gradle.aem.instance.tasks

open class InstanceAwait : AemDefaultTask

InstanceAwait()
fun await(): Unit
fun awaitUp(options: AwaitUpAction.() -> Unit): Unit
const val NAME: String

open class InstanceBackup : AemDefaultTask

InstanceBackup()
fun backup(): Unit
var mode: Mode
enum class Mode

fun of(name: String): Mode
UPLOAD_ONLY
ZIP_AND_UPLOAD
ZIP_ONLY

const val NAME: String

open class InstanceCreate : LocalInstanceTask

InstanceCreate()
fun create(): Unit
const val NAME: String

open class InstanceDestroy : LocalInstanceTask

InstanceDestroy()
fun destroy(): Unit
const val NAME: String
open fun taskGraphReady(graph: TaskExecutionGraph): Unit

open class InstanceDown : LocalInstanceTask

InstanceDown()
fun awaitDown(options: AwaitDownAction.() -> Unit): Unit
fun down(): Unit
const val NAME: String

open class InstanceReload : InstanceTask

InstanceReload()
fun awaitUp(options: AwaitUpAction.() -> Unit): Unit
const val NAME: String
fun reload(options: ReloadAction.() -> Unit): Unit
fun reload(): Unit

open class InstanceResetup : AemDefaultTask

InstanceResetup()
const val NAME: String

open class InstanceResolve : AemDefaultTask

InstanceResolve()
const val NAME: String
fun resolve(): Unit

open class InstanceRestart : AemDefaultTask

InstanceRestart()
const val NAME: String

open class InstanceSetup : AemDefaultTask

InstanceSetup()
const val NAME: String

open class InstanceUp : LocalInstanceTask

InstanceUp()
fun await(options: AwaitUpAction.() -> Unit): Unit
const val NAME: String
fun up(): Unit

package com.cognifide.gradle.aem.pkg

class PackagePlugin : AemPlugin

PackagePlugin()
fun Project.configure(): Unit
const val ID: String

package com.cognifide.gradle.aem.pkg.tasks

open class PackageActivate : PackageTask

PackageActivate()
fun activate(): Unit
const val NAME: String

open class PackageCompose : ZipTask

PackageCompose()
var bundlePath: String
val composedDir: File
val composedFile: File
var contentDir: File
protected open fun copy(): Unit
val fileFilter: PackageFileFilter
fun fileFilter(configurer: PackageFileFilter.() -> Unit): Unit
var fileFilterDelegate: (CopySpec) -> Unit
val fileProperties: Map<String, VltDefinition>
fun fromBundle(composeTaskPath: String): Unit
var fromConvention: Boolean
fun fromConvention(): Unit
fun fromJar(dependencyOptions: DependencyOptions.() -> Unit, installPath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromJar(dependencyNotation: Any, installPath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromJar(jar: Jar, bundlePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromJar(jar: File, bundlePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromJars(jars: Collection<File>, bundlePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromMeta(): Unit
fun fromMeta(metaDir: File): Unit
fun fromPackage(composeTaskPath: String): Unit
fun fromProject(): Unit
fun fromProject(path: String, options: ProjectMergingOptions.() -> Unit): Unit
fun fromProject(path: String, options: ProjectMergingOptions = ProjectMergingOptions()): Unit
fun fromProject(project: Project, options: ProjectMergingOptions.() -> Unit): Unit
fun fromProject(project: Project, options: ProjectMergingOptions = ProjectMergingOptions()): Unit
fun fromProjects(pathFilter: String, options: ProjectMergingOptions.() -> Unit): Unit
fun fromProjects(pathFilter: String, options: ProjectMergingOptions = ProjectMergingOptions()): Unit
fun fromSubpackage(composeTaskPath: String, storagePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromSubprojects(options: ProjectMergingOptions.() -> Unit): Unit
fun fromSubprojects(options: ProjectMergingOptions = ProjectMergingOptions()): Unit
fun fromZip(dependencyOptions: DependencyOptions.() -> Unit, storagePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromZip(dependencyNotation: String, storagePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromZip(dependencyNotation: Any, storagePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromZip(zip: File, packagePath: String? = null, vaultFilter: Boolean? = null): Unit
fun fromZips(zips: Collection<File>, packagePath: String? = null, vaultFilter: Boolean? = null): Unit
val inputFiles: List<File>
fun merging(options: ProjectMergingOptions.() -> Unit): Unit
var metaDir: File
const val NAME: String
var packagePath: String
open fun projectEvaluated(): Unit
open fun projectsEvaluated(): Unit
var validator: PackageValidator
fun validator(options: PackageValidator.() -> Unit): Unit
val vaultDefinition: VltDefinition
fun vaultDefinition(options: VltDefinition.() -> Unit): Unit
val vaultDir: File
val vaultFilterFile: File
val vaultFilterOriginFile: File
val vaultNodeTypesFile: File
val vaultNodeTypesSyncFile: File

open class PackageDelete : PackageTask

PackageDelete()
fun delete(): Unit
const val NAME: String
open fun taskGraphReady(graph: TaskExecutionGraph): Unit

open class PackageDeploy : PackageTask

PackageDeploy()
var awaited: Boolean
fun awaitUp(options: AwaitUpAction.() -> Unit): Unit
fun awaitUp(): Unit
var completer: () -> Unit
open fun deploy(): Unit
var distributed: Boolean
var finalizer: InstanceSync.() -> Unit
var initializer: InstanceSync.() -> Unit
var installRecursive: Boolean
var installRetry: Retry
const val NAME: String
open fun projectsEvaluated(): Unit
var uploadForce: Boolean
var uploadRetry: Retry
var workflowToggle: Map<String, Boolean>

open class PackageInstall : PackageTask

PackageInstall()
fun install(): Unit
const val NAME: String

open class PackagePrepare : AemDefaultTask

PackagePrepare()
var contentDir: File
var metaDefaults: Boolean
val metaDir: File
val metaDirs: List<File>
const val NAME: String
fun prepare(): Unit
fun syncNodeTypesFallback(): Unit
fun syncNodeTypesOrElse(action: () -> Unit): Boolean?
fun syncNodeTypesOrFallback(): Boolean?
val vaultFilterOriginFile: File
val vaultFilterTemplateFile: File
var vaultNodeTypesSync: NodeTypesSync
var vaultNodeTypesSyncFile: File

open class PackagePurge : PackageTask

PackagePurge()
const val NAME: String
fun purge(): Unit
open fun taskGraphReady(graph: TaskExecutionGraph): Unit

open class PackageUninstall : PackageTask

PackageUninstall()
const val NAME: String
open fun taskGraphReady(graph: TaskExecutionGraph): Unit
fun uninstall(): Unit

open class PackageUpload : PackageTask

PackageUpload()
const val NAME: String
fun upload(): Unit

package com.cognifide.gradle.aem.pkg.tasks.compose

class BundleDependency

BundleDependency(aem: AemExtension, notation: Any, installPath: String, vaultFilter: Boolean)
val file: File
var installPath: String
var vaultFilter: Boolean

class PackageDependency

PackageDependency(aem: AemExtension, notation: Any, storagePath: String, vaultFilter: Boolean)
val file: File
var storagePath: String
var vaultFilter: Boolean

class ProjectMergingOptions

ProjectMergingOptions()
var bundleBuilt: Boolean
var bundleDependent: Boolean
var bundleTasks: AemExtension.() -> Collection<BundleCompose>
var composeContent: Boolean
var composeTasks: AemExtension.() -> Collection<PackageCompose>
var extraTasks: AemExtension.() -> Collection<Task>
var packageDependent: Boolean
var vaultFilters: Boolean
var vaultHooks: Boolean
var vaultNodeTypes: Boolean
var vaultProperties: Boolean

package com.cognifide.gradle.aem.tooling

class ToolingPlugin : AemPlugin

ToolingPlugin()
fun Project.configure(): Unit
const val ID: String

package com.cognifide.gradle.aem.tooling.rcp

open class Rcp : AemDefaultTask

Rcp()
const val NAME: String
fun options(configurer: RcpClient.() -> Unit): Unit
fun run(): Unit

class RcpClient

RcpClient(aem: AemExtension)
var copiedPaths: Long
fun copy(): Unit
fun copy(pathsFile: File): Unit
fun copy(paths: Sequence<String>): Unit
fun copy(paths: Iterable<String>): Unit
fun copy(paths: Map<String, String>): Unit
fun copy(path: String): Unit
fun copy(sourcePath: String, targetPath: String): Unit
var opts: String
var paths: List<String>?
var pathsFile: File?
var sourceInstance: Instance?
val stopWatch: StopWatch
fun summary(): RcpSummary
var targetInstance: Instance?

data class RcpSummary

RcpSummary(source: Instance, target: Instance, copiedPaths: Long, duration: Long)
val copiedPaths: Long
val duration: Long
val durationString: String
val source: Instance
val target: Instance
fun toString(): String

package com.cognifide.gradle.aem.tooling.sync

class Cleaner

Cleaner(aem: AemExtension)
fun beforeClean(root: File): Unit
fun clean(root: File): Unit
fun cleanNamespaces(lines: List<String>): List<String>
val CONTENT_PROP_PATTERN: Pattern
var contentProcess: (File, List<String>) -> List<String>
var filesDeleted: PatternFilterable.() -> Unit
var filesDotContent: PatternFilterable.() -> Unit
var filesFlattened: PatternFilterable.() -> Unit
const val JCR_CONTENT_FILE: String
const val JCR_MIXIN_TYPES_PROP: String
const val JCR_ROOT_PREFIX: String
var lineProcess: (File, String) -> String
fun mergeSinglePropertyLines(lines: List<String>): MutableList<String>
var mixinTypesSkipped: List<String>
val NAMESPACE_PATTERN: Pattern
var namespacesSkipped: Boolean
fun normalizeContent(file: File, lines: List<String>): List<String>
fun normalizeLine(file: File, line: String): String
fun normalizeMixins(file: File, line: String): String
var parentsBackupEnabled: Boolean
var parentsBackupSuffix: String
fun pathRule(pattern: String, excludedPaths: List<String>): String
fun pathRule(pattern: String, excludedPaths: List<String>, includedPaths: List<String>): String
fun prepare(root: File): Unit
var propertiesSkipped: List<String>
fun skipProperties(file: File, line: String): String

class CleanerRule

CleanerRule(value: String)
const val EXCLUDE_FLAG: String
fun manyFrom(props: List<String>): List<CleanerRule>
fun match(file: File, value: String): Boolean
const val PATH_DELIMITER: String
const val PATHS_DELIMITER: String

class Downloader

Downloader(aem: AemExtension)
fun download(): Unit
var extract: Boolean
var extractDir: File
var filter: FilterFile
var instance: Instance
var retry: Retry

open class Sync : AemDefaultTask

Sync()
fun cleaner(options: Cleaner.() -> Unit): Unit
var contentDir: File
fun downloader(options: Downloader.() -> Unit): Unit
var filter: FilterFile
var instance: Instance
var mode: Mode
fun mode(name: String): Unit
enum class Mode

CLEAN_ONLY
COPY_AND_CLEAN
COPY_ONLY
fun of(name: String): Mode

const val NAME: String
fun sync(): Unit
var transfer: Transfer
fun transfer(name: String): Unit
enum class Transfer

fun of(name: String): Transfer
PACKAGE_DOWNLOAD
VLT_CHECKOUT

fun vlt(options: VltClient.() -> Unit): Unit

package com.cognifide.gradle.aem.tooling.vlt

open class Vlt : AemDefaultTask

Vlt()
const val NAME: String
fun options(configurer: VltClient.() -> Unit): Unit
open fun run(): Unit

class VltApp : VaultFsApp

VltApp(project: Project)
const val CURRENT_WORKING_DIR: String
fun execute(command: String, workingPath: String): Unit
fun execute(command: String, workingDir: File): Unit
fun execute(args: List<String>, workingDir: File): Unit
@Synchronized fun execute(args: List<String>, workingPath: String): Unit
protected fun getDefaultContext(): ExecutionContext
val project: Project

class VltClient

VltClient(aem: AemExtension)
val aem: AemExtension
var command: String
val commandEffective: String
var commandProperties: Map<String, Any>
var contentDir: File
val contentDirEffective: File
var contentRelativePath: String
fun run(): VltSummary

class VltException : AemException

VltException(message: String, cause: Throwable)
VltException(message: String)

class VltExecutionContext : VltExecutionContext

VltExecutionContext(app: VltApp)
fun execute(commandLine: CommandLine): Boolean

data class VltSummary

VltSummary(command: String, contentDir: File, duration: Long)
val command: String
val contentDir: File
val duration: Long
val durationString: String
fun toString(): String