aem-plugin

alltypes

class Action

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

open class AemDefaultTask : CommonDefaultTask, AemTask

AemDefaultTask()
val aem: AemExtension

open class AemException : CommonException

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 bundle: File
fun bundleEmbed(dependencyNotation: Any, pkgs: Iterable<String>, export: Boolean = false): Unit
fun bundleEmbed(dependencyNotation: Any, vararg pkgs: String, export: Boolean = false): Unit
val bundles: List<File>
val common: CommonExtension
fun common(options: CommonOptions.() -> Unit): Unit
val commonOptions: CommonOptions
fun composePackage(definition: PackageDefinition.() -> Unit): File
val filter: FilterFile
fun filter(file: File): FilterFile
fun filter(path: String): FilterFile
fun filterInstances(nameMatcher: String = prop.string("instance.name") ?: "${commonOptions.env.get()}-*"): List<Instance>
fun findInstance(desiredName: String? = prop.string("instance.name"), defaultName: String = "${commonOptions.env.get()}-*"): Instance?
fun <T> groovyEval(options: GroovyEvaluator.() -> T): T
fun groovyEval(scriptPattern: String): GroovyEvalSummary
fun instance(options: InstanceManager.() -> Unit): Unit
fun instance(urlOrName: String): Instance
val instanceManager: InstanceManager
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>
fun localInstance(options: LocalInstanceManager.() -> Unit): LocalInstanceManager
val localInstanceManager: LocalInstanceManager
val localInstances: List<LocalInstance>
fun localInstances(consumer: LocalInstance.() -> Unit): Unit
val logger: Logger!
const val NAME: String
fun namedInstance(desiredName: String? = prop.string("instance.name"), defaultName: String = "${commonOptions.env.get()}-*"): Instance
val obj: ObjectFactory
fun of(project: Project): AemExtension
fun package(options: PackageOptions.() -> Unit): Unit
fun package(file: File): PackageFile
val package: File
val packageOptions: PackageOptions
val packages: List<File>
fun pkg(options: PackageOptions.() -> Unit): Unit
fun pkg(file: File): PackageFile
val pkg: File
val project: Project
val prop: PropertyParser
val publishInstance: Instance
val publishInstances: List<Instance>
fun publishInstances(consumer: Instance.() -> Unit): Unit
fun <T> rcp(options: RcpClient.() -> T): T
val remoteInstances: List<Instance>
fun remoteInstances(consumer: Instance.() -> Unit): Unit
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
fun validatePackage(vararg packages: File, options: PackageValidator.() -> Unit = {}): Unit
fun validatePackage(packages: Iterable<File>, options: PackageValidator.() -> Unit = {}): Unit
fun vlt(command: String): VaultSummary
fun <T> vlt(options: VaultClient.() -> T): T

class AemPlugin : Serializable

AemPlugin()
val BUILD: AemPlugin
lateinit var gradleVersion: String
const val ID: String
const val NAME: String
val NAME_WITH_VERSION: String
@Synchronized fun once(callback: AemPlugin.() -> Unit): Unit
const val PKG: String
lateinit var pluginVersion: String

interface AemTask : Task

abstract val aem: AemExtension
const val GROUP: String

class AwaitDownAction : DefaultAction

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

class AwaitUpAction : DefaultAction

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

class BackupManager

BackupManager(aem: AemExtension)
val any: File?
fun create(instances: Collection<LocalInstance>): File
fun create(file: File, instances: Collection<LocalInstance>): Unit
val downloadUrl: Property<String!>!
val local: File?
val localDir: DirectoryProperty!
val namedFile: File
fun namer(provider: () -> String): Unit
const val OUTPUT_DIR: String
val remote: File?
val remoteDir: DirectoryProperty!
fun restore(backupZip: File, rootDir: File, instances: Collection<LocalInstance>): Unit
fun selector(selector: Collection<BackupSource>.() -> BackupSource?): Unit
val suffix: Property<String!>!
const val SUFFIX_DEFAULT: String
fun upload(backupZip: File, verbose: Boolean): Boolean
val uploadUrl: Property<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

val dirName: String
LOCAL
REMOTE

class BuildResponse

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

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

enum class BundleChecking

EXCLUDE
FAIL
NONE
fun of(name: String): BundleChecking
WARN

open class BundleCompose : JarTask, AemTask

BundleCompose()
var activator: String?
val activatorClasses: ListProperty<String!>!
val activatorSourceSets: MapProperty<String!, String!>!
val aem: AemExtension
fun attribute(name: String, value: String?): Manifest!
fun attribute(name: String): String?
var attributes: MutableMap<String, Any?>
val attributesConvention: Property<Boolean!>!
fun bnd(vararg lines: CharSequence): Unit
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 embedPackage(dependencyNotation: Any, vararg pkgs: String, export: Boolean = false): Unit
fun embedPackage(dependencyNotation: Any, pkgs: Iterable<String>, export: Boolean = false): Unit
fun excludePackage(pkgs: Iterable<String>): Unit
fun excludePackage(vararg pkgs: String): Unit
fun exportPackage(pkgs: Iterable<String>): Unit
fun exportPackage(vararg pkgs: String): Unit
val exportPackages: ListProperty<String!>!
var fragmentHost: String?
fun hasAttribute(name: String): Boolean
fun importPackage(pkgs: Iterable<String>): Unit
fun importPackage(vararg pkgs: String): Unit
val importPackages: ListProperty<String!>!
val importPackageWildcard: Property<Boolean!>!
val installPath: Property<String!>!
val installRunMode: Property<String!>!
val javaConvention: JavaPluginConvention!
val javaPackage: Property<String!>!
val javaPackageOptions: Property<String!>!
var license: String?
const val NAME: String
fun privatePackage(pkgs: Iterable<String>): Unit
fun privatePackage(vararg pkgs: String): Unit
val privatePackages: ListProperty<String!>!
open fun projectEvaluated(): Unit
var slingModelPackages: String?
var symbolicName: String?
val vaultFilter: Property<Boolean!>!
var vendor: String?
fun wildcardPackage(pkgs: Iterable<String>): List<String>
fun wildcardPackage(vararg pkgs: String): List<String>

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()
open fun install(): Unit
const val NAME: String
val refreshPackages: Property<Boolean!>!
var retry: Retry
val start: Property<Boolean!>!
val startLevel: Property<Int!>!

interface BundleInstalled : RepositoryArchive

abstract val runMode: Property<String>

class BundleInstalledBuilt : BundleInstalled

BundleInstalledBuilt(target: PackageCompose, task: TaskProvider<BundleCompose>)
val dirPath: Property<String!>!
val file: RegularFileProperty!
val fileName: Property<String!>!
val runMode: Property<String!>!
val vaultFilter: Property<Boolean!>!

class BundleInstalledResolved : BundleInstalled

BundleInstalledResolved(target: PackageCompose, notation: Any)
val dirPath: Property<String!>!
val file: RegularFileProperty!
val fileName: Property<String!>!
val notation: Any
val runMode: Property<String!>!
val vaultFilter: Property<Boolean!>!

class BundlePlugin : CommonDefaultPlugin

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

class BundlesCheck : DefaultCheck

BundlesCheck(group: CheckGroup)
fun check(): Unit
val symbolicNamesIgnored: ListProperty<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 : SyncFileTask

BundleTask()

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 : DefaultAction

CheckAction(aem: AemExtension)
fun perform(instances: Collection<Instance>): 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 status: String
val statusLogger: CollectingLogger
val summary: String

class CheckProgress

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

class CheckRunner

CheckRunner(aem: AemExtension)
val aborted: Boolean
fun check(instances: Collection<Instance>): Unit
fun checks(definitions: CheckFactory.() -> List<Check>): Unit
val delay: Property<Long!>!
var logInstantly: Boolean
fun progress(instance: Instance): CheckProgress
val runningTime: Long
val verbose: Property<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
fun contentProcess(callback: (File, List<String>) -> List<String>): Unit
fun filesDeleted(filter: PatternFilterable.() -> Unit): Unit
fun filesDotContent(filter: PatternFilterable.() -> Unit): Unit
fun filesFlattened(filter: PatternFilterable.() -> Unit): Unit
const val JCR_CONTENT_FILE: String
const val JCR_MIXIN_TYPES_PROP: String
const val JCR_ROOT_PREFIX: String
fun lineProcess(callback: (File, String) -> String): Unit
fun mergeSinglePropertyLines(lines: List<String>): MutableList<String>
val mixinTypesSkipped: ListProperty<String!>!
val NAMESPACE_PATTERN: Pattern
val namespacesSkipped: Property<Boolean!>!
fun normalizeContent(file: File, lines: List<String>): List<String>
fun normalizeLine(file: File, line: String): String
fun normalizeMixins(file: File, line: String): String
val parentsBackupEnabled: Property<Boolean!>!
val parentsBackupSuffix: Property<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
val propertiesSkipped: ListProperty<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 CndSync

CndSync(aem: AemExtension)
val file: RegularFileProperty!
fun sync(): Unit
val type: Property<CndSyncType!>!
fun type(name: String): Unit

enum class CndSyncType

ALWAYS
fun find(name: String): CndSyncType?
NEVER
fun of(name: String): CndSyncType
PRESERVE

open class CommonOptions

CommonOptions(aem: AemExtension)
val baseName: Property<String!>!
val env: Property<String!>!
val lineSeparator: Property<LineSeparator!>!
val offline: Property<Boolean!>!

class CommonPlugin : CommonDefaultPlugin

CommonPlugin()
fun Project.configureProject(): 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
const val STATE_ACTIVE: String
const val STATE_DISABLED: String
const val STATE_NO_CONFIG: String
const val STATE_RAW_ACTIVE: Int
const val STATE_RAW_DISABLED_OR_NO_CONFIG: Int
const val STATE_RAW_FAILED_ACTIVATION: Int
const val STATE_RAW_SATISTIED: Int
const val STATE_RAW_UNSATISFIED: Int
const 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
val platformComponents: ListProperty<String!>!
val specificComponents: ListProperty<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
fun greedy(): 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 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

abstract class DefaultAction : InstanceAction

DefaultAction(aem: AemExtension)
protected val aem: AemExtension
protected val common: CommonExtension
protected val logger: Logger!

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 DeleteResponse : HtmlResponse

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

class Downloader

Downloader(aem: AemExtension)
val clean: Property<Boolean!>!
val definition: PackageDefinition
fun definition(options: PackageDefinition.() -> Unit): Unit
fun download(): Unit
val extract: Property<Boolean!>!
val extractDir: DirectoryProperty!
val filter: Property<FilterFile!>!
val instance: Property<Instance!>!

