All Implemented Interfaces:: java.io.Serializable


public final class AemExtension
 implements Serializable

Core of library, facade for implementing tasks.

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field	Description
`private final CommonExtension`	`common`
`private final Logger`	`logger`
`private final PropertyParser`	`prop`
`private final ObjectFactory`	`obj`
`private final CommonOptions`	`commonOptions`
`private final AssetManager`	`assetManager`
`private final WebBrowser`	`webBrowser`
`private final ProcessKiller`	`processKiller`
`private final PackageOptions`	`packageOptions`
`private final InstanceManager`	`instanceManager`
`private final LocalInstanceManager`	`localInstanceManager`
`private final List<Jar>`	`bundlesBuilt`
`private final List<PackageCompose>`	`packagesBuilt`
`private final String`	`javaPackage`
`private final List<String>`	`javaPackages`
`private final List<Instance>`	`instances`
`private final Instance`	`anyInstance`
`private final Instance`	`availableInstance`
`private final List<Instance>`	`authorInstances`
`private final Instance`	`authorInstance`
`private final List<Instance>`	`publishInstances`
`private final Instance`	`publishInstance`
`private final List<LocalInstance>`	`localInstances`
`private final List<Instance>`	`remoteInstances`
`private final File`	`package`
`private final File`	`pkg`
`private final List<File>`	`packages`
`private final File`	`bundle`
`private final List<File>`	`bundles`
`private final FilterFile`	`filter`
`private final Project`	`project`

Constructor Summary

Constructors
Constructor	Description
`AemExtension(Project project)`

Method Summary

