com.cognifide.gradle.aem.environment

Class Environment

com.cognifide.gradle.aem.environment.Environment

public class Environment

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Environment.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static Environment.Companion	Companion
static java.lang.String	DISTRIBUTIONS_DIR
static java.lang.String	ENVIRONMENT_DIR

Constructor Summary

Constructors

Constructor and Description
Environment(AemExtension aem)

Method Summary

Modifier and Type	Method and Description
java.util.List<com.cognifide.gradle.aem.environment.health.HealthStatus>	check(boolean verbose)
void	clean()
void	destroy()
void	directories(java.lang.String... paths) Ensures that specified directories will exist.
void	directories(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.environment.DirectoryOptions,kotlin.Unit> options) Allows to distinguish regular directories and caches (cleanable).
java.io.File	distributionFile(java.lang.String path)
void	distributions(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.file.resolver.FileResolver,kotlin.Unit> options) Allows to provide remote files to Docker containers by mounted volumes.
void	down()
AemExtension	getAem()
java.io.File	getConfigDir() Convention directory for storing environment specific configuration files.
boolean	getCreated()
DirectoryOptions	getDirectories() Directory options (defines caches and regular directories to be created)
java.util.List<java.io.File>	getDistributionFiles()
java.io.File	getDockerComposeFile()
java.io.File	getDockerComposeSourceFile()
java.lang.String	getDockerConfigPath()
java.lang.String	getDockerRootPath()
DockerRuntime	getDockerRuntime()
HealthChecker	getHealthChecker()
HostOptions	getHosts()
HttpdContainer	getHttpd() Represents Docker container named 'aem_httpd' and provides API for manipulating it.
java.io.File	getHttpdConfDir()
java.io.File	getRootDir() Path in which local AEM environment will be stored.
boolean	getRunning()
Stack	getStack() Represents Docker stack named 'aem' and provides API for manipulating it.
void	healthChecks(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.environment.health.HealthChecker,kotlin.Unit> options) Configures environment service health checks.
void	hosts(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.environment.hosts.HostOptions,kotlin.Unit> options)
void	hosts(java.lang.String... values) Defines hosts to be appended to system specific hosts file.
void	hosts(java.lang.Iterable<java.lang.String> names) Defines hosts to be appended to system specific hosts file.
void	restart()
void	setHealthChecker(HealthChecker p)
void	setRootDir(java.io.File p) Path in which local AEM environment will be stored.
java.lang.String	toString()
void	up()

Field Detail

ENVIRONMENT_DIR

@NotNull
public static java.lang.String ENVIRONMENT_DIR

See Also:

Constant Field Values

DISTRIBUTIONS_DIR

@NotNull
public static java.lang.String DISTRIBUTIONS_DIR

See Also:

Constant Field Values

Companion

public static Environment.Companion Companion

Constructor Detail

Environment

public Environment(@NotNull
                   AemExtension aem)

Method Detail

getRootDir

@NotNull
public java.io.File getRootDir()

Path in which local AEM environment will be stored.

setRootDir

public void setRootDir(@NotNull
                       java.io.File p)

Path in which local AEM environment will be stored.

getConfigDir

@NotNull
public java.io.File getConfigDir()

Convention directory for storing environment specific configuration files.

getStack

@NotNull
public Stack getStack()

Represents Docker stack named 'aem' and provides API for manipulating it.

getHttpd

@NotNull
public HttpdContainer getHttpd()

Represents Docker container named 'aem_httpd' and provides API for manipulating it.

getHttpdConfDir

@NotNull
public java.io.File getHttpdConfDir()

getDirectories

@NotNull
public DirectoryOptions getDirectories()

Directory options (defines caches and regular directories to be created)

getDistributionFiles

@NotNull
public java.util.List<java.io.File> getDistributionFiles()

distributions

public void distributions(@NotNull
                          kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.file.resolver.FileResolver,kotlin.Unit> options)

Allows to provide remote files to Docker containers by mounted volumes.

distributionFile

@NotNull
public java.io.File distributionFile(@NotNull
                                               java.lang.String path)

getDockerRuntime

@NotNull
public DockerRuntime getDockerRuntime()

getDockerComposeFile

@NotNull
public java.io.File getDockerComposeFile()

getDockerComposeSourceFile

@NotNull
public java.io.File getDockerComposeSourceFile()

getDockerConfigPath

@NotNull
public java.lang.String getDockerConfigPath()

getDockerRootPath

@NotNull
public java.lang.String getDockerRootPath()

getHealthChecker

@NotNull
public HealthChecker getHealthChecker()

setHealthChecker

public void setHealthChecker(@NotNull
                             HealthChecker p)

getHosts

@NotNull
public HostOptions getHosts()

getCreated

public boolean getCreated()

getRunning

public boolean getRunning()

up

public void up()

down

public void down()

restart

public void restart()

destroy

public void destroy()

check

@NotNull
public java.util.List<com.cognifide.gradle.aem.environment.health.HealthStatus> check(boolean verbose)

clean

public void clean()

directories

public void directories(@NotNull
                        java.lang.String... paths)

Ensures that specified directories will exist.

directories

public void directories(@NotNull
                        kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.environment.DirectoryOptions,kotlin.Unit> options)

Allows to distinguish regular directories and caches (cleanable).

hosts

public void hosts(@NotNull
                  kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.environment.hosts.HostOptions,kotlin.Unit> options)

hosts

public void hosts(@NotNull
                  java.lang.String... values)

Defines hosts to be appended to system specific hosts file.

hosts

public void hosts(@NotNull
                  java.lang.Iterable<java.lang.String> names)

Defines hosts to be appended to system specific hosts file.

healthChecks

public void healthChecks(@NotNull
                         kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.environment.health.HealthChecker,kotlin.Unit> options)

Configures environment service health checks.

toString

@NotNull
public java.lang.String toString()

getAem

@NotNull
public AemExtension getAem()