data class ErrorPattern

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

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
val unstableAgeMillis: Property<Long!>!
val unstableTopics: ListProperty<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 FileDestination : LogDestination

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

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, dir: File, fileNames: List<String>): File?
fun find(project: Project, dirIfFileName: String, pathOrFileNames: List<String>): File?
fun find(project: Project, dir: File, pathOrFileName: 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

class FilterElement : Serializable

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
fun toString(): String
var type: FilterType

class FilterFile : Closeable

FilterFile(file: File, temporary: Boolean = false)
const val BUILD_NAME: String
fun close(): Unit
fun cmd(aem: AemExtension): FilterFile?
fun convention(aem: AemExtension): FilterFile
fun default(aem: AemExtension): FilterFile
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(aem: AemExtension, paths: List<String>): FilterFile
const val TEMPORARY_NAME: String
fun toString(): String

enum class FilterType

DIR
FILE
UNKNOWN

class GroovyConsole : InstanceService

GroovyConsole(sync: InstanceSync)
val available: Boolean
const val EVAL_PATH: String
fun evalCode(code: String, data: Map<String, Any?> = mapOf()): GroovyEvalResult
fun evalScript(file: File, data: Map<String, Any?> = mapOf()): GroovyEvalResult
fun evalScript(fileName: String, data: Map<String, Any?> = mapOf()): GroovyEvalResult
fun evalScripts(pathPattern: String = "**/*.groovy", data: Map<String, Any> = mapOf(), resultConsumer: GroovyEvalResult.() -> Unit = {}): Unit
fun evalScripts(scripts: Iterable<File>, data: Map<String, Any?> = mapOf(), resultConsumer: GroovyEvalResult.() -> Unit = {}): Unit
fun findScripts(pathPattern: String): List<File>
fun requireAvailable(): Unit
val scriptDir: DirectoryProperty!
const val SYMBOLIC_NAME: String
val verbose: Property<Boolean!>!

class GroovyConsoleException : InstanceException

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

class GroovyEvalResult

GroovyEvalResult()
lateinit var data: String
val error: Boolean
lateinit var exceptionStackTrace: String
lateinit var output: String
var result: String?
lateinit var runningTime: String
lateinit var script: String
val success: Boolean
fun toString(): String

data class GroovyEvalStatus

GroovyEvalStatus(script: File, instance: Instance, success: Boolean, error: String)
val error: String
val fail: Boolean
val instance: Instance
val script: File
val success: Boolean

data class GroovyEvalSummary

GroovyEvalSummary(statuses: List<GroovyEvalStatus>, duration: Long)
val duration: Long
val durationString: String
fun empty(): GroovyEvalSummary
val failed: Int
val statuses: List<GroovyEvalStatus>
val succeeded: Int
val succeededPercent: String
fun toString(): String
val total: Int

class GroovyEvaluator

GroovyEvaluator(aem: AemExtension)
fun console(options: GroovyConsole.() -> Unit): Unit
val data: MapProperty<String!, Any?>!
fun eval(): GroovyEvalSummary
fun evalScripts(scripts: List<File>): GroovyEvalSummary
val faulty: Property<Boolean!>!
fun findScripts(): List<File>
val instances: ListProperty<Instance!>!
val scriptDirDefault: Property<String!>!
val scriptPattern: Property<String!>!
val scriptSuffix: Property<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

enum class IdType

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

class InstallResolver

InstallResolver(aem: AemExtension)
fun files(configurer: FileResolver.() -> Unit): Unit
fun files(vararg values: Any): Unit
fun files(values: Iterable<Any>): 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

open class Instance : Serializable

Instance(aem: AemExtension)
protected val aem: AemExtension
val author: Boolean
val available: Boolean
fun awaitDown(options: AwaitDownAction.() -> Unit = {}): Unit
fun awaitReloaded(reloadOptions: ReloadAction.() -> Unit = {}, awaitUpOptions: AwaitUpAction.() -> Unit = {}): Unit
fun awaitUp(options: AwaitUpAction.() -> Unit = {}): Unit
fun check(options: CheckAction.() -> Unit): Unit
val cmd: Boolean
protected val common: CommonExtension
fun create(aem: AemExtension, httpUrl: String, configurer: Instance.() -> Unit = {}): Instance
val credentials: Pair<String, String>
val credentialsString: String
fun defaultAuthor(aem: AemExtension): Instance
fun defaultPair(aem: AemExtension): List<Instance>
fun defaultPublish(aem: AemExtension): Instance
fun defaults(aem: AemExtension, configurer: Instance.() -> Unit = {}): List<Instance>
lateinit var environment: String
const val ENVIRONMENT_CMD: String
open fun equals(other: Any?): Boolean
const val FILTER_ANY: String
val frozen: Boolean
open fun hashCode(): Int
val hiddenPassword: String
val httpBasicAuthUrl: String
val httpPort: Int
lateinit var httpUrl: String
lateinit var id: String
val json: String
val LOCAL_PROPS: List<String>
protected val logger: Logger!
val manager: InstanceManager
var name: String
fun parse(aem: AemExtension, str: String, configurer: Instance.() -> Unit = {}): List<Instance>
lateinit var password: String
const val PASSWORD_DEFAULT: String
var properties: MutableMap<String, String?>
fun properties(aem: AemExtension): List<Instance>
fun property(key: String, value: String?): Unit
fun property(key: String): String?
fun provision(): List<Action>
val publish: Boolean
fun reload(options: ReloadAction.() -> Unit = {}): Unit
val REMOTE_PROPS: List<String>
fun satisfy(): List<PackageAction>
val sync: InstanceSync
fun <T> sync(action: InstanceSync.() -> T): T
val systemProperties: Map<String, String>
fun tail(): Unit
open fun toString(): String
val type: IdType
const val URL_AUTHOR_DEFAULT: String
const val URL_PUBLISH_DEFAULT: String
open lateinit var user: String
const val USER_DEFAULT: String
fun validate(): Unit
open val version: String
val zoneId: ZoneId

interface InstanceAction

abstract fun perform(instances: Collection<Instance>): Unit

class InstanceAnalyzer

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

open class InstanceAwait : InstanceTask

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 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 InstanceGroovyEval : AemDefaultTask

InstanceGroovyEval()
fun eval(): Unit
const val NAME: String
fun options(options: GroovyEvaluator.() -> Unit): Unit

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 InstanceManager

InstanceManager(aem: AemExtension)
val aem: AemExtension
val all: Provider<Map<String, Instance!>!>!
fun awaitDown(instance: Instance, options: AwaitDownAction.() -> Unit = {}): Unit
fun awaitDown(instances: Collection<Instance>, options: AwaitDownAction.() -> Unit = {}): Unit
fun awaitReloaded(instance: Instance, reloadOptions: ReloadAction.() -> Unit = {}, awaitUpOptions: AwaitUpAction.() -> Unit = {}): Unit
fun awaitReloaded(instances: Collection<Instance>, reloadOptions: ReloadAction.() -> Unit = {}, awaitUpOptions: AwaitUpAction.() -> Unit = {}): Unit
fun awaitUp(instance: Instance, options: AwaitUpAction.() -> Unit = {}): Unit
fun awaitUp(instances: Collection<Instance>, options: AwaitUpAction.() -> Unit = {}): Unit
val buildDir: DirectoryProperty!
fun check(instance: Instance, options: CheckAction.() -> Unit): Unit
fun check(instances: Collection<Instance>, options: CheckAction.() -> Unit): Unit
val configDir: DirectoryProperty!
val defined: ListProperty<Instance!>!
fun local(httpUrl: String): Unit
fun local(httpUrl: String, name: String): Unit
fun local(httpUrl: String, options: LocalInstance.() -> Unit): Unit
fun named(name: String): Instance
fun parse(url: String): Instance
val projectDir: DirectoryProperty!
val provisioner: Provisioner
fun provisioner(options: Provisioner.() -> Unit): Unit
fun reload(instance: Instance, options: ReloadAction.() -> Unit = {}): Unit
fun reload(instances: Collection<Instance>, options: ReloadAction.() -> Unit = {}): Unit
fun remote(httpUrl: String): Unit
fun remote(httpUrl: String, name: String): Unit
fun remote(httpUrl: String, options: Instance.() -> Unit): Unit
fun resolveFiles(): Unit
val satisfier: Satisfier
fun satisfier(options: Satisfier.() -> Unit): Unit
fun sync(options: InstanceSync.() -> Unit): Unit
val tailer: Tailer
fun tailer(options: Tailer.() -> Unit): Unit

class InstancePlugin : CommonDefaultPlugin

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

open class InstanceProvision : InstanceTask

InstanceProvision()
const val NAME: String
fun provision(): Unit

open class InstanceRcp : AemDefaultTask

InstanceRcp()
const val NAME: String
fun options(configurer: RcpClient.() -> Unit): Unit
fun run(): 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 : InstanceTask

InstanceSatisfy()
const val NAME: String
fun satisfy(): Unit

open class InstanceService

InstanceService(sync: InstanceSync)
val aem: AemExtension
val common: CommonExtension
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 greedy: Boolean
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 osgi: OsgiFramework
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
val workflowManager: WorkflowManager
fun <T> workflowManager(callback: WorkflowManager.() -> T): T

open class InstanceTail : InstanceTask

InstanceTail()
const val NAME: String
fun tail(): Unit

open class InstanceTask : AemDefaultTask

InstanceTask()
val instanceManager: InstanceManager
val instances: ListProperty<Instance!>!

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

object JcrUtil

fun date(date: Date = Date()): String
fun dateToCalendar(date: Date): Calendar
fun manglePath(path: String): String

kotlin.collections.Collection

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

kotlin.collections.Collection

val Collection<File>.fileNames: String

kotlin.String

fun String.normalizeSeparators(separator: String): String
fun String.shortenClass(maxLength: Int = 32): String

enum class LineSeparator

CR
CRLF
fun find(name: String?): LineSeparator?
LF
LFCR
fun of(name: String?): LineSeparator
SYSTEM
val value: String

class ListResponse

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

class LocalInstance : Instance

fun checkStatus(): Status
fun create(): List<LocalInstance>
fun create(aem: AemExtension, httpUrl: String, configurer: LocalInstance.() -> Unit = {}): LocalInstance
val created: Boolean
var debugAddress: String
var debugPort: Int
fun destroy(): Boolean
val dir: File
fun down(): Boolean
const val ENVIRONMENT: String
const val FILES_PATH: String
val initialized: Boolean
val installDir: File
val jar: File
var jvmOpts: List<String>
val jvmOptsDefaults: List<String>
val jvmOptsString: String
val license: File
val localManager: LocalInstanceManager
const val LOCK_CREATE: String
const val LOCK_INIT: String
val overridesDirs: List<File>
val quickstartDir: File
var runModes: List<String>
val runModesDefault: List<String>
val runModesString: String
val running: Boolean
val runningDir: File?
val runningOther: Boolean
var startOpts: List<String>
val startOptsString: String
val status: Status
fun toString(): String
val touched: Boolean
fun up(): Boolean
var user: String
const val USER: String
val version: String
val versionFile: File
val windowTitle: String

open class LocalInstanceException : InstanceException

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

class LocalInstanceManager : Serializable

LocalInstanceManager(aem: AemExtension)
val backup: BackupManager
fun backup(options: BackupManager.() -> Unit): Unit
val backupZip: File?
val base: InstanceManager
val configDir: DirectoryProperty!
fun create(instance: LocalInstance): List<LocalInstance>
fun create(instances: Collection<LocalInstance>): List<LocalInstance>
fun createBySource(instances: Collection<LocalInstance>): Unit
fun createFromBackup(instances: Collection<LocalInstance>, backupZip: File): Unit
fun createFromScratch(instances: Collection<LocalInstance>): Unit
fun destroy(instance: LocalInstance): Boolean
fun destroy(instances: Collection<LocalInstance>): List<LocalInstance>
fun down(instance: LocalInstance, awaitDownOptions: AwaitDownAction.() -> Unit = {}): Boolean
fun down(instances: Collection<LocalInstance>, awaitDownOptions: AwaitDownAction.() -> Unit = {}): List<LocalInstance>
val expandFiles: ListProperty<String!>!
val expandProperties: MapProperty<String!, Any!>!
fun init(options: LocalInstance.() -> Unit): Unit
val install: InstallResolver
fun install(options: InstallResolver.() -> Unit): Unit
val overrideDir: DirectoryProperty!
val projectDir: DirectoryProperty!
val quickstart: QuickstartResolver
fun quickstart(options: QuickstartResolver.() -> Unit): Unit
fun resolveFiles(): Unit
val rootDir: DirectoryProperty!
val scriptTimeout: Property<Long!>!
val source: Property<Source!>!
fun source(name: String): Unit
val sourceFiles: ConfigurableFileCollection!
fun up(instance: LocalInstance, awaitUpOptions: AwaitUpAction.() -> Unit = {}): Boolean
fun up(instances: Collection<LocalInstance>, awaitUpOptions: AwaitUpAction.() -> Unit = {}): List<LocalInstance>

class LocalInstancePlugin : CommonDefaultPlugin

LocalInstancePlugin()
fun Project.configureProject(): Unit
const val ID: String

open class LocalInstanceTask : AemDefaultTask

LocalInstanceTask()
val instances: ListProperty<LocalInstance!>!
val localInstanceManager: LocalInstanceManager

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: Tailer)
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(project: Project)
fun excludeFile(file: Any): Unit
val excludeFiles: ConfigurableFileCollection!
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, props: Map<String, Any>? = null)
val baseName: String
fun child(name: String): Node
val children: List<Node>
fun children(): Sequence<Node>
fun copy(targetPath: String): Node
fun copyFrom(sourcePath: String): Node
fun copyTo(targetDir: String): Node
const val DAM_PATH: String
const val DAM_UPLOAD_SUFFIX: String
fun delete(): RepositoryResult
fun deleteProperties(vararg names: String): RepositoryResult
fun deleteProperties(names: Iterable<String>): RepositoryResult
fun deleteProperty(name: String): RepositoryResult
fun download(targetFilePath: String): Unit
fun download(targetFile: File): Unit
fun download(): File
fun downloadPackage(options: PackageDefinition.() -> Unit = {}): File
fun downloadTo(targetDirPath: String): File
fun downloadTo(targetDir: File): File
fun equals(other: Any?): Boolean
val exists: Boolean
fun exists(recheck: Boolean = false): Boolean
val extension: String
fun hashCode(): Int
fun hasProperties(vararg names: String): Boolean
fun hasProperties(names: Iterable<String>): Boolean
fun hasProperty(name: String): Boolean
fun import(properties: Map<String, Any?>, name: String? = null, replace: Boolean = false, replaceProperties: Boolean = false): RepositoryResult
fun import(file: File, name: String? = null, replace: Boolean = false, replaceProperties: Boolean = false): RepositoryResult
val json: String
fun move(targetPath: String, replace: Boolean = false): Node
val name: String
val parent: Node
fun parents(): Sequence<Node>
val parents: List<Node>
val path: String
val properties: Properties
enum class Property