Modifier and Type	Method	Description
`final Unit`	`common(Function1<CommonOptions, Unit> options)`	Defines common settings like environment name, line endings when generating files etc
`final Unit`	`package(Function1<PackageOptions, Unit> options)`	Defines common settings for built packages and deployment related behavior.
`final PackageFile`	`package(File file)`	Read CRX package properties of specified ZIP file.
`final Unit`	`pkg(Function1<PackageOptions, Unit> options)`	Defines common settings for built packages and deployment related behavior.
`final PackageFile`	`pkg(File file)`	Read CRX package properties of specified ZIP file.
`final Unit`	`instance(Function1<InstanceManager, Unit> options)`	Defines instances to work with.
`final Instance`	`instance(String urlOrName)`	Shorthand method for getting defined instance or creating temporary instance by URL.
`final LocalInstanceManager`	`localInstance(Function1<LocalInstanceManager, Unit> options)`	Define common settings valid only for instances created at local file system.
`final Unit`	`instances(Function1<Instance, Unit> consumer)`	Work in parallel with instances matching default filtering.
`final Unit`	`instances(String filter, Function1<Instance, Unit> consumer)`	Work in parallel with instances which name is matching specified wildcard filter.
`final List<Instance>`	`instances(Iterable<String> urlsOrNames)`	Shorthand method for getting defined instances or creating temporary instances by URLs.
`final Instance`	`findInstance(String desiredName, String defaultName)`	Find instance which name is matching wildcard filter specified via command line parameter 'instance.name'.
`final Instance`	`namedInstance(String desiredName, String defaultName)`	Get instance which name is matching wildcard filter specified via command line parameter 'instance.name'.
`final List<Instance>`	`filterInstances(String nameMatcher)`	Find all instances which names are matching wildcard filter specified via command line parameter 'instance.name'.
`final Unit`	`authorInstances(Function1<Instance, Unit> consumer)`	Work in parallel with all author instances running on current environment.
`final Unit`	`publishInstances(Function1<Instance, Unit> consumer)`	Work in parallel with all publish instances running on current environment.
`final Unit`	`localInstances(Function1<LocalInstance, Unit> consumer)`	Work in parallel with all local instances.
`final Unit`	`remoteInstances(Function1<Instance, Unit> consumer)`	Work in parallel with all remote instances.
`final Unit`	`bundleEmbed(Object dependencyNotation, Iterable<String> pkgs, Boolean export)`	Shorthand for embedding code inside OSGi bundle being composed when configuration on demand is enabled.
`final Unit`	`bundleEmbed(Object dependencyNotation, Array<Out String> pkgs, Boolean export)`	Shorthand for embedding code inside OSGi bundle being composed when configuration on demand is enabled.
`final Unit`	`sync(Function1<InstanceSync, Unit> action)`	In parallel, work with services of all instances matching default filtering.
`final <T extends Any> T`	`sync(Instance instance, Function1<InstanceSync, T> action)`	Work with instance services of specified instance.
`final Unit`	`sync(Iterable<Instance> instances, Function1<InstanceSync, Unit> action)`	In parallel, work with services of all specified instances.
`final Unit`	`syncInstances(Function1<InstanceSync, Unit> action)`	In parallel, work with services of all instances matching default filtering.
`final Unit`	`syncInstances(Iterable<Instance> instances, Function1<InstanceSync, Unit> action)`	In parallel, work with services of all specified instances.
`final <T extends Any> T`	`syncInstance(Instance instance, Function1<InstanceSync, T> action)`	Work with instance services of specified instance.
`final Unit`	`syncPackages(Function2<InstanceSync, File, Unit> action)`	In parallel, work with built packages and services of instances matching default filtering.
`final Unit`	`syncBundles(Function2<InstanceSync, File, Unit> action)`	In parallel, work with built OSGi bundles and services of instances matching default filtering.
`final Unit`	`syncFiles(Iterable<Instance> instances, Iterable<File> packages, Function2<InstanceSync, File, Unit> action)`	In parallel, work with built packages and services of specified instances.
`final File`	`composePackage(Function1<PackageDefinition, Unit> definition)`	Build minimal CRX package in-place / only via code.
`final Unit`	`validatePackage(Array<Out File> packages, Function1<PackageValidator, Unit> options)`	Validate any CRX packages.
`final Unit`	`validatePackage(Iterable<File> packages, Function1<PackageValidator, Unit> options)`	Validate any CRX packages.
`final FilterFile`	`filter(File file)`	Get Vault filter object for specified file.
`final FilterFile`	`filter(String path)`	Get Vault filter object for specified path.
`final VaultSummary`	`vlt(String command)`	Execute any Vault command.
`final <T extends Any> T`	`vlt(Function1<VaultClient, T> options)`	Execute any Vault command with customized options like content directory.
`final <T extends Any> T`	`rcp(Function1<RcpClient, T> options)`	Execute any Vault JCR content remote copying with customized options like content directory.
`final <T extends Any> T`	`groovyEval(Function1<GroovyEvaluator, T> options)`	Execute Groovy script(s) using specified options.
`final GroovyEvalSummary`	`groovyEval(String scriptPattern)`	Execute Groovy script(s) matching file pattern on AEM instances.
`final CommonExtension`	`getCommon()`
`final Logger`	`getLogger()`
`final PropertyParser`	`getProp()`
`final ObjectFactory`	`getObj()`
`final CommonOptions`	`getCommonOptions()`
`final AssetManager`	`getAssetManager()`
`final WebBrowser`	`getWebBrowser()`
`final ProcessKiller`	`getProcessKiller()`
`final PackageOptions`	`getPackageOptions()`
`final InstanceManager`	`getInstanceManager()`
`final LocalInstanceManager`	`getLocalInstanceManager()`
`final List<Jar>`	`getBundlesBuilt()`
`final List<PackageCompose>`	`getPackagesBuilt()`
`final String`	`getJavaPackage()`
`final List<String>`	`getJavaPackages()`
`final List<Instance>`	`getInstances()`
`final Instance`	`getAnyInstance()`
`final Instance`	`getAvailableInstance()`
`final List<Instance>`	`getAuthorInstances()`
`final Instance`	`getAuthorInstance()`
`final List<Instance>`	`getPublishInstances()`
`final Instance`	`getPublishInstance()`
`final List<LocalInstance>`	`getLocalInstances()`
`final List<Instance>`	`getRemoteInstances()`
`final File`	`getPackage()`
`final File`	`getPkg()`
`final List<File>`	`getPackages()`
`final File`	`getBundle()`
`final List<File>`	`getBundles()`
`final FilterFile`	`getFilter()`
`final Project`	`getProject()`

Methods inherited from class java.io.Serializable
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Method Detail

common
```
 final Unit common(Function1<CommonOptions, Unit> options)
```
Defines common settings like environment name, line endings when generating files etc

