
public class InstanceManager

Field Summary

Fields
Modifier and Type	Field	Description
`private final LocalInstanceManager`	`local`
`private final InstanceFactory`	`factory`
`private final DirectoryProperty`	`projectDir`
`private final DirectoryProperty`	`configDir`
`private final DirectoryProperty`	`buildDir`
`private final Provisioner`	`provisioner`
`private final Tailer`	`tailer`
`private final StatusReporter`	`statusReporter`
`private final FileSync`	`fileSync`
`private final ListProperty<Instance>`	`defined`
`private final Provider<Map<String, Instance>>`	`all`
`private final Property<Boolean>`	`examineEnabled`
`private final Property<Boolean>`	`examineAvailable`
`private final AemExtension`	`aem`

Constructor Summary

Constructors
Constructor	Description
`InstanceManager(AemExtension aem)`

Method Summary

Modifier and Type	Method	Description
`final Unit`	`provisioner(Function1<Provisioner, Unit> options)`
`final Unit`	`tailer(Function1<Tailer, Unit> options)`
`final Unit`	`statusReporter(Function1<StatusReporter, Unit> options)`
`final Unit`	`fileSync(Function1<FileSync, Unit> options)`
`final Unit`	`sync(Function1<InstanceSync, Unit> options)`	Customize default options for instance services.
`final Unit`	`local(String httpUrl)`	Define local instance (created on local file system).
`final Unit`	`local(String httpUrl, String name)`	Define local instance (created on local file system).
`final Unit`	`local(String httpUrl, Function1<LocalInstance, Unit> options)`	Define local instance (created on local file system).
`final Unit`	`remote(String httpUrl)`	Define remote instance (available on any host).
`final Unit`	`remote(String httpUrl, String name)`	Define remote instance (available on any host).
`final Unit`	`remote(String httpUrl, Function1<Instance, Unit> options)`	Define remote instance (available on any host).
`final Instance`	`find(String name)`
`final Instance`	`get(String name)`
`final Instance`	`parse(String url)`	Get defined instance by name or create temporary definition if URL provided.
`final Unit`	`awaitUp(Instance instance, Function1<AwaitUpAction, Unit> options)`
`final Unit`	`awaitUp(Collection<Instance> instances, Function1<AwaitUpAction, Unit> options)`
`final Unit`	`awaitDown(Instance instance, Function1<AwaitDownAction, Unit> options)`
`final Unit`	`awaitDown(Collection<Instance> instances, Function1<AwaitDownAction, Unit> options)`
`final Unit`	`awaitReloaded(Instance instance, Function1<ReloadAction, Unit> reloadOptions, Function1<AwaitUpAction, Unit> awaitUpOptions)`
`final Unit`	`awaitReloaded(Collection<Instance> instances, Function1<ReloadAction, Unit> reloadOptions, Function1<AwaitUpAction, Unit> awaitUpOptions)`
`final Unit`	`reload(Instance instance, Function1<ReloadAction, Unit> options)`
`final Unit`	`reload(Collection<Instance> instances, Function1<ReloadAction, Unit> options)`
`final Unit`	`check(Instance instance, Function1<CheckAction, Unit> options)`
`final Unit`	`check(Collection<Instance> instances, Function1<CheckAction, Unit> options)`
`final Unit`	`examine(Instance instance)`
`final Unit`	`examine(Collection<Instance> instances)`	Checks as much as it can be despite type of instance before performing any other operations.
`final Unit`	`examinePrerequisites(Collection<Instance> instances)`	Checks if local instances defined are meeting prerequisites before performing any other operations.
`final Unit`	`examineAvailable(Collection<Instance> instances)`	Checks if instances are available before performing any other operations.
`final Unit`	`resolveFiles(Collection<Instance> instances)`
`final LocalInstanceManager`	`getLocal()`
`final InstanceFactory`	`getFactory()`
`final DirectoryProperty`	`getProjectDir()`	Using remote AEM instances is acceptable in any project, so that lookup for project applying local instance plugin is required Needed to determine common directory storing instance related resources (tailer incident filter, Groovy scripts etc).
`final DirectoryProperty`	`getConfigDir()`	Directory storing instance wide configuration files.
`final DirectoryProperty`	`getBuildDir()`	Directory storing outputs of instance tasks.
`final Provisioner`	`getProvisioner()`
`final Tailer`	`getTailer()`
`final StatusReporter`	`getStatusReporter()`
`final FileSync`	`getFileSync()`	Synchronize files with instances (interactively and with health checking).
`final ListProperty<Instance>`	`getDefined()`	List of AEM instances e.g on which packages could be deployed.
`final Provider<Map<String, Instance>>`	`getAll()`	Map of AEM instances with names as a keys.
`final Property<Boolean>`	`getExamineEnabled()`
`final Property<Boolean>`	`getExamineAvailable()`
`final AemExtension`	`getAem()`

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

Constructor Detail
- InstanceManager
```
InstanceManager(AemExtension aem)
```

Method Detail