CHILDREN
NAME
PATH
SCORE
val value: String

fun query(criteria: QueryCriteria.() -> Unit): Sequence<Node>
fun query(criteria: QueryCriteria): Sequence<Node>
fun <T> read(reader: (InputStream) -> T): T
fun reload(): Unit
fun replace(properties: Map<String, Any?>): RepositoryResult
val repository: Repository
val root: Boolean
fun save(properties: Map<String, Any?>): RepositoryResult
fun saveProperty(name: String, value: Any?): RepositoryResult
fun sibling(name: String): Node
val siblings: List<Node>
fun siblings(): Sequence<Node>
fun toString(): String
fun traverse(self: Boolean = false): Sequence<Node>
val type: String
val TYPE_UNSTRUCTURED: Pair<String, String>
fun upload(file: File): Unit
fun uploadDamAsset(file: File): Unit
fun uploadFile(file: File): Unit
fun uploadTo(file: File): Node

org.gradle.api.Project

val Project.aem: AemExtension

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 = common.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_FILE: 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 PackageAction

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

open class PackageActivate : PackageTask

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

open class PackageCompose : ZipTask, AemTask

PackageCompose()
val aem: AemExtension
val bundlePath: Property<String!>!
val bundlesInstalled: ListProperty<BundleInstalled!>!
val composedDir: File!
val composedFile: File!
val contentDir: DirectoryProperty!
protected open fun copy(): Unit
fun definition(definition: () -> Unit): Unit
val fileFilter: PackageFileFilter
fun fileFilter(configurer: PackageFileFilter.() -> Unit): Unit
var fileFilterDelegate: (CopySpec) -> Unit
fun fromBundlesInstalled(bundles: ListProperty<BundleInstalled>): Unit
fun fromDefaults(): Unit
fun fromMeta(metaDir: Any): Unit
fun fromPackagesNested(pkgs: ListProperty<PackageNested>): Unit
fun fromRoot(dir: Any): Unit
fun fromVaultHooks(dir: Any): Unit
fun installBundle(dependencyNotation: Any, options: BundleInstalledResolved.() -> Unit = {}): Unit
fun installBundleBuilt(taskPath: String, options: BundleInstalledBuilt.() -> Unit = {}): Unit
fun installBundleBuilt(task: TaskProvider<BundleCompose>, options: BundleInstalledBuilt.() -> Unit = {}): Unit
fun installBundleProject(projectPath: String, options: BundleInstalledBuilt.() -> Unit = {}): Unit
val jcrRootDir: DirectoryProperty!
fun merged(action: (PackageCompose) -> Unit): Unit
fun mergePackage(taskPath: String): Unit
fun mergePackage(task: TaskProvider<PackageCompose>): Unit
fun mergePackageProject(projectPath: String): Unit
fun merging(action: (PackageCompose) -> Unit): Unit
val metaDir: DirectoryProperty!
const val NAME: String
val nestedPath: Property<String!>!
fun nestPackage(dependencyNotation: Any, options: PackageNestedResolved.() -> Unit = {}): Unit
fun nestPackageBuilt(taskPath: String, options: PackageNestedBuilt.() -> Unit = {}): Unit
fun nestPackageBuilt(task: TaskProvider<PackageCompose>, options: PackageNestedBuilt.() -> Unit = {}): Unit
fun nestPackageProject(projectPath: String, options: PackageNestedBuilt.() -> Unit = {}): Unit
fun noDefaults(): Unit
val packagesNested: ListProperty<PackageNested!>!
open fun projectsEvaluated(): Unit
val validator: PackageValidator
fun validator(options: PackageValidator.() -> Unit): Unit
val vaultDefinition: VaultDefinition
fun vaultDefinition(options: VaultDefinition.() -> Unit): Unit
val vaultDir: DirectoryProperty!
val vaultFilterFile: RegularFileProperty!
val vaultFilterOriginFile: RegularFileProperty!
val vaultFilters: Property<Boolean!>!
val vaultHooksDir: DirectoryProperty!
val vaultNodeTypesFile: RegularFileProperty!
fun withBundlesInstalled(others: ListProperty<BundleInstalled>): Unit
fun withPackagesNested(others: ListProperty<PackageNested>): Unit
fun withVaultDefinition(other: VaultDefinition): Unit
fun withVaultFilters(file: RegularFileProperty): Unit
fun withVaultNodeTypes(file: RegularFileProperty): Unit

class PackageDefinition : VaultDefinition

PackageDefinition(aem: AemExtension)
val archiveAppendix: Property<String!>!
val archiveBaseName: Property<String!>!
val archiveClassifier: Property<String!>!
val archiveExtension: Property<String!>!
val archiveFileName: Property<String!>!
val archivePath: RegularFileProperty!
val archiveVersion: Property<String!>!
fun compose(): File
fun content(options: PackageDefinition.() -> Unit): Unit
fun copyJcrFile(file: File, path: String): Unit
fun copyMetaFiles(skipExisting: Boolean = true): Unit
val destinationDirectory: DirectoryProperty!
fun expandFiles(dir: File, filePatterns: List<String> = PackageFileFilter.EXPAND_FILES_DEFAULT): Unit
fun expandMetaFiles(filePatterns: List<String> = PackageFileFilter.EXPAND_FILES_DEFAULT): Unit
val expandProperties: MapProperty<String!, Any!>!
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 class PackageDeploy : PackageTask

PackageDeploy()
open fun deploy(): Unit
val distributed: Property<Boolean!>!
const val NAME: String

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(task: PackageCompose)
val bundleChecking: Property<BundleChecking!>!
val EXCLUDE_FILES_DEFAULT: List<String>
val excludeFiles: ListProperty<String!>!
val excluding: Property<Boolean!>!
val EXPAND_FILES_DEFAULT: List<String>
val expandFiles: ListProperty<String!>!
val expanding: Property<Boolean!>!
val expandProperties: MapProperty<String!, Any!>!
fun expandProperty(name: String, value: String): Unit
fun filter(spec: CopySpec, expandProperties: Map<String, Any> = mapOf()): Unit

class PackageGroup : FileGroup

PackageGroup(packageResolver: PackageResolver, name: String)
fun completer(callback: (Collection<Instance>) -> Unit): Unit
fun condition(predicate: (Instance) -> Boolean): Unit
protected fun createResolution(id: String, resolver: (FileResolution) -> File): FileResolution
val distributed: Property<Boolean!>!
fun finalizer(callback: InstanceSync.() -> Unit): Unit
val greedy: Property<Boolean!>!
fun initializer(callback: InstanceSync.() -> Unit): Unit
fun instanceNamed(namePattern: String): Unit
val packageResolver: PackageResolver

open class PackageInstall : PackageTask

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

class PackageManager : InstanceService

PackageManager(sync: InstanceSync)
fun activate(file: File): UploadResponse
fun activate(remotePath: String): UploadResponse
fun build(remotePath: String): BuildResponse
fun delete(file: File): DeleteResponse
fun delete(remotePath: String): DeleteResponse
fun deploy(file: File, activate: Boolean = false): Unit
fun distribute(file: File): Unit
fun download(definition: PackageDefinition.() -> Unit): File
fun download(definition: PackageDefinition): File
fun download(remotePath: String, targetFile: File = common.temporaryFile(FilenameUtils.getName(remotePath))): Unit
var downloadRetry: Retry
val errors: ListProperty<String!>!
fun find(file: File): Package?
fun find(group: String, name: String, version: String): Package?
fun get(file: File): Package
fun get(group: String, name: String, version: String): Package
const val HTML_PATH: String
fun install(file: File): InstallResponse
fun install(remotePath: String): InstallResponse
val installRecursive: Property<Boolean!>!
var installRetry: Retry
fun isSnapshot(file: File): Boolean
const val JSON_PATH: String
fun list(): ListResponse
const val LIST_JSON: String
val listRefresh: Property<Boolean!>!
var listRetry: Retry
const val PATH: String
fun purge(file: File): Unit
val responseBuffer: Property<Int!>!
val snapshots: ListProperty<String!>!
fun uninstall(file: File): UninstallResponse
fun uninstall(remotePath: String): UninstallResponse
fun upload(file: File): UploadResponse
val uploadForce: Property<Boolean!>!
var uploadRetry: Retry
val workflowToggle: MapProperty<String!, Boolean!>!

interface PackageNested : RepositoryArchive
class PackageNestedBuilt : PackageNested

PackageNestedBuilt(target: PackageCompose, task: TaskProvider<PackageCompose>)
val dirPath: Property<String!>!
val file: RegularFileProperty!
val fileName: Property<String!>!
val vaultFilter: Property<Boolean!>!

class PackageNestedResolved : PackageNested

PackageNestedResolved(target: PackageCompose, notation: Any)
val dirPath: Property<String!>!
val file: RegularFileProperty!
val fileName: Property<String!>!
val notation: Any
val vaultFilter: Property<Boolean!>!

class PackageOptions : Serializable

PackageOptions(aem: AemExtension)
val configDir: DirectoryProperty!
val contentDir: DirectoryProperty!
val installPath: Property<String!>!
val installRepository: Property<Boolean!>!
val jcrRootDir: DirectoryProperty!
val metaCommonDir: DirectoryProperty!
val storagePath: Property<String!>!
fun validator(options: PackageValidator.() -> Unit): Unit
val vltDir: DirectoryProperty!

class PackagePlugin : CommonDefaultPlugin

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

open class PackagePrepare : AemDefaultTask

PackagePrepare()
val contentDir: DirectoryProperty!
val metaDefaults: Property<Boolean!>!
val metaDir: DirectoryProperty!
val metaDirs: ConfigurableFileCollection!
const val NAME: String
fun prepare(): Unit
val vaultFilterOriginFile: RegularFileProperty!
val vaultFilterTemplateFile: RegularFileProperty!

open class PackagePurge : PackageTask

PackagePurge()
const val NAME: String
fun purge(): Unit

class PackageResolution : FileResolution

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

class PackageResolver : Resolver<PackageGroup>

PackageResolver(aem: AemExtension)
val aem: AemExtension
fun bundleDefinition(options: PackageDefinition.(BundleFile) -> Unit): Unit
val bundlePath: Property<String!>!
fun createGroup(name: String): PackageGroup

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

open class PackageSync : AemDefaultTask

PackageSync()
fun cleaner(options: Cleaner.() -> Unit): Unit
val contentDir: DirectoryProperty!
fun downloader(options: Downloader.() -> Unit): Unit
val filter: Property<FilterFile!>!
val instance: Property<Instance!>!
val mode: Property<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
val transfer: Property<Transfer!>!
fun transfer(name: String): Unit
enum class Transfer

fun of(name: String): Transfer
PACKAGE_DOWNLOAD
VLT_CHECKOUT

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

class PackageSyncPlugin : CommonDefaultPlugin

PackageSyncPlugin()
fun Project.configureProject(): Unit
const val ID: String

open class PackageTask : SyncFileTask

PackageTask()

open class PackageUninstall : PackageTask