package
```
 final Unit package(Function1<PackageOptions, Unit> options)
```
Defines common settings for built packages and deployment related behavior.

package
```
 final PackageFile package(File file)
```
Read CRX package properties of specified ZIP file.

pkg
```
 final Unit pkg(Function1<PackageOptions, Unit> options)
```
Defines common settings for built packages and deployment related behavior.

pkg
```
 final PackageFile pkg(File file)
```
Read CRX package properties of specified ZIP file.

instance

 final Unit instance(Function1<InstanceManager, Unit> options)

Defines instances to work with.

instance
```
 final Instance instance(String urlOrName)
```
Shorthand method for getting defined instance or creating temporary instance by URL.

localInstance

 final LocalInstanceManager localInstance(Function1<LocalInstanceManager, Unit> options)

Define common settings valid only for instances created at local file system.

instances
```
 final Unit instances(Function1<Instance, Unit> consumer)
```
Work in parallel with instances matching default filtering.

instances
```
 final Unit instances(String filter, Function1<Instance, Unit> consumer)
```
Work in parallel with instances which name is matching specified wildcard filter.

instances
```
 final List<Instance> instances(Iterable<String> urlsOrNames)
```
Shorthand method for getting defined instances or creating temporary instances by URLs.

findInstance
```
 final Instance findInstance(String desiredName, String defaultName)
```
Find instance which name is matching wildcard filter specified via command line parameter 'instance.name'.

namedInstance
```
 final Instance namedInstance(String desiredName, String defaultName)
```
Get instance which name is matching wildcard filter specified via command line parameter 'instance.name'.

filterInstances
```
 final List<Instance> filterInstances(String nameMatcher)
```
Find all instances which names are matching wildcard filter specified via command line parameter 'instance.name'.

authorInstances
```
 final Unit authorInstances(Function1<Instance, Unit> consumer)
```
Work in parallel with all author instances running on current environment.

publishInstances
```
 final Unit publishInstances(Function1<Instance, Unit> consumer)
```
Work in parallel with all publish instances running on current environment.

localInstances

 final Unit localInstances(Function1<LocalInstance, Unit> consumer)

Work in parallel with all local instances.

remoteInstances

 final Unit remoteInstances(Function1<Instance, Unit> consumer)

Work in parallel with all remote instances.

bundleEmbed
```
 final Unit bundleEmbed(Object dependencyNotation, Iterable<String> pkgs, Boolean export)
```
Shorthand for embedding code inside OSGi bundle being composed when configuration on demand is enabled.

bundleEmbed
```
 final Unit bundleEmbed(Object dependencyNotation, Array<Out String> pkgs, Boolean export)
```
Shorthand for embedding code inside OSGi bundle being composed when configuration on demand is enabled.

sync
```
 final Unit sync(Function1<InstanceSync, Unit> action)
```
In parallel, work with services of all instances matching default filtering.

sync

 final <T extends Any> T sync(Instance instance, Function1<InstanceSync, T> action)

Work with instance services of specified instance.

sync

 final Unit sync(Iterable<Instance> instances, Function1<InstanceSync, Unit> action)

In parallel, work with services of all specified instances.

syncInstances
```
 final Unit syncInstances(Function1<InstanceSync, Unit> action)
```
In parallel, work with services of all instances matching default filtering.

syncInstances

 final Unit syncInstances(Iterable<Instance> instances, Function1<InstanceSync, Unit> action)

In parallel, work with services of all specified instances.

syncInstance

 final <T extends Any> T syncInstance(Instance instance, Function1<InstanceSync, T> action)

Work with instance services of specified instance.

syncPackages
```
 final Unit syncPackages(Function2<InstanceSync, File, Unit> action)
```
In parallel, work with built packages and services of instances matching default filtering.

syncBundles
```
 final Unit syncBundles(Function2<InstanceSync, File, Unit> action)
```
In parallel, work with built OSGi bundles and services of instances matching default filtering.

syncFiles

 final Unit syncFiles(Iterable<Instance> instances, Iterable<File> packages, Function2<InstanceSync, File, Unit> action)

In parallel, work with built packages and services of specified instances.

composePackage

 final File composePackage(Function1<PackageDefinition, Unit> definition)

