
public final class PackageManager
 extends InstanceService

Allows to communicate with CRX Package Manager.

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field	Description
`private final Boolean`	`available`
`private final Property<Boolean>`	`uploadForce`
`private Retry`	`uploadRetry`
`private Retry`	`installRetry`
`private final Property<Boolean>`	`installRecursive`
`private final Property<Boolean>`	`deployAvoidance`
`private final MapProperty<String, Boolean>`	`workflowToggle`
`private Retry`	`listRetry`
`private final Property<Boolean>`	`listRefresh`
`private Retry`	`downloadRetry`
`private final ListProperty<String>`	`errors`
`private final ListProperty<String>`	`snapshots`
`private final Property<Int>`	`responseBuffer`
`private final Property<Boolean>`	`responseDumping`
`private final DirectoryProperty`	`responseDir`
`private final List<Package>`	`all`
`private final List<Package>`	`installed`
`private final AemExtension`	`aem`
`private final Instance`	`instance`
`private final Project`	`project`
`private final CommonExtension`	`common`
`private final Logger`	`logger`
`private final InstanceSync`	`sync`

Constructor Summary

Constructors
Constructor	Description
`PackageManager(InstanceSync sync)`

Method Summary

Modifier and Type	Method	Description
`final Unit`	`requireAvailable()`	Ensure by throwing exception that package manager is available on instance.
`final Package`	`get(File file)`
`final Package`	`get(VaultDefinition definition)`
`final Package`	`get(String group, String name, String version)`
`final Package`	`find(File file)`
`final Package`	`find(VaultDefinition definition)`
`final Package`	`find(String group, String name, String version)`
`final List<Package>`	`findAll(String group, String name)`
`final Boolean`	`contains(Package pkg, Boolean checkSize)`
`final Boolean`	`contains(File file, Boolean checkSize)`
`final Boolean`	`contains(File file)`
`final ListResponse`	`list()`
`final UploadResponse`	`upload(File file)`
`final File`	`download(Function1<PackageDefinition, Unit> definition)`	Create package on the fly, upload it to instance then build it.
`final File`	`download(PackageDefinition definition)`	Create package on the fly, upload it to instance then build it.
`final Unit`	`download(Package pkg, File targetFile)`
`final Unit`	`download(String remotePath, File targetFile)`
`final File`	`downloadTo(Package pkg, File targetDir)`
`final File`	`downloadTo(String remotePath, File targetDir)`
`final BuildResponse`	`build(File file)`
`final BuildResponse`	`build(Package pkg)`
`final BuildResponse`	`build(String remotePath)`
`final InstallResponse`	`install(File file)`
`final InstallResponse`	`install(Package pkg)`
`final InstallResponse`	`install(String remotePath)`
`final Boolean`	`isSnapshot(File file)`
`final Boolean`	`isDeployed(File file)`
`final Boolean`	`isDeployed(Package pkg)`
`final Boolean`	`deploy(File file, Boolean activate)`
`final Boolean`	`distribute(File file)`
`final UploadResponse`	`activate(File file)`
`final UploadResponse`	`activate(Package pkg)`
`final UploadResponse`	`activate(String remotePath)`
`final DeleteResponse`	`delete(File file)`
`final DeleteResponse`	`delete(Package pkg)`
`final DeleteResponse`	`delete(String remotePath)`
`final UninstallResponse`	`uninstall(File file)`
`final UninstallResponse`	`uninstall(Package pkg)`
`final UninstallResponse`	`uninstall(String remotePath)`
`final Boolean`	`purge(File file)`
`final Boolean`	`purge(Package pkg)`
`final Boolean`	`purge(String remotePath)`
`final Boolean`	`getAvailable()`
`final Property<Boolean>`	`getUploadForce()`	Force upload CRX package regardless if it was previously uploaded.
`final Retry`	`getUploadRetry()`	Repeat upload when failed (brute-forcing).
`final Retry`	`getInstallRetry()`	Repeat install when failed (brute-forcing).
`final Property<Boolean>`	`getInstallRecursive()`	Determines if when on package install, sub-packages included in CRX package content should be also installed.
`final Property<Boolean>`	`getDeployAvoidance()`	Deploys only if package is changed (checksum based) or reinstalled on instance in the meantime.
`final MapProperty<String, Boolean>`	`getWorkflowToggle()`	Allows to temporarily enable or disable workflows during CRX package deployment.
`final Retry`	`getListRetry()`	Repeat listing package when failed (brute-forcing).
`final Property<Boolean>`	`getListRefresh()`	Packages are installed lazy which means already installed will no be installed again.
`final Retry`	`getDownloadRetry()`	Repeat download when failed (brute-forcing).
`final ListProperty<String>`	`getErrors()`	Define patterns for known exceptions which could be thrown during package installation making it impossible to succeed.
`final ListProperty<String>`	`getSnapshots()`	CRX package name conventions (with wildcard) indicating that package can change over time while having same version specified.
`final Property<Int>`	`getResponseBuffer()`	Determines number of lines to process at once during reading Package Manager HTML responses.
`final Property<Boolean>`	`getResponseDumping()`	Controls dumping of package installation responses.
`final DirectoryProperty`	`getResponseDir()`	Location of dumped package installation responses.
`final List<Package>`	`getAll()`
`final List<Package>`	`getInstalled()`
`final AemExtension`	`getAem()`
`final Instance`	`getInstance()`
`final Project`	`getProject()`
`final CommonExtension`	`getCommon()`
`final Logger`	`getLogger()`
`final InstanceSync`	`getSync()`
`final Unit`	`setUploadRetry(Retry uploadRetry)`	Repeat upload when failed (brute-forcing).
`final Unit`	`setInstallRetry(Retry installRetry)`	Repeat install when failed (brute-forcing).
`final Unit`	`setListRetry(Retry listRetry)`	Repeat listing package when failed (brute-forcing).
`final Unit`	`setDownloadRetry(Retry downloadRetry)`	Repeat download when failed (brute-forcing).

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