PackageUninstall()
const val NAME: String
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: RegularFileProperty!
val cndFile: RegularFileProperty!
val cndFiles: ConfigurableFileCollection!
val cndSync: CndSync
val configDir: DirectoryProperty!
val configFiles: ConfigurableFileCollection!
val enabled: Property<Boolean!>!
val jcrNamespaces: MapProperty<String!, String!>!
val jcrPrivileges: ListProperty<String!>!
fun oakMachine(options: Builder.() -> Unit): Unit
fun perform(vararg packages: File): Unit
fun perform(packages: Iterable<File>): Unit
fun perform(packages: Collection<File>): Unit
fun planClassLoader(provider: () -> ClassLoader): Unit
val planFile: RegularFileProperty!
val planName: Property<String!>!
val reportFile: RegularFileProperty!
val severity: Property<Severity!>!
fun severity(name: String): Unit
val verbose: Property<Boolean!>!
val workDir: DirectoryProperty!

open class PackageVlt : AemDefaultTask

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

enum class PhysicalType

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

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>?
val created: Date?
val createdBy: String?
fun date(name: String): Date?
fun dates(name: String): List<Date>?
val description: String?
fun double(name: String): Double?
fun doubles(name: String): List<Double>?
val fileReference: String?
val json: String
val lastModified: Date?
val lastModifiedBy: String?
fun long(name: String): Long?
fun longs(name: String): List<Long>?
val mixinTypes: List<String>?
val node: Node
val resourceType: String?
fun string(name: String): String?
fun strings(name: String): List<String>?
val title: String?
fun toString(): String
val type: String?

class Provisioner

Provisioner(manager: InstanceManager)
val greedy: Property<Boolean!>!
val manager: InstanceManager
val path: Property<String!>!
fun provision(instance: Instance): List<Action>
fun provision(instances: Collection<Instance>): List<Action>
fun step(id: String, options: Step.() -> Unit): Unit
val stepName: Property<String!>!

open class ProvisionException : InstanceException

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

class Query

Query(repository: Repository, criteria: QueryCriteria, result: QueryResult)
val criteria: QueryCriteria
val nodes: List<Node>
fun nodeSequence(): Sequence<Node>
val repository: Repository
val result: QueryResult
fun toString(): String

class QueryCriteria : QueryParams

QueryCriteria()
fun and(paramsDefiner: QueryParams.() -> Unit): Unit
fun copy(): QueryCriteria
fun forMore(): QueryCriteria
fun fullTexts(vararg values: String, all: Boolean = false): Unit
fun fullTexts(values: Iterable<String>, all: Boolean = false): Unit
fun limit(value: Int): Unit
val limit: Int
const val LIMIT_DEFAULT: Int
fun names(vararg values: String): Unit
fun names(values: Iterable<String>): Unit
fun offset(value: Int): Unit
val offset: Int
fun or(paramsDefiner: QueryParams.() -> Unit): Unit
fun orderBy(value: String, desc: Boolean = false): Unit
fun orderByContentLastModified(desc: Boolean = true): Unit
fun orderByLastModified(desc: Boolean = true): Unit
fun orderByName(desc: Boolean = false): Unit
fun orderByPath(desc: Boolean = false): Unit
fun orderByProperty(name: String, desc: Boolean = false): Unit
fun orderByScore(desc: Boolean = true): Unit
fun paths(vararg values: String): Unit
fun paths(values: Iterable<String>): Unit
val queryString: String
fun tags(vararg values: String, all: Boolean = true): Unit
fun tags(values: Iterable<String>, all: Boolean = true): Unit
fun toString(): String
fun types(vararg values: String): Unit
fun types(values: Iterable<String>): Unit

open class QueryParams

QueryParams(enumerated: Boolean)
fun contentTag(value: String): Unit
fun damAsset(): Unit
fun damAssetContent(): Unit
fun depth(value: Int): Unit
fun file(): Unit
fun fullText(value: String, relativePath: String? = null): Unit
fun name(wildcardPattern: String): Unit
fun page(): Unit
fun pageContent(): Unit
fun param(definer: QueryParams.() -> Unit): Unit
fun path(value: String): Unit
fun property(name: String, value: String): Unit
fun propertyContains(name: String, values: Iterable<String>, all: Boolean = true): Unit
fun propertyContains(name: String, vararg values: String, all: Boolean = true): Unit
fun propertyEquals(name: String, value: String, ignoreCase: Boolean = false): Unit
fun propertyExists(name: String): Unit
fun propertyLike(name: String, value: String): Unit
fun propertyNot(name: String): Unit
fun propertyNotEquals(name: String, value: String, ignoreCase: Boolean = false): Unit
fun propertyNotExists(name: String): Unit
fun propertyWhere(name: String, value: String? = null, operation: String? = null): Unit
fun tag(value: String, property: String? = null): Unit
fun type(value: String): Unit

class QueryResult

QueryResult()
var hits: List<Map<String, Any>>
val more: Boolean
var offset: Long
var results: Long
var success: Boolean
fun toString(): String
var total: Long

class QuickstartResolver

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

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?
var workspace: String

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 : DefaultAction

ReloadAction(aem: AemExtension)
fun perform(instances: Collection<Instance>): Unit

class Repository : InstanceService

Repository(sync: InstanceSync)
val damUploads: Property<Boolean!>!
fun import(path: String, jsonFile: File): RepositoryResult
fun node(path: String): Node
fun <T> node(path: String, action: Node.() -> T): T
fun query(criteria: QueryCriteria.() -> Unit): Query
fun query(criteria: QueryCriteria): Query
const val QUERY_BUILDER_PATH: String
val responseChecks: Property<Boolean!>!
fun save(path: String, properties: Map<String, Any?>): RepositoryResult
val typeHints: Property<Boolean!>!
val verboseLogging: Property<Boolean!>!

interface RepositoryArchive : Serializable

abstract val dirPath: Property<String>
abstract val file: RegularFileProperty
abstract val fileName: Property<String>
abstract val vaultFilter: Property<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 Satisfier

Satisfier(manager: InstanceManager)
val distributed: Property<Boolean!>!
val greedy: Property<Boolean!>!
const val GROUP_CMD: String
val groupFilter: Property<String!>!
val groupValidated: Property<String!>!
const val NAME: String
fun packages(options: PackageResolver.() -> Unit): Unit
fun resolve(): List<File>
fun satisfy(instance: Instance): List<PackageAction>
fun satisfy(instances: Collection<Instance>): List<PackageAction>
val validated: Property<Boolean!>!
fun validator(options: PackageValidator.() -> Unit): Unit

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

enum class Status

ENDED
FAILED
SKIPPED

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)

class Step

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

open class SyncFileTask : AemDefaultTask

SyncFileTask()
val awaited: Property<Boolean!>!
fun awaitUp(options: AwaitUpAction.() -> Unit): Unit
fun awaitUp(): Unit
var completer: () -> Unit
val files: ConfigurableFileCollection!
var finalizer: InstanceSync.() -> Unit
var initializer: InstanceSync.() -> Unit
val instances: ListProperty<Instance!>!
fun sync(action: InstanceSync.(File) -> Unit): Unit

class Tailer

Tailer(manager: InstanceManager)
val console: Property<Boolean!>!
const val ENDPOINT_PATH: String
const val ENDPOINT_PATH_OLD: String
fun errorLogEndpoint(instance: Instance): String
val fetchInterval: Property<Long!>!
val INCIDENT_LEVELS_DEFAULT: List<String>
const val INCIDENT_OLD_DEFAULT: Long
fun incidentChecker(predicate: Log.(Instance) -> Boolean): Unit
val incidentDelay: Property<Long!>!
val incidentFilter: RegularFileProperty!
val linesChunkSize: Property<Long!>!
val lockInterval: Property<Long!>!
val logFile: String
var logFilePath: Property<String!>!
val logFilter: LogFilter
fun logFilter(options: LogFilter.() -> Unit): Unit
fun logListener(callback: Log.(Instance) -> Unit): Unit
val logStorageDir: DirectoryProperty!
val manager: InstanceManager
fun tail(instance: Instance): Unit
fun tail(instances: Collection<Instance>): Unit

class TailerException : InstanceException

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

class TimeoutCheck : DefaultCheck

TimeoutCheck(group: CheckGroup)
fun check(): Unit
val constantTime: Property<Long!>!
val stateTime: Property<Long!>!

class UnavailableCheck : DefaultCheck

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

class UnchangedCheck : DefaultCheck

UnchangedCheck(group: CheckGroup)
val awaitTime: Property<Long!>!
fun check(): Unit

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

class UrlSource : LogSource

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

class VaultApp : VaultFsApp