provisioner

 final Unit provisioner(Function1<Provisioner, Unit> options)

tailer

 final Unit tailer(Function1<Tailer, Unit> options)

statusReporter

 final Unit statusReporter(Function1<StatusReporter, Unit> options)

fileSync

 final Unit fileSync(Function1<FileSync, Unit> options)

sync

 final Unit sync(Function1<InstanceSync, Unit> options)

Customize default options for instance services.

local
```
 final Unit local(String httpUrl)
```
Define local instance (created on local file system).

local
```
 final Unit local(String httpUrl, String name)
```
Define local instance (created on local file system).

local

 final Unit local(String httpUrl, Function1<LocalInstance, Unit> options)

Define local instance (created on local file system).

remote
```
 final Unit remote(String httpUrl)
```
Define remote instance (available on any host).

remote

 final Unit remote(String httpUrl, String name)

Define remote instance (available on any host).

remote

 final Unit remote(String httpUrl, Function1<Instance, Unit> options)

Define remote instance (available on any host).

find
```
 final Instance find(String name)
```

get
```
 final Instance get(String name)
```

parse
```
 final Instance parse(String url)
```
Get defined instance by name or create temporary definition if URL provided.

awaitUp

 final Unit awaitUp(Instance instance, Function1<AwaitUpAction, Unit> options)

awaitUp

 final Unit awaitUp(Collection<Instance> instances, Function1<AwaitUpAction, Unit> options)

awaitDown

 final Unit awaitDown(Instance instance, Function1<AwaitDownAction, Unit> options)

awaitDown

 final Unit awaitDown(Collection<Instance> instances, Function1<AwaitDownAction, Unit> options)

awaitReloaded

 final Unit awaitReloaded(Instance instance, Function1<ReloadAction, Unit> reloadOptions, Function1<AwaitUpAction, Unit> awaitUpOptions)

awaitReloaded

 final Unit awaitReloaded(Collection<Instance> instances, Function1<ReloadAction, Unit> reloadOptions, Function1<AwaitUpAction, Unit> awaitUpOptions)

reload

 final Unit reload(Instance instance, Function1<ReloadAction, Unit> options)

reload

 final Unit reload(Collection<Instance> instances, Function1<ReloadAction, Unit> options)

check

 final Unit check(Instance instance, Function1<CheckAction, Unit> options)

check

 final Unit check(Collection<Instance> instances, Function1<CheckAction, Unit> options)

examine
```
 final Unit examine(Instance instance)
```

examine
```
 final Unit examine(Collection<Instance> instances)
```
Checks as much as it can be despite type of instance before performing any other operations.

examinePrerequisites
```
 final Unit examinePrerequisites(Collection<Instance> instances)
```
Checks if local instances defined are meeting prerequisites before performing any other operations.

examineAvailable
```
 final Unit examineAvailable(Collection<Instance> instances)
```
Checks if instances are available before performing any other operations.

resolveFiles

 final Unit resolveFiles(Collection<Instance> instances)

getLocal
```
 final LocalInstanceManager getLocal()
```

getFactory
```
 final InstanceFactory getFactory()
```

getProjectDir
```
 final DirectoryProperty getProjectDir()
```
Using remote AEM instances is acceptable in any project, so that lookup for project applying local instance plugin is required Needed to determine common directory storing instance related resources (tailer incident filter, Groovy scripts etc).

getConfigDir
```
 final DirectoryProperty getConfigDir()
```
Directory storing instance wide configuration files.

getBuildDir
```
 final DirectoryProperty getBuildDir()
```
Directory storing outputs of instance tasks.

getProvisioner
```
 final Provisioner getProvisioner()
```

getTailer
```
 final Tailer getTailer()
```

getStatusReporter

 final StatusReporter getStatusReporter()

getFileSync
```
 final FileSync getFileSync()
```
Synchronize files with instances (interactively and with health checking).

getDefined
```
 final ListProperty<Instance> getDefined()
```
List of AEM instances e.g on which packages could be deployed.

getAll

 final Provider<Map<String, Instance>> getAll()

Map of AEM instances with names as a keys.

getExamineEnabled

 final Property<Boolean> getExamineEnabled()

getExamineAvailable

 final Property<Boolean> getExamineAvailable()

getAem
```
 final AemExtension getAem()
```

Class InstanceManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.cognifide.gradle.aem.common.instance.InstanceManager

Methods inherited from class java.lang.Object

Constructor Detail

InstanceManager

Method Detail

provisioner

tailer

statusReporter

fileSync

sync

local

local

local

remote

remote

remote

find

get

parse

awaitUp

awaitUp

awaitDown

awaitDown

awaitReloaded

awaitReloaded

reload

reload

check

check

examine

examine

examinePrerequisites

examineAvailable

resolveFiles

getLocal

getFactory

getProjectDir

getConfigDir

getBuildDir

getProvisioner

getTailer

getStatusReporter

getFileSync

getDefined

getAll

getExamineEnabled

getExamineAvailable

getAem