Constructor Detail
- PackageManager
```
PackageManager(InstanceSync sync)
```

Method Detail

requireAvailable
```
 final Unit requireAvailable()
```
Ensure by throwing exception that package manager is available on instance.

get
```
 final Package get(File file)
```

get

 final Package get(VaultDefinition definition)

get

 final Package get(String group, String name, String version)

find
```
 final Package find(File file)
```

find

 final Package find(VaultDefinition definition)

find

 final Package find(String group, String name, String version)

findAll

 final List<Package> findAll(String group, String name)

contains

 final Boolean contains(Package pkg, Boolean checkSize)

contains

 final Boolean contains(File file, Boolean checkSize)

contains
```
 final Boolean contains(File file)
```

list
```
 final ListResponse list()
```

upload

 final UploadResponse upload(File file)

download

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

Create package on the fly, upload it to instance then build it.

download
```
 final File download(PackageDefinition definition)
```
Create package on the fly, upload it to instance then build it.

download

 final Unit download(Package pkg, File targetFile)

download

 final Unit download(String remotePath, File targetFile)

downloadTo

 final File downloadTo(Package pkg, File targetDir)

downloadTo

 final File downloadTo(String remotePath, File targetDir)

build
```
 final BuildResponse build(File file)
```

build

 final BuildResponse build(Package pkg)

build

 final BuildResponse build(String remotePath)

install

 final InstallResponse install(File file)

install

 final InstallResponse install(Package pkg)

install

 final InstallResponse install(String remotePath)

isSnapshot
```
 final Boolean isSnapshot(File file)
```

isDeployed
```
 final Boolean isDeployed(File file)
```

isDeployed
```
 final Boolean isDeployed(Package pkg)
```

deploy

 final Boolean deploy(File file, Boolean activate)

distribute
```
 final Boolean distribute(File file)
```

activate

 final UploadResponse activate(File file)

activate

 final UploadResponse activate(Package pkg)

activate

 final UploadResponse activate(String remotePath)