Build minimal CRX package in-place / only via code.

validatePackage

 final Unit validatePackage(Array<Out File> packages, Function1<PackageValidator, Unit> options)

Validate any CRX packages.

validatePackage

 final Unit validatePackage(Iterable<File> packages, Function1<PackageValidator, Unit> options)

Validate any CRX packages.

filter
```
 final FilterFile filter(File file)
```
Get Vault filter object for specified file.

filter
```
 final FilterFile filter(String path)
```
Get Vault filter object for specified path.

vlt

 final VaultSummary vlt(String command)

Execute any Vault command.

vlt
```
 final <T extends Any> T vlt(Function1<VaultClient, T> options)
```
Execute any Vault command with customized options like content directory.

rcp
```
 final <T extends Any> T rcp(Function1<RcpClient, T> options)
```
Execute any Vault JCR content remote copying with customized options like content directory.

groovyEval

 final <T extends Any> T groovyEval(Function1<GroovyEvaluator, T> options)

Execute Groovy script(s) using specified options.

groovyEval
```
 final GroovyEvalSummary groovyEval(String scriptPattern)
```
Execute Groovy script(s) matching file pattern on AEM instances.

getCommon
```
 final CommonExtension getCommon()
```

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

getProp
```
 final PropertyParser getProp()
```

getObj
```
 final ObjectFactory getObj()
```

getCommonOptions
```
 final CommonOptions getCommonOptions()
```

getAssetManager
```
 final AssetManager getAssetManager()
```

getWebBrowser
```
 final WebBrowser getWebBrowser()
```

getProcessKiller
```
 final ProcessKiller getProcessKiller()
```

getPackageOptions

 final PackageOptions getPackageOptions()

getInstanceManager

 final InstanceManager getInstanceManager()

getLocalInstanceManager

 final LocalInstanceManager getLocalInstanceManager()

getBundlesBuilt
```
 final List<Jar> getBundlesBuilt()
```

getPackagesBuilt

 final List<PackageCompose> getPackagesBuilt()

getJavaPackage
```
 final String getJavaPackage()
```

getJavaPackages
```
 final List<String> getJavaPackages()
```

getInstances
```
 final List<Instance> getInstances()
```

getAnyInstance
```
 final Instance getAnyInstance()
```

getAvailableInstance
```
 final Instance getAvailableInstance()
```

getAuthorInstances

 final List<Instance> getAuthorInstances()

getAuthorInstance
```
 final Instance getAuthorInstance()
```

getPublishInstances

 final List<Instance> getPublishInstances()

getPublishInstance
```
 final Instance getPublishInstance()
```

getLocalInstances

 final List<LocalInstance> getLocalInstances()

getRemoteInstances

 final List<Instance> getRemoteInstances()

getPackage
```
 final File getPackage()
```

getPkg
```
 final File getPkg()
```

getPackages
```
 final List<File> getPackages()
```

getBundle
```
 final File getBundle()
```

getBundles
```
 final List<File> getBundles()
```

getFilter
```
 final FilterFile getFilter()
```

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

Class AemExtension

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.io.Serializable

Methods inherited from class java.lang.Object

Constructor Detail

AemExtension

Method Detail

common

package

package

pkg

pkg

instance

instance

localInstance

instances

instances

instances

findInstance

namedInstance

filterInstances

authorInstances

publishInstances

localInstances

remoteInstances

bundleEmbed

bundleEmbed

sync

sync

sync

syncInstances

syncInstances

syncInstance

syncPackages

syncBundles

syncFiles

composePackage

validatePackage

validatePackage

filter

filter

vlt

vlt

rcp

groovyEval

groovyEval

getCommon

getLogger

getProp

getObj

getCommonOptions

getAssetManager

getWebBrowser

getProcessKiller

getPackageOptions

getInstanceManager

getLocalInstanceManager

getBundlesBuilt

getPackagesBuilt

getJavaPackage

getJavaPackages

getInstances

getAnyInstance

getAvailableInstance

getAuthorInstances

getAuthorInstance

getPublishInstances

getPublishInstance

getLocalInstances

getRemoteInstances

getPackage

getPkg

getPackages

getBundle

getBundles

getFilter

getProject