VaultApp(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(): VaultExecutionContext
val project: Project

class VaultClient

VaultClient(aem: AemExtension)
val aem: AemExtension
val command: Property<String!>!
val commandEffective: String
val commandProperties: MapProperty<String!, Any!>!
val contentDir: DirectoryProperty!
val contentDirEffective: File
val contentRelativePath: Property<String!>!
fun run(): VaultSummary

open class VaultDefinition

VaultDefinition(aem: AemExtension)
const val AC_HANDLING_PROPERTY: String
fun acHandling(value: Boolean): Unit
protected val common: CommonExtension
val createdBy: Property<String!>!
class Delegate

Delegate(base: VaultDefinition)
val createdBy: String?
val description: String?
val filters: Set<String>
val group: String?
val name: String?
val nodeTypeLibs: MutableList<String!>
val nodeTypeLines: MutableList<String!>
val properties: MutableMap<String!, Any!>
val version: String?

val description: Property<String!>!
val fileProperties: Map<String, Any>
fun filter(root: String, definition: FilterElement.() -> Unit = {}): Unit
fun filter(root: Provider<String>, definition: FilterElement.() -> Unit = {}): Unit
val filterElements: ListProperty<FilterElement!>!
val filterRoots: Set<String>
fun filters(vararg roots: String): Unit
fun filters(roots: Iterable<String>): Unit
fun filters(file: File): Unit
fun filters(file: RegularFileProperty, optionallyExist: Boolean = true): Unit
fun filters(provider: Provider<File>, optionallyExist: Boolean = true): Unit
val filters: Set<String>
val group: Property<String!>!
val name: Property<String!>!
val NODE_TYPES_LIB: Pattern
val nodeTypeLibs: ListProperty<String!>!
fun nodeTypeLibs(file: RegularFileProperty, optionallyExist: Boolean = true): Unit
fun nodeTypeLibs(provider: Provider<File>, optionallyExist: Boolean = true): Unit
val nodeTypeLines: ListProperty<String!>!
fun nodeTypeLines(file: RegularFileProperty, optionallyExist: Boolean = true): Unit
fun nodeTypeLines(provider: Provider<File>, optionallyExist: Boolean = true): Unit
fun nodeTypes(file: RegularFileProperty, optionallyExist: Boolean = true): Unit
fun nodeTypes(provider: Provider<File>, optionallyExist: Boolean = true): Unit
val properties: MapProperty<String!, Any!>!
fun property(name: String, value: String): Unit
const val REQUIRES_ROOT_PROPERTY: String
fun requiresRoot(value: Boolean): Unit
val version: Property<String!>!

class VaultException : AemException

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

class VaultExecutionContext : VltExecutionContext

VaultExecutionContext(app: VaultApp)
fun execute(commandLine: CommandLine): Boolean

data class VaultSummary

VaultSummary(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 repository: Repository
var restoreIntended: Property<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?

class ZipException : AemException

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

class ZipFile

ZipFile(baseFile: File)
fun addDir(sourceDir: File, options: ZipParameters.() -> Unit = {}): Unit
fun contains(fileName: String): Boolean
fun containsDir(dirName: String): Boolean
fun options(options: ZipParameters.() -> Unit): ZipParameters
fun packAll(sourceDir: File, options: ZipParameters.() -> Unit = {}): Unit
fun readFile(fileName: String): ZipInputStream
fun readFileAsText(fileName: String): String
fun unpackAll(targetDir: File): Unit
fun unpackDir(dirName: String, dir: File): Unit

package com.cognifide.gradle.aem

open class AemDefaultTask : CommonDefaultTask, AemTask

AemDefaultTask()
val aem: AemExtension

open class AemException : CommonException

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 bundle: File
fun bundleEmbed(dependencyNotation: Any, pkgs: Iterable<String>, export: Boolean = false): Unit
fun bundleEmbed(dependencyNotation: Any, vararg pkgs: String, export: Boolean = false): Unit
val bundles: List<File>
val common: CommonExtension
fun common(options: CommonOptions.() -> Unit): Unit
val commonOptions: CommonOptions
fun composePackage(definition: PackageDefinition.() -> Unit): File
val filter: FilterFile
fun filter(file: File): FilterFile
fun filter(path: String): FilterFile
fun filterInstances(nameMatcher: String = prop.string("instance.name") ?: "${commonOptions.env.get()}-*"): List<Instance>
fun findInstance(desiredName: String? = prop.string("instance.name"), defaultName: String = "${commonOptions.env.get()}-*"): Instance?
fun <T> groovyEval(options: GroovyEvaluator.() -> T): T
fun groovyEval(scriptPattern: String): GroovyEvalSummary
fun instance(options: InstanceManager.() -> Unit): Unit
fun instance(urlOrName: String): Instance
val instanceManager: InstanceManager
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>
fun localInstance(options: LocalInstanceManager.() -> Unit): LocalInstanceManager
val localInstanceManager: LocalInstanceManager
val localInstances: List<LocalInstance>
fun localInstances(consumer: LocalInstance.() -> Unit): Unit
val logger: Logger!
const val NAME: String
fun namedInstance(desiredName: String? = prop.string("instance.name"), defaultName: String = "${commonOptions.env.get()}-*"): Instance
val obj: ObjectFactory
fun of(project: Project): AemExtension
fun package(options: PackageOptions.() -> Unit): Unit
fun package(file: File): PackageFile
val package: File
val packageOptions: PackageOptions
val packages: List<File>
fun pkg(options: PackageOptions.() -> Unit): Unit
fun pkg(file: File): PackageFile
val pkg: File
val project: Project
val prop: PropertyParser
val publishInstance: Instance
val publishInstances: List<Instance>
fun publishInstances(consumer: Instance.() -> Unit): Unit
fun <T> rcp(options: RcpClient.() -> T): T
val remoteInstances: List<Instance>
fun remoteInstances(consumer: Instance.() -> Unit): Unit
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
fun validatePackage(vararg packages: File, options: PackageValidator.() -> Unit = {}): Unit
fun validatePackage(packages: Iterable<File>, options: PackageValidator.() -> Unit = {}): Unit
fun vlt(command: String): VaultSummary
fun <T> vlt(options: VaultClient.() -> T): T

class AemPlugin : Serializable

AemPlugin()
val BUILD: AemPlugin
lateinit var gradleVersion: String
const val ID: String
const val NAME: String
val NAME_WITH_VERSION: String
@Synchronized fun once(callback: AemPlugin.() -> Unit): Unit
const val PKG: String
lateinit var pluginVersion: String

interface AemTask : Task

abstract val aem: AemExtension
const val GROUP: String

org.gradle.api.Project

val Project.aem: AemExtension

package com.cognifide.gradle.aem.bundle

class BundleException : AemException

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

class BundlePlugin : CommonDefaultPlugin

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

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

open class BundleCompose : JarTask, AemTask

BundleCompose()
var activator: String?
val activatorClasses: ListProperty<String!>!
val activatorSourceSets: MapProperty<String!, String!>!
val aem: AemExtension
fun attribute(name: String, value: String?): Manifest!
fun attribute(name: String): String?
var attributes: MutableMap<String, Any?>
val attributesConvention: Property<Boolean!>!
fun bnd(vararg lines: CharSequence): Unit
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 embedPackage(dependencyNotation: Any, vararg pkgs: String, export: Boolean = false): Unit
fun embedPackage(dependencyNotation: Any, pkgs: Iterable<String>, export: Boolean = false): Unit
fun excludePackage(pkgs: Iterable<String>): Unit
fun excludePackage(vararg pkgs: String): Unit
fun exportPackage(pkgs: Iterable<String>): Unit
fun exportPackage(vararg pkgs: String): Unit
val exportPackages: ListProperty<String!>!
var fragmentHost: String?
fun hasAttribute(name: String): Boolean
fun importPackage(pkgs: Iterable<String>): Unit
fun importPackage(vararg pkgs: String): Unit
val importPackages: ListProperty<String!>!
val importPackageWildcard: Property<Boolean!>!
val installPath: Property<String!>!
val installRunMode: Property<String!>!
val javaConvention: JavaPluginConvention!
val javaPackage: Property<String!>!
val javaPackageOptions: Property<String!>!
var license: String?
const val NAME: String
fun privatePackage(pkgs: Iterable<String>): Unit
fun privatePackage(vararg pkgs: String): Unit
val privatePackages: ListProperty<String!>!
open fun projectEvaluated(): Unit
var slingModelPackages: String?
var symbolicName: String?
val vaultFilter: Property<Boolean!>!
var vendor: String?
fun wildcardPackage(pkgs: Iterable<String>): List<String>
fun wildcardPackage(vararg pkgs: String): List<String>

open class BundleInstall : BundleTask

BundleInstall()
open fun install(): Unit
const val NAME: String
val refreshPackages: Property<Boolean!>!
var retry: Retry
val start: Property<Boolean!>!
val startLevel: Property<Int!>!

open class BundleUninstall : BundleTask

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

package com.cognifide.gradle.aem.common

open class CommonOptions

CommonOptions(aem: AemExtension)
val baseName: Property<String!>!
val env: Property<String!>!
val lineSeparator: Property<LineSeparator!>!
val offline: Property<Boolean!>!

class CommonPlugin : CommonDefaultPlugin

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

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

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, dir: File, fileNames: List<String>): File?
fun find(project: Project, dirIfFileName: String, pathOrFileNames: List<String>): File?
fun find(project: Project, dir: File, pathOrFileName: 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

class ZipException : AemException

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

class ZipFile

ZipFile(baseFile: File)
fun addDir(sourceDir: File, options: ZipParameters.() -> Unit = {}): Unit
fun contains(fileName: String): Boolean
fun containsDir(dirName: String): Boolean
fun options(options: ZipParameters.() -> Unit): ZipParameters
fun packAll(sourceDir: File, options: ZipParameters.() -> Unit = {}): Unit
fun readFile(fileName: String): ZipInputStream
fun readFileAsText(fileName: String): String
fun unpackAll(targetDir: File): Unit
fun unpackDir(dirName: String, dir: File): Unit

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

enum class IdType

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

open class Instance : Serializable

Instance(aem: AemExtension)
protected val aem: AemExtension
val author: Boolean
val available: Boolean
fun awaitDown(options: AwaitDownAction.() -> Unit = {}): Unit
fun awaitReloaded(reloadOptions: ReloadAction.() -> Unit = {}, awaitUpOptions: AwaitUpAction.() -> Unit = {}): Unit
fun awaitUp(options: AwaitUpAction.() -> Unit = {}): Unit
fun check(options: CheckAction.() -> Unit): Unit
val cmd: Boolean
protected val common: CommonExtension
fun create(aem: AemExtension, httpUrl: String, configurer: Instance.() -> Unit = {}): Instance
val credentials: Pair<String, String>
val credentialsString: String
fun defaultAuthor(aem: AemExtension): Instance
fun defaultPair(aem: AemExtension): List<Instance>
fun defaultPublish(aem: AemExtension): Instance
fun defaults(aem: AemExtension, configurer: Instance.() -> Unit = {}): List<Instance>
lateinit var environment: String
const val ENVIRONMENT_CMD: String
open fun equals(other: Any?): Boolean
const val FILTER_ANY: String
val frozen: Boolean
open fun hashCode(): Int
val hiddenPassword: String
val httpBasicAuthUrl: String
val httpPort: Int
lateinit var httpUrl: String
lateinit var id: String
val json: String
val LOCAL_PROPS: List<String>
protected val logger: Logger!
val manager: InstanceManager
var name: String
fun parse(aem: AemExtension, str: String, configurer: Instance.() -> Unit = {}): List<Instance>
lateinit var password: String
const val PASSWORD_DEFAULT: String
var properties: MutableMap<String, String?>
fun properties(aem: AemExtension): List<Instance>
fun property(key: String, value: String?): Unit
fun property(key: String): String?
fun provision(): List<Action>
val publish: Boolean
fun reload(options: ReloadAction.() -> Unit = {}): Unit
val REMOTE_PROPS: List<String>
fun satisfy(): List<PackageAction>
val sync: InstanceSync
fun <T> sync(action: InstanceSync.() -> T): T
val systemProperties: Map<String, String>
fun tail(): Unit
open fun toString(): String
val type: IdType
const val URL_AUTHOR_DEFAULT: String
const val URL_PUBLISH_DEFAULT: String
open lateinit var user: String
const val USER_DEFAULT: String
fun validate(): Unit
open val version: String
val zoneId: ZoneId

interface InstanceAction

abstract fun perform(instances: Collection<Instance>): 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 InstanceManager

InstanceManager(aem: AemExtension)
val aem: AemExtension
val all: Provider<Map<String, Instance!>!>!
fun awaitDown(instance: Instance, options: AwaitDownAction.() -> Unit = {}): Unit
fun awaitDown(instances: Collection<Instance>, options: AwaitDownAction.() -> Unit = {}): Unit
fun awaitReloaded(instance: Instance, reloadOptions: ReloadAction.() -> Unit = {}, awaitUpOptions: AwaitUpAction.() -> Unit = {}): Unit
fun awaitReloaded(instances: Collection<Instance>, reloadOptions: ReloadAction.() -> Unit = {}, awaitUpOptions: AwaitUpAction.() -> Unit = {}): Unit
fun awaitUp(instance: Instance, options: AwaitUpAction.() -> Unit = {}): Unit
fun awaitUp(instances: Collection<Instance>, options: AwaitUpAction.() -> Unit = {}): Unit
val buildDir: DirectoryProperty!
fun check(instance: Instance, options: CheckAction.() -> Unit): Unit
fun check(instances: Collection<Instance>, options: CheckAction.() -> Unit): Unit
val configDir: DirectoryProperty!
val defined: ListProperty<Instance!>!
fun local(httpUrl: String): Unit
fun local(httpUrl: String, name: String): Unit
fun local(httpUrl: String, options: LocalInstance.() -> Unit): Unit
fun named(name: String): Instance
fun parse(url: String): Instance
val projectDir: DirectoryProperty!
val provisioner: Provisioner
fun provisioner(options: Provisioner.() -> Unit): Unit
fun reload(instance: Instance, options: ReloadAction.() -> Unit = {}): Unit
fun reload(instances: Collection<Instance>, options: ReloadAction.() -> Unit = {}): Unit
fun remote(httpUrl: String): Unit
fun remote(httpUrl: String, name: String): Unit
fun remote(httpUrl: String, options: Instance.() -> Unit): Unit
fun resolveFiles(): Unit
val satisfier: Satisfier
fun satisfier(options: Satisfier.() -> Unit): Unit
fun sync(options: InstanceSync.() -> Unit): Unit
val tailer: Tailer
fun tailer(options: Tailer.() -> Unit): Unit

open class InstanceService

InstanceService(sync: InstanceSync)
val aem: AemExtension
val common: CommonExtension
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 osgi: OsgiFramework
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
val 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>.check(): Unit
fun Collection<Instance>.checkAvailable(): Unit
fun Collection<LocalInstance>.checkRunningOther(): Unit
val Collection<Instance>.names: String

class LocalInstance : Instance

fun checkStatus(): Status
fun create(): List<LocalInstance>
fun create(aem: AemExtension, httpUrl: String, configurer: LocalInstance.() -> Unit = {}): LocalInstance
val created: Boolean
var debugAddress: String
var debugPort: Int
fun destroy(): Boolean
val dir: File
fun down(): Boolean
const val ENVIRONMENT: String
const val FILES_PATH: String
val initialized: Boolean
val installDir: File
val jar: File
var jvmOpts: List<String>
val jvmOptsDefaults: List<String>
val jvmOptsString: String
val license: File
val localManager: LocalInstanceManager
const val LOCK_CREATE: String
const val LOCK_INIT: String
val overridesDirs: List<File>
val quickstartDir: File
var runModes: List<String>
val runModesDefault: List<String>
val runModesString: String
val running: Boolean
val runningDir: File?
val runningOther: Boolean
var startOpts: List<String>
val startOptsString: String
val status: Status
fun toString(): String
val touched: Boolean
fun up(): Boolean
var user: String
const val USER: String
val version: String
val versionFile: File
val windowTitle: String

open class LocalInstanceException : InstanceException

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

class LocalInstanceManager : Serializable

LocalInstanceManager(aem: AemExtension)
val backup: BackupManager
fun backup(options: BackupManager.() -> Unit): Unit
val backupZip: File?
val base: InstanceManager
val configDir: DirectoryProperty!
fun create(instance: LocalInstance): List<LocalInstance>
fun create(instances: Collection<LocalInstance>): List<LocalInstance>
fun createBySource(instances: Collection<LocalInstance>): Unit
fun createFromBackup(instances: Collection<LocalInstance>, backupZip: File): Unit
fun createFromScratch(instances: Collection<LocalInstance>): Unit
fun destroy(instance: LocalInstance): Boolean
fun destroy(instances: Collection<LocalInstance>): List<LocalInstance>
fun down(instance: LocalInstance, awaitDownOptions: AwaitDownAction.() -> Unit = {}): Boolean
fun down(instances: Collection<LocalInstance>, awaitDownOptions: AwaitDownAction.() -> Unit = {}): List<LocalInstance>
val expandFiles: ListProperty<String!>!
val expandProperties: MapProperty<String!, Any!>!
fun init(options: LocalInstance.() -> Unit): Unit
val install: InstallResolver
fun install(options: InstallResolver.() -> Unit): Unit
val overrideDir: DirectoryProperty!
val projectDir: DirectoryProperty!
val quickstart: QuickstartResolver
fun quickstart(options: QuickstartResolver.() -> Unit): Unit
fun resolveFiles(): Unit
val rootDir: DirectoryProperty!
val scriptTimeout: Property<Long!>!
val source: Property<Source!>!
fun source(name: String): Unit
val sourceFiles: ConfigurableFileCollection!
fun up(instance: LocalInstance, awaitUpOptions: AwaitUpAction.() -> Unit = {}): Boolean
fun up(instances: Collection<LocalInstance>, awaitUpOptions: AwaitUpAction.() -> Unit = {}): List<LocalInstance>

enum class PhysicalType

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

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

class AwaitDownAction : DefaultAction

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

class AwaitUpAction : DefaultAction

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

class CheckAction : DefaultAction

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

abstract class DefaultAction : InstanceAction

DefaultAction(aem: AemExtension)
protected val aem: AemExtension
protected val common: CommonExtension
protected val logger: Logger!

class ReloadAction : DefaultAction

ReloadAction(aem: AemExtension)
fun perform(instances: Collection<Instance>): Unit

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

class BundlesCheck : DefaultCheck

BundlesCheck(group: CheckGroup)
fun check(): Unit
val symbolicNamesIgnored: ListProperty<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 status: String
val statusLogger: CollectingLogger
val summary: String

class CheckProgress

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

class CheckRunner

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

class ComponentsCheck : DefaultCheck

ComponentsCheck(group: CheckGroup)
fun check(): Unit
val platformComponents: ListProperty<String!>!
val specificComponents: ListProperty<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
val unstableAgeMillis: Property<Long!>!
val unstableTopics: ListProperty<String!>!

class TimeoutCheck : DefaultCheck

TimeoutCheck(group: CheckGroup)
fun check(): Unit
val constantTime: Property<Long!>!
val stateTime: Property<Long!>!

class UnavailableCheck : DefaultCheck

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

class UnchangedCheck : DefaultCheck

UnchangedCheck(group: CheckGroup)
val awaitTime: Property<Long!>!
fun check(): Unit

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

class BackupManager

BackupManager(aem: AemExtension)
val any: File?
fun create(instances: Collection<LocalInstance>): File
fun create(file: File, instances: Collection<LocalInstance>): Unit
val downloadUrl: Property<String!>!
val local: File?
val localDir: DirectoryProperty!
val namedFile: File
fun namer(provider: () -> String): Unit
const val OUTPUT_DIR: String
val remote: File?
val remoteDir: DirectoryProperty!
fun restore(backupZip: File, rootDir: File, instances: Collection<LocalInstance>): Unit
fun selector(selector: Collection<BackupSource>.() -> BackupSource?): Unit
val suffix: Property<String!>!
const val SUFFIX_DEFAULT: String
fun upload(backupZip: File, verbose: Boolean): Boolean
val uploadUrl: Property<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

val dirName: String
LOCAL
REMOTE

class InstallResolver

InstallResolver(aem: AemExtension)
fun files(configurer: FileResolver.() -> Unit): Unit
fun files(vararg values: Any): Unit
fun files(values: Iterable<Any>): Unit
val files: List<File>

class QuickstartResolver

QuickstartResolver(aem: AemExtension)
val downloadDir: DirectoryProperty!
val files: List<File>
val jar: File?
val jarUrl: Property<String!>!
val license: File?
val licenseUrl: Property<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.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
fun greedy(): 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 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 greedy: Boolean
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(manager: InstanceManager)
val greedy: Property<Boolean!>!
val manager: InstanceManager
val path: Property<String!>!
fun provision(instance: Instance): List<Action>
fun provision(instances: Collection<Instance>): List<Action>
fun step(id: String, options: Step.() -> Unit): Unit
val stepName: Property<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
val continueOnFail: Property<Boolean!>!
var description: String?
val id: String
val provisioner: Provisioner
val rerunOnFail: Property<Boolean!>!
var retry: Retry
fun retry(options: Retry.() -> Unit): Unit
fun sync(callback: InstanceSync.() -> Unit): Unit
fun toString(): String
fun validate(): Unit

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

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?
var workspace: String

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.common.instance.satisfy

class PackageAction

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

class PackageGroup : FileGroup

PackageGroup(packageResolver: PackageResolver, name: String)
fun completer(callback: (Collection<Instance>) -> Unit): Unit
fun condition(predicate: (Instance) -> Boolean): Unit
protected fun createResolution(id: String, resolver: (FileResolution) -> File): FileResolution
val distributed: Property<Boolean!>!
fun finalizer(callback: InstanceSync.() -> Unit): Unit
val greedy: Property<Boolean!>!
fun initializer(callback: InstanceSync.() -> Unit): Unit
fun instanceNamed(namePattern: String): Unit
val packageResolver: PackageResolver

class PackageResolution : FileResolution

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

class PackageResolver : Resolver<PackageGroup>

PackageResolver(aem: AemExtension)
val aem: AemExtension
fun bundleDefinition(options: PackageDefinition.(BundleFile) -> Unit): Unit
val bundlePath: Property<String!>!
fun createGroup(name: String): PackageGroup

class Satisfier

Satisfier(manager: InstanceManager)
val distributed: Property<Boolean!>!
val greedy: Property<Boolean!>!
const val GROUP_CMD: String
val groupFilter: Property<String!>!
val groupValidated: Property<String!>!
const val NAME: String
fun packages(options: PackageResolver.() -> Unit): Unit
fun resolve(): List<File>
fun satisfy(instance: Instance): List<PackageAction>
fun satisfy(instances: Collection<Instance>): List<PackageAction>
val validated: Property<Boolean!>!
fun validator(options: PackageValidator.() -> Unit): Unit

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)
val available: Boolean
const val EVAL_PATH: String
fun evalCode(code: String, data: Map<String, Any?> = mapOf()): GroovyEvalResult
fun evalScript(file: File, data: Map<String, Any?> = mapOf()): GroovyEvalResult
fun evalScript(fileName: String, data: Map<String, Any?> = mapOf()): GroovyEvalResult
fun evalScripts(pathPattern: String = "**/*.groovy", data: Map<String, Any> = mapOf(), resultConsumer: GroovyEvalResult.() -> Unit = {}): Unit
fun evalScripts(scripts: Iterable<File>, data: Map<String, Any?> = mapOf(), resultConsumer: GroovyEvalResult.() -> Unit = {}): Unit
fun findScripts(pathPattern: String): List<File>
fun requireAvailable(): Unit
val scriptDir: DirectoryProperty!
const val SYMBOLIC_NAME: String
val verbose: Property<Boolean!>!

class GroovyConsoleException : InstanceException

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

class GroovyEvalResult

GroovyEvalResult()
lateinit var data: String
val error: Boolean
lateinit var exceptionStackTrace: String
lateinit var output: String
var result: String?
lateinit var runningTime: String
lateinit var script: String
val success: Boolean
fun toString(): String

data class GroovyEvalStatus

GroovyEvalStatus(script: File, instance: Instance, success: Boolean, error: String)
val error: String
val fail: Boolean
val instance: Instance
val script: File
val success: Boolean

data class GroovyEvalSummary

GroovyEvalSummary(statuses: List<GroovyEvalStatus>, duration: Long)
val duration: Long
val durationString: String
fun empty(): GroovyEvalSummary
val failed: Int
val statuses: List<GroovyEvalStatus>
val succeeded: Int
val succeededPercent: String
fun toString(): String
val total: Int

class GroovyEvaluator

GroovyEvaluator(aem: AemExtension)
fun console(options: GroovyConsole.() -> Unit): Unit
val data: MapProperty<String!, Any?>!
fun eval(): GroovyEvalSummary
fun evalScripts(scripts: List<File>): GroovyEvalSummary
val faulty: Property<Boolean!>!
fun findScripts(): List<File>
val instances: ListProperty<Instance!>!
val scriptDirDefault: Property<String!>!
val scriptPattern: Property<String!>!
val scriptSuffix: Property<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
const val STATE_ACTIVE: String
const val STATE_DISABLED: String
const val STATE_NO_CONFIG: String
const val STATE_RAW_ACTIVE: Int
const val STATE_RAW_DISABLED_OR_NO_CONFIG: Int
const val STATE_RAW_FAILED_ACTIVATION: Int
const val STATE_RAW_SATISTIED: Int
const val STATE_RAW_UNSATISFIED: Int
const 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 = common.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_FILE: 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(file: File): UploadResponse
fun activate(remotePath: String): UploadResponse
fun build(remotePath: String): BuildResponse
fun delete(file: File): DeleteResponse
fun delete(remotePath: String): DeleteResponse
fun deploy(file: File, activate: Boolean = false): Unit
fun distribute(file: File): Unit
fun download(definition: PackageDefinition.() -> Unit): File
fun download(definition: PackageDefinition): File
fun download(remotePath: String, targetFile: File = common.temporaryFile(FilenameUtils.getName(remotePath))): Unit
var downloadRetry: Retry
val errors: ListProperty<String!>!
fun find(file: File): Package?
fun find(group: String, name: String, version: String): Package?
fun get(file: File): Package
fun get(group: String, name: String, version: String): Package
const val HTML_PATH: String
fun install(file: File): InstallResponse
fun install(remotePath: String): InstallResponse
val installRecursive: Property<Boolean!>!
var installRetry: Retry
fun isSnapshot(file: File): Boolean
const val JSON_PATH: String
fun list(): ListResponse
const val LIST_JSON: String
val listRefresh: Property<Boolean!>!
var listRetry: Retry
const val PATH: String
fun purge(file: File): Unit
val responseBuffer: Property<Int!>!
val snapshots: ListProperty<String!>!
fun uninstall(file: File): UninstallResponse
fun uninstall(remotePath: String): UninstallResponse
fun upload(file: File): UploadResponse
val uploadForce: Property<Boolean!>!
var uploadRetry: Retry
val workflowToggle: MapProperty<String!, Boolean!>!

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, props: Map<String, Any>? = null)
val baseName: String
fun child(name: String): Node
val children: List<Node>
fun children(): Sequence<Node>
fun copy(targetPath: String): Node
fun copyFrom(sourcePath: String): Node
fun copyTo(targetDir: String): Node
const val DAM_PATH: String
const val DAM_UPLOAD_SUFFIX: String
fun delete(): RepositoryResult
fun deleteProperties(vararg names: String): RepositoryResult
fun deleteProperties(names: Iterable<String>): RepositoryResult
fun deleteProperty(name: String): RepositoryResult
fun download(targetFilePath: String): Unit
fun download(targetFile: File): Unit
fun download(): File
fun downloadPackage(options: PackageDefinition.() -> Unit = {}): File
fun downloadTo(targetDirPath: String): File
fun downloadTo(targetDir: File): File
fun equals(other: Any?): Boolean
val exists: Boolean
fun exists(recheck: Boolean = false): Boolean
val extension: String
fun hashCode(): Int
fun hasProperties(vararg names: String): Boolean
fun hasProperties(names: Iterable<String>): Boolean
fun hasProperty(name: String): Boolean
fun import(properties: Map<String, Any?>, name: String? = null, replace: Boolean = false, replaceProperties: Boolean = false): RepositoryResult
fun import(file: File, name: String? = null, replace: Boolean = false, replaceProperties: Boolean = false): RepositoryResult
val json: String
fun move(targetPath: String, replace: Boolean = false): Node
val name: String
val parent: Node
fun parents(): Sequence<Node>
val parents: List<Node>
val path: String
val properties: Properties
enum class Property

