aem-plugin / com.cognifide.gradle.aem.common.instance / LocalInstanceManager

LocalInstanceManager

class LocalInstanceManager : Serializable

Constructors

<init>

LocalInstanceManager(aem: AemExtension)

Properties

backup	Configure AEM backup sources. `val backup: BackupManager`
backupZip	`val backupZip: File?`
base	`val base: InstanceManager`
configDir	Path for storing local AEM instances related resources. `val configDir: DirectoryProperty!`
expandFiles	Wildcard file name filter expression that is used to filter in which instance files properties can be injected. `val expandFiles: ListProperty<String!>!`
expandProperties	Custom properties that can be injected into instance files. `val expandProperties: MapProperty<String!, Any!>!`
install	`val install: InstallResolver`
overrideDir	Path from which e.g extra files for local AEM instances will be copied. Useful for overriding default startup scripts ('start.bat' or 'start.sh') or providing some files inside 'crx-quickstart'. `val overrideDir: DirectoryProperty!`
projectDir	Using local AEM instances is acceptable in any project so that lookup for project applying local instance plugin is required Needed to determine e.g directory in which AEM quickstart will be stored and override files. `val projectDir: DirectoryProperty!`
quickstart	`val quickstart: QuickstartResolver`
rootDir	Path in which local AEM instances will be stored. `val rootDir: DirectoryProperty!`
scriptTimeout	Maximum time to wait for status script response. `val scriptTimeout: Property<Long!>!`
source	Determines how instances will be created (from backup or quickstart built from the scratch). `val source: Property<Source!>!`
sourceFiles	Collection of files potentially needed to create instance `val sourceFiles: ConfigurableFileCollection!`

Functions

backup	`fun backup(options: BackupManager.() -> Unit): Unit`
create	`fun create(instance: LocalInstance): List<LocalInstance>` `fun create(instances: Collection<LocalInstance> = aem.localInstances): List<LocalInstance>`
createBySource	`fun createBySource(instances: Collection<LocalInstance> = aem.localInstances): Unit`
createFromBackup	`fun createFromBackup(instances: Collection<LocalInstance> = aem.localInstances, backupZip: File): Unit`
createFromScratch	`fun createFromScratch(instances: Collection<LocalInstance> = aem.localInstances): Unit`
destroy	`fun destroy(instance: LocalInstance): Boolean` `fun destroy(instances: Collection<LocalInstance> = aem.localInstances): List<LocalInstance>`
down	`fun down(instance: LocalInstance, awaitDownOptions: AwaitDownAction.() -> Unit = {}): Boolean` `fun down(instances: Collection<LocalInstance> = aem.localInstances, awaitDownOptions: AwaitDownAction.() -> Unit = {}): List<LocalInstance>`
init	Configure action to be performed only once when instance is up first time. `fun init(options: LocalInstance.() -> Unit): Unit`
install	Configure CRX packages, bundles to be pre-installed on instance(s). `fun install(options: InstallResolver.() -> Unit): Unit`
quickstart	Configure AEM source files when creating instances from the scratch. `fun quickstart(options: QuickstartResolver.() -> Unit): Unit`
resolveFiles	`fun resolveFiles(): Unit`
source	`fun source(name: String): Unit`
up	`fun up(instance: LocalInstance, awaitUpOptions: AwaitUpAction.() -> Unit = {}): Boolean` `fun up(instances: Collection<LocalInstance> = aem.localInstances, awaitUpOptions: AwaitUpAction.() -> Unit = {}): List<LocalInstance>`