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

Class BackupManager

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

public class BackupManager

Field Detail

OUTPUT_DIR

@NotNull
public static java.lang.String OUTPUT_DIR

See Also:

Constant Field Values

SUFFIX_DEFAULT

@NotNull
public static java.lang.String SUFFIX_DEFAULT

See Also:

Constant Field Values

Companion

public static com.cognifide.gradle.aem.common.instance.local.BackupManager.Companion Companion

Constructor Detail

BackupManager

public BackupManager(@NotNull
                     AemExtension aem)

Method Detail

getUploadUrl

public org.gradle.api.provider.Property<java.lang.String> getUploadUrl()

URL to remote directory in which backup files are stored.

getDownloadUrl

public org.gradle.api.provider.Property<java.lang.String> getDownloadUrl()

URL to remote backup file.

getAny

@Nullable
public java.io.File getAny()

Backup file from any source (local & remote sources).

getLocalDir

public org.gradle.api.file.DirectoryProperty getLocalDir()

Directory storing locally created backup files.

getLocal

@Nullable
public java.io.File getLocal()

Backup file from local source.

getRemoteDir

public org.gradle.api.file.DirectoryProperty getRemoteDir()

Directory storing downloaded remote backup files.

getRemote

@Nullable
public java.io.File getRemote()

Backup file from remote source.

getSuffix

public org.gradle.api.provider.Property<java.lang.String> getSuffix()

File suffix indicating instance backup file.

namer

public void namer(@NotNull
                  kotlin.jvm.functions.Function0<java.lang.String> provider)

Defines backup file naming rule. Must be in sync with selector rule.

getNamedFile

@NotNull
public java.io.File getNamedFile()

Get newly created file basing on namer rule.

selector

public void selector(@NotNull
                     kotlin.jvm.functions.Function1<? super java.util.Collection<com.cognifide.gradle.aem.common.instance.local.BackupSource>,com.cognifide.gradle.aem.common.instance.local.BackupSource> selector)

Defines backup source selection rule.

By default takes desired backup by name (if provided) or takes most recent backup. Also by default, file names are sorted lexically / descending. If same name on local & remote source found, local has precedence. Still, this callback allows to customize order to be used.

create

@NotNull
public java.io.File create(@NotNull
                                    java.util.Collection<com.cognifide.gradle.aem.common.instance.LocalInstance> instances)

create

public void create(@NotNull
                   java.io.File file,
                   @NotNull
                   java.util.Collection<com.cognifide.gradle.aem.common.instance.LocalInstance> instances)

upload

public boolean upload(@NotNull
                      java.io.File backupZip,
                      boolean verbose)

restore

public void restore(@NotNull
                    java.io.File backupZip,
                    @NotNull
                    java.io.File rootDir,
                    @NotNull
                    java.util.Collection<com.cognifide.gradle.aem.common.instance.LocalInstance> instances)