CHILDREN
NAME
PATH
SCORE
val value: String

fun query(criteria: QueryCriteria.() -> Unit): Sequence<Node>
fun query(criteria: QueryCriteria): Sequence<Node>
fun <T> read(reader: (InputStream) -> T): T
fun reload(): Unit
fun replace(properties: Map<String, Any?>): RepositoryResult
val repository: Repository
val root: Boolean
fun save(properties: Map<String, Any?>): RepositoryResult
fun saveProperty(name: String, value: Any?): RepositoryResult
fun sibling(name: String): Node
val siblings: List<Node>
fun siblings(): Sequence<Node>
fun toString(): String
fun traverse(self: Boolean = false): Sequence<Node>
val type: String
val TYPE_UNSTRUCTURED: Pair<String, String>
fun upload(file: File): Unit
fun uploadDamAsset(file: File): Unit
fun uploadFile(file: File): Unit
fun uploadTo(file: File): Node

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>?
val created: Date?
val createdBy: String?
fun date(name: String): Date?
fun dates(name: String): List<Date>?
val description: String?
fun double(name: String): Double?
fun doubles(name: String): List<Double>?
val fileReference: String?
val json: String
val lastModified: Date?
val lastModifiedBy: String?
fun long(name: String): Long?
fun longs(name: String): List<Long>?
val mixinTypes: List<String>?
val node: Node
val resourceType: String?
fun string(name: String): String?
fun strings(name: String): List<String>?
val title: String?
fun toString(): String
val type: String?