delete

 final DeleteResponse delete(File file)

delete

 final DeleteResponse delete(Package pkg)

delete

 final DeleteResponse delete(String remotePath)

uninstall

 final UninstallResponse uninstall(File file)

uninstall

 final UninstallResponse uninstall(Package pkg)

uninstall

 final UninstallResponse uninstall(String remotePath)

purge
```
 final Boolean purge(File file)
```

purge
```
 final Boolean purge(Package pkg)
```

purge

 final Boolean purge(String remotePath)

getAvailable
```
 final Boolean getAvailable()
```

getUploadForce
```
 final Property<Boolean> getUploadForce()
```
Force upload CRX package regardless if it was previously uploaded.

getUploadRetry
```
 final Retry getUploadRetry()
```
Repeat upload when failed (brute-forcing).

getInstallRetry
```
 final Retry getInstallRetry()
```
Repeat install when failed (brute-forcing).

getInstallRecursive
```
 final Property<Boolean> getInstallRecursive()
```
Determines if when on package install, sub-packages included in CRX package content should be also installed.

getDeployAvoidance
```
 final Property<Boolean> getDeployAvoidance()
```
Deploys only if package is changed (checksum based) or reinstalled on instance in the meantime.

getWorkflowToggle
```
 final MapProperty<String, Boolean> getWorkflowToggle()
```
Allows to temporarily enable or disable workflows during CRX package deployment.

getListRetry
```
 final Retry getListRetry()
```
Repeat listing package when failed (brute-forcing).

getListRefresh
```
 final Property<Boolean> getListRefresh()
```
Packages are installed lazy which means already installed will no be installed again.

getDownloadRetry
```
 final Retry getDownloadRetry()
```
Repeat download when failed (brute-forcing).

getErrors
```
 final ListProperty<String> getErrors()
```
Define patterns for known exceptions which could be thrown during package installation making it impossible to succeed.

getSnapshots
```
 final ListProperty<String> getSnapshots()
```
CRX package name conventions (with wildcard) indicating that package can change over time while having same version specified.

getResponseBuffer
```
 final Property<Int> getResponseBuffer()
```
Determines number of lines to process at once during reading Package Manager HTML responses.

getResponseDumping
```
 final Property<Boolean> getResponseDumping()
```
Controls dumping of package installation responses.

getResponseDir
```
 final DirectoryProperty getResponseDir()
```
Location of dumped package installation responses.

getAll
```
 final List<Package> getAll()
```

getInstalled
```
 final List<Package> getInstalled()
```

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

getInstance
```
 final Instance getInstance()
```

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

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

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

getSync
```
 final InstanceSync getSync()
```

setUploadRetry
```
 final Unit setUploadRetry(Retry uploadRetry)
```
Repeat upload when failed (brute-forcing).

setInstallRetry
```
 final Unit setInstallRetry(Retry installRetry)
```
Repeat install when failed (brute-forcing).

setListRetry
```
 final Unit setListRetry(Retry listRetry)
```
Repeat listing package when failed (brute-forcing).

setDownloadRetry
```
 final Unit setDownloadRetry(Retry downloadRetry)
```
Repeat download when failed (brute-forcing).

Class PackageManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

PackageManager

Method Detail

requireAvailable

get

get

get

find

find

find

findAll

contains

contains

contains

list

upload

download

download

download

download

downloadTo

downloadTo

build

build

build

install

install

install

isSnapshot

isDeployed

isDeployed

deploy

distribute

activate

activate

activate

delete

delete

delete

uninstall

uninstall

uninstall

purge

purge

purge

getAvailable

getUploadForce

getUploadRetry

getInstallRetry

getInstallRecursive

getDeployAvoidance

getWorkflowToggle

getListRetry

getListRefresh

getDownloadRetry

getErrors

getSnapshots

getResponseBuffer

getResponseDumping

getResponseDir

getAll

getInstalled

getAem

getInstance

getProject

getCommon

getLogger

getSync

setUploadRetry

setInstallRetry

setListRetry

setDownloadRetry