class Query

Query(repository: Repository, criteria: QueryCriteria, result: QueryResult)
val criteria: QueryCriteria
val nodes: List<Node>
fun nodeSequence(): Sequence<Node>
val repository: Repository
val result: QueryResult
fun toString(): String

class QueryCriteria : QueryParams

QueryCriteria()
fun and(paramsDefiner: QueryParams.() -> Unit): Unit
fun copy(): QueryCriteria
fun forMore(): QueryCriteria
fun fullTexts(vararg values: String, all: Boolean = false): Unit
fun fullTexts(values: Iterable<String>, all: Boolean = false): Unit
fun limit(value: Int): Unit
val limit: Int
const val LIMIT_DEFAULT: Int
fun names(vararg values: String): Unit
fun names(values: Iterable<String>): Unit
fun offset(value: Int): Unit
val offset: Int
fun or(paramsDefiner: QueryParams.() -> Unit): Unit
fun orderBy(value: String, desc: Boolean = false): Unit
fun orderByContentLastModified(desc: Boolean = true): Unit
fun orderByLastModified(desc: Boolean = true): Unit
fun orderByName(desc: Boolean = false): Unit
fun orderByPath(desc: Boolean = false): Unit
fun orderByProperty(name: String, desc: Boolean = false): Unit
fun orderByScore(desc: Boolean = true): Unit
fun paths(vararg values: String): Unit
fun paths(values: Iterable<String>): Unit
val queryString: String
fun tags(vararg values: String, all: Boolean = true): Unit
fun tags(values: Iterable<String>, all: Boolean = true): Unit
fun toString(): String
fun types(vararg values: String): Unit
fun types(values: Iterable<String>): Unit

open class QueryParams

QueryParams(enumerated: Boolean)
fun contentTag(value: String): Unit
fun damAsset(): Unit
fun damAssetContent(): Unit
fun depth(value: Int): Unit
fun file(): Unit
fun fullText(value: String, relativePath: String? = null): Unit
fun name(wildcardPattern: String): Unit
fun page(): Unit
fun pageContent(): Unit
fun param(definer: QueryParams.() -> Unit): Unit
fun path(value: String): Unit
fun property(name: String, value: String): Unit
fun propertyContains(name: String, values: Iterable<String>, all: Boolean = true): Unit
fun propertyContains(name: String, vararg values: String, all: Boolean = true): Unit
fun propertyEquals(name: String, value: String, ignoreCase: Boolean = false): Unit
fun propertyExists(name: String): Unit
fun propertyLike(name: String, value: String): Unit
fun propertyNot(name: String): Unit
fun propertyNotEquals(name: String, value: String, ignoreCase: Boolean = false): Unit
fun propertyNotExists(name: String): Unit
fun propertyWhere(name: String, value: String? = null, operation: String? = null): Unit
fun tag(value: String, property: String? = null): Unit
fun type(value: String): Unit

class QueryResult

QueryResult()
var hits: List<Map<String, Any>>
val more: Boolean
var offset: Long
var results: Long
var success: Boolean
fun toString(): String
var total: Long

class Repository : InstanceService

Repository(sync: InstanceSync)
val damUploads: Property<Boolean!>!
fun import(path: String, jsonFile: File): RepositoryResult
fun node(path: String): Node
fun <T> node(path: String, action: Node.() -> T): T
fun query(criteria: QueryCriteria.() -> Unit): Query
fun query(criteria: QueryCriteria): Query
const val QUERY_BUILDER_PATH: String
val responseChecks: Property<Boolean!>!
fun save(path: String, properties: Map<String, Any?>): RepositoryResult
val typeHints: Property<Boolean!>!
val verboseLogging: Property<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 repository: Repository
var restoreIntended: Property<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.instance.tail

class InstanceAnalyzer

InstanceAnalyzer(tailer: Tailer, 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

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(project: Project)
fun excludeFile(file: Any): Unit
val excludeFiles: ConfigurableFileCollection!
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 Tailer

Tailer(manager: InstanceManager)
val console: Property<Boolean!>!
const val ENDPOINT_PATH: String
const val ENDPOINT_PATH_OLD: String
fun errorLogEndpoint(instance: Instance): String
val fetchInterval: Property<Long!>!
val INCIDENT_LEVELS_DEFAULT: List<String>
const val INCIDENT_OLD_DEFAULT: Long
fun incidentChecker(predicate: Log.(Instance) -> Boolean): Unit
val incidentDelay: Property<Long!>!
val incidentFilter: RegularFileProperty!
val linesChunkSize: Property<Long!>!
val lockInterval: Property<Long!>!
val logFile: String
var logFilePath: Property<String!>!
val logFilter: LogFilter
fun logFilter(options: LogFilter.() -> Unit): Unit
fun logListener(callback: Log.(Instance) -> Unit): Unit
val logStorageDir: DirectoryProperty!
val manager: InstanceManager
fun tail(instance: Instance): Unit
fun tail(instances: Collection<Instance>): Unit

class TailerException : InstanceException

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

package com.cognifide.gradle.aem.common.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: Tailer)
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: Tailer, instance: Instance)
fun <T> readChunk(parser: (BufferedReader) -> List<T>): List<T>

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

enum class BundleChecking

EXCLUDE
FAIL
NONE
fun of(name: String): BundleChecking
WARN

class PackageDefinition : VaultDefinition

PackageDefinition(aem: AemExtension)
val archiveAppendix: Property<String!>!
val archiveBaseName: Property<String!>!
val archiveClassifier: Property<String!>!
val archiveExtension: Property<String!>!
val archiveFileName: Property<String!>!
val archivePath: RegularFileProperty!
val archiveVersion: Property<String!>!
fun compose(): File
fun content(options: PackageDefinition.() -> Unit): Unit
fun copyJcrFile(file: File, path: String): Unit
fun copyMetaFiles(skipExisting: Boolean = true): Unit
val destinationDirectory: DirectoryProperty!
fun expandFiles(dir: File, filePatterns: List<String> = PackageFileFilter.EXPAND_FILES_DEFAULT): Unit
fun expandMetaFiles(filePatterns: List<String> = PackageFileFilter.EXPAND_FILES_DEFAULT): Unit
val expandProperties: MapProperty<String!, Any!>!
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(task: PackageCompose)
val bundleChecking: Property<BundleChecking!>!
val EXCLUDE_FILES_DEFAULT: List<String>
val excludeFiles: ListProperty<String!>!
val excluding: Property<Boolean!>!
val EXPAND_FILES_DEFAULT: List<String>
val expandFiles: ListProperty<String!>!
val expanding: Property<Boolean!>!
val expandProperties: MapProperty<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)
val configDir: DirectoryProperty!
val contentDir: DirectoryProperty!
val installPath: Property<String!>!
val installRepository: Property<Boolean!>!
val jcrRootDir: DirectoryProperty!
val metaCommonDir: DirectoryProperty!
val storagePath: Property<String!>!
fun validator(options: PackageValidator.() -> Unit): Unit
val vltDir: DirectoryProperty!

class PackageValidator

PackageValidator(aem: AemExtension)
val aem: AemExtension
fun base(value: Any): Unit
fun base(provider: () -> File): Unit
val baseFile: RegularFileProperty!
val cndFile: RegularFileProperty!
val cndFiles: ConfigurableFileCollection!
val cndSync: CndSync
val configDir: DirectoryProperty!
val configFiles: ConfigurableFileCollection!
val enabled: Property<Boolean!>!
val jcrNamespaces: MapProperty<String!, String!>!
val jcrPrivileges: ListProperty<String!>!
fun oakMachine(options: Builder.() -> Unit): Unit
fun perform(vararg packages: File): Unit
fun perform(packages: Iterable<File>): Unit
fun perform(packages: Collection<File>): Unit
fun planClassLoader(provider: () -> ClassLoader): Unit
val planFile: RegularFileProperty!
val planName: Property<String!>!
val reportFile: RegularFileProperty!
val severity: Property<Severity!>!
fun severity(name: String): Unit
val verbose: Property<Boolean!>!
val workDir: DirectoryProperty!

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

class CndSync

CndSync(aem: AemExtension)
val file: RegularFileProperty!
fun sync(): Unit
val type: Property<CndSyncType!>!
fun type(name: String): Unit

enum class CndSyncType

ALWAYS
fun find(name: String): CndSyncType?
NEVER
fun of(name: String): CndSyncType
PRESERVE

class FilterElement : Serializable

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
fun toString(): String
var type: FilterType

class FilterFile : Closeable

FilterFile(file: File, temporary: Boolean = false)
const val BUILD_NAME: String
fun close(): Unit
fun cmd(aem: AemExtension): FilterFile?
fun convention(aem: AemExtension): FilterFile
fun default(aem: AemExtension): FilterFile
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(aem: AemExtension, paths: List<String>): FilterFile
const val TEMPORARY_NAME: String
fun toString(): String

enum class FilterType

DIR
FILE
UNKNOWN

class VaultApp : VaultFsApp

VaultApp(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(): VaultExecutionContext
val project: Project

class VaultClient

VaultClient(aem: AemExtension)
val aem: AemExtension
val command: Property<String!>!
val commandEffective: String
val commandProperties: MapProperty<String!, Any!>!
val contentDir: DirectoryProperty!
val contentDirEffective: File
val contentRelativePath: Property<String!>!
fun run(): VaultSummary

open class VaultDefinition

VaultDefinition(aem: AemExtension)
const val AC_HANDLING_PROPERTY: String
fun acHandling(value: Boolean): Unit
protected val common: CommonExtension
val createdBy: Property<String!>!
class Delegate

Delegate(base: VaultDefinition)
val createdBy: String?
val description: String?
val filters: Set<String>
val group: String?
val name: String?
val nodeTypeLibs: MutableList<String!>
val nodeTypeLines: MutableList<String!>
val properties: MutableMap<String!, Any!>
val version: String?

val description: Property<String!>!
val fileProperties: Map<String, Any>
fun filter(root: String, definition: FilterElement.() -> Unit = {}): Unit
fun filter(root: Provider<String>, definition: FilterElement.() -> Unit = {}): Unit
val filterElements: ListProperty<FilterElement!>!
val filterRoots: Set<String>
fun filters(vararg roots: String): Unit
fun filters(roots: Iterable<String>): Unit
fun filters(file: File): Unit
fun filters(file: RegularFileProperty, optionallyExist: Boolean = true): Unit
fun filters(provider: Provider<File>, optionallyExist: Boolean = true): Unit
val filters: Set<String>
val group: Property<String!>!
val name: Property<String!>!
val NODE_TYPES_LIB: Pattern
val nodeTypeLibs: ListProperty<String!>!
fun nodeTypeLibs(file: RegularFileProperty, optionallyExist: Boolean = true): Unit
fun nodeTypeLibs(provider: Provider<File>, optionallyExist: Boolean = true): Unit
val nodeTypeLines: ListProperty<String!>!
fun nodeTypeLines(file: RegularFileProperty, optionallyExist: Boolean = true): Unit
fun nodeTypeLines(provider: Provider<File>, optionallyExist: Boolean = true): Unit
fun nodeTypes(file: RegularFileProperty, optionallyExist: Boolean = true): Unit
fun nodeTypes(provider: Provider<File>, optionallyExist: Boolean = true): Unit
val properties: MapProperty<String!, Any!>!
fun property(name: String, value: String): Unit
const val REQUIRES_ROOT_PROPERTY: String
fun requiresRoot(value: Boolean): Unit
val version: Property<String!>!

class VaultException : AemException

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

class VaultExecutionContext : VltExecutionContext

VaultExecutionContext(app: VaultApp)
fun execute(commandLine: CommandLine): Boolean

data class VaultSummary

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

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

open class BundleTask : SyncFileTask

BundleTask()

open class InstanceTask : AemDefaultTask

InstanceTask()
val instanceManager: InstanceManager
val instances: ListProperty<Instance!>!

open class LocalInstanceTask : AemDefaultTask

LocalInstanceTask()
val instances: ListProperty<LocalInstance!>!
val localInstanceManager: LocalInstanceManager

open class PackageTask : SyncFileTask

PackageTask()

open class SyncFileTask : AemDefaultTask

SyncFileTask()
val awaited: Property<Boolean!>!
fun awaitUp(options: AwaitUpAction.() -> Unit): Unit
fun awaitUp(): Unit
var completer: () -> Unit
val files: ConfigurableFileCollection!
var finalizer: InstanceSync.() -> Unit
var initializer: InstanceSync.() -> Unit
val instances: ListProperty<Instance!>!
fun sync(action: InstanceSync.(File) -> Unit): Unit

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

object JcrUtil

fun date(date: Date = Date()): String
fun dateToCalendar(date: Date): Calendar
fun manglePath(path: String): String

kotlin.collections.Collection

val Collection<File>.fileNames: String

kotlin.String

fun String.normalizeSeparators(separator: String): String
fun String.shortenClass(maxLength: Int = 32): String

enum class LineSeparator

CR
CRLF
fun find(name: String?): LineSeparator?
LF
LFCR
fun of(name: String?): LineSeparator
SYSTEM
val value: String

package com.cognifide.gradle.aem.instance

class InstancePlugin : CommonDefaultPlugin

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

class LocalInstancePlugin : CommonDefaultPlugin

LocalInstancePlugin()
fun Project.configureProject(): Unit
const val ID: String

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

open class InstanceAwait : InstanceTask

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 class InstanceDown : LocalInstanceTask

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

open class InstanceGroovyEval : AemDefaultTask

InstanceGroovyEval()
fun eval(): Unit
const val NAME: String
fun options(options: GroovyEvaluator.() -> Unit): Unit

open class InstanceProvision : InstanceTask

InstanceProvision()
const val NAME: String
fun provision(): Unit

open class InstanceRcp : AemDefaultTask

InstanceRcp()
const val NAME: String
fun options(configurer: RcpClient.() -> Unit): Unit
fun run(): 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 : InstanceTask

InstanceSatisfy()
const val NAME: String
fun satisfy(): Unit

open class InstanceSetup : AemDefaultTask

InstanceSetup()
const val NAME: String

open class InstanceTail : InstanceTask

InstanceTail()
const val NAME: String
fun tail(): Unit

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 : CommonDefaultPlugin

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

class PackageSyncPlugin : CommonDefaultPlugin

PackageSyncPlugin()
fun Project.configureProject(): 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, AemTask

PackageCompose()
val aem: AemExtension
val bundlePath: Property<String!>!
val bundlesInstalled: ListProperty<BundleInstalled!>!
val composedDir: File!
val composedFile: File!
val contentDir: DirectoryProperty!
protected open fun copy(): Unit
fun definition(definition: () -> Unit): Unit
val fileFilter: PackageFileFilter
fun fileFilter(configurer: PackageFileFilter.() -> Unit): Unit
var fileFilterDelegate: (CopySpec) -> Unit
fun fromBundlesInstalled(bundles: ListProperty<BundleInstalled>): Unit
fun fromDefaults(): Unit
fun fromMeta(metaDir: Any): Unit
fun fromPackagesNested(pkgs: ListProperty<PackageNested>): Unit
fun fromRoot(dir: Any): Unit
fun fromVaultHooks(dir: Any): Unit
fun installBundle(dependencyNotation: Any, options: BundleInstalledResolved.() -> Unit = {}): Unit
fun installBundleBuilt(taskPath: String, options: BundleInstalledBuilt.() -> Unit = {}): Unit
fun installBundleBuilt(task: TaskProvider<BundleCompose>, options: BundleInstalledBuilt.() -> Unit = {}): Unit
fun installBundleProject(projectPath: String, options: BundleInstalledBuilt.() -> Unit = {}): Unit
val jcrRootDir: DirectoryProperty!
fun merged(action: (PackageCompose) -> Unit): Unit
fun mergePackage(taskPath: String): Unit
fun mergePackage(task: TaskProvider<PackageCompose>): Unit
fun mergePackageProject(projectPath: String): Unit
fun merging(action: (PackageCompose) -> Unit): Unit
val metaDir: DirectoryProperty!
const val NAME: String
val nestedPath: Property<String!>!
fun nestPackage(dependencyNotation: Any, options: PackageNestedResolved.() -> Unit = {}): Unit
fun nestPackageBuilt(taskPath: String, options: PackageNestedBuilt.() -> Unit = {}): Unit
fun nestPackageBuilt(task: TaskProvider<PackageCompose>, options: PackageNestedBuilt.() -> Unit = {}): Unit
fun nestPackageProject(projectPath: String, options: PackageNestedBuilt.() -> Unit = {}): Unit
fun noDefaults(): Unit
val packagesNested: ListProperty<PackageNested!>!
open fun projectsEvaluated(): Unit
val validator: PackageValidator
fun validator(options: PackageValidator.() -> Unit): Unit
val vaultDefinition: VaultDefinition
fun vaultDefinition(options: VaultDefinition.() -> Unit): Unit
val vaultDir: DirectoryProperty!
val vaultFilterFile: RegularFileProperty!
val vaultFilterOriginFile: RegularFileProperty!
val vaultFilters: Property<Boolean!>!
val vaultHooksDir: DirectoryProperty!
val vaultNodeTypesFile: RegularFileProperty!
fun withBundlesInstalled(others: ListProperty<BundleInstalled>): Unit
fun withPackagesNested(others: ListProperty<PackageNested>): Unit
fun withVaultDefinition(other: VaultDefinition): Unit
fun withVaultFilters(file: RegularFileProperty): Unit
fun withVaultNodeTypes(file: RegularFileProperty): Unit

open class PackageDelete : PackageTask

PackageDelete()
fun delete(): Unit
const val NAME: String

open class PackageDeploy : PackageTask

PackageDeploy()
open fun deploy(): Unit
val distributed: Property<Boolean!>!
const val NAME: String

open class PackageInstall : PackageTask

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

open class PackagePrepare : AemDefaultTask

PackagePrepare()
val contentDir: DirectoryProperty!
val metaDefaults: Property<Boolean!>!
val metaDir: DirectoryProperty!
val metaDirs: ConfigurableFileCollection!
const val NAME: String
fun prepare(): Unit
val vaultFilterOriginFile: RegularFileProperty!
val vaultFilterTemplateFile: RegularFileProperty!

open class PackagePurge : PackageTask

PackagePurge()
const val NAME: String
fun purge(): Unit

open class PackageSync : AemDefaultTask

PackageSync()
fun cleaner(options: Cleaner.() -> Unit): Unit
val contentDir: DirectoryProperty!
fun downloader(options: Downloader.() -> Unit): Unit
val filter: Property<FilterFile!>!
val instance: Property<Instance!>!
val mode: Property<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
val transfer: Property<Transfer!>!
fun transfer(name: String): Unit
enum class Transfer

fun of(name: String): Transfer
PACKAGE_DOWNLOAD
VLT_CHECKOUT

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

open class PackageUninstall : PackageTask

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

open class PackageUpload : PackageTask

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

open class PackageVlt : AemDefaultTask

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

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

interface BundleInstalled : RepositoryArchive

abstract val runMode: Property<String>

class BundleInstalledBuilt : BundleInstalled

BundleInstalledBuilt(target: PackageCompose, task: TaskProvider<BundleCompose>)
val dirPath: Property<String!>!
val file: RegularFileProperty!
val fileName: Property<String!>!
val runMode: Property<String!>!
val vaultFilter: Property<Boolean!>!

class BundleInstalledResolved : BundleInstalled

BundleInstalledResolved(target: PackageCompose, notation: Any)
val dirPath: Property<String!>!
val file: RegularFileProperty!
val fileName: Property<String!>!
val notation: Any
val runMode: Property<String!>!
val vaultFilter: Property<Boolean!>!

interface PackageNested : RepositoryArchive
class PackageNestedBuilt : PackageNested

PackageNestedBuilt(target: PackageCompose, task: TaskProvider<PackageCompose>)
val dirPath: Property<String!>!
val file: RegularFileProperty!
val fileName: Property<String!>!
val vaultFilter: Property<Boolean!>!

class PackageNestedResolved : PackageNested

PackageNestedResolved(target: PackageCompose, notation: Any)
val dirPath: Property<String!>!
val file: RegularFileProperty!
val fileName: Property<String!>!
val notation: Any
val vaultFilter: Property<Boolean!>!

interface RepositoryArchive : Serializable

abstract val dirPath: Property<String>
abstract val file: RegularFileProperty
abstract val fileName: Property<String>
abstract val vaultFilter: Property<Boolean>

package com.cognifide.gradle.aem.pkg.tasks.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
fun contentProcess(callback: (File, List<String>) -> List<String>): Unit
fun filesDeleted(filter: PatternFilterable.() -> Unit): Unit
fun filesDotContent(filter: PatternFilterable.() -> Unit): Unit
fun filesFlattened(filter: PatternFilterable.() -> Unit): Unit
const val JCR_CONTENT_FILE: String
const val JCR_MIXIN_TYPES_PROP: String
const val JCR_ROOT_PREFIX: String
fun lineProcess(callback: (File, String) -> String): Unit
fun mergeSinglePropertyLines(lines: List<String>): MutableList<String>
val mixinTypesSkipped: ListProperty<String!>!
val NAMESPACE_PATTERN: Pattern
val namespacesSkipped: Property<Boolean!>!
fun normalizeContent(file: File, lines: List<String>): List<String>
fun normalizeLine(file: File, line: String): String
fun normalizeMixins(file: File, line: String): String
val parentsBackupEnabled: Property<Boolean!>!
val parentsBackupSuffix: Property<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
val propertiesSkipped: ListProperty<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)
val clean: Property<Boolean!>!
val definition: PackageDefinition
fun definition(options: PackageDefinition.() -> Unit): Unit
fun download(): Unit
val extract: Property<Boolean!>!
val extractDir: DirectoryProperty!
val filter: Property<FilterFile!>!
val instance: Property<Instance!>!