com.cognifide.gradle.aem.common.instance

Class InstanceOptions

com.cognifide.gradle.aem.common.instance.InstanceOptions

public class InstanceOptions

Constructor Summary

Constructors

Constructor and Description
InstanceOptions(AemExtension aem)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,com.cognifide.gradle.aem.common.instance.Instance>	getDefined() List of AEM instances on which packages could be deployed. Instance stored in map ensures name uniqueness and allows to be referenced in expanded properties.
boolean	getStatusProperties() Allows to control automatic system properties (and product version) gathering from running instance to defined. Essential for correctly working features that are using timestamps like instance tail and instance events check.
void	http(kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.instance.InstanceHttpClient,? super com.cognifide.gradle.aem.common.instance.Instance,kotlin.Unit> options) Customize HTTP connection to AEM instances.
void	local(java.lang.String httpUrl) Define local instance (created on local file system).
void	local(java.lang.String httpUrl, java.lang.String name) Define local instance (created on local file system).
void	local(java.lang.String httpUrl, kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.LocalInstance,kotlin.Unit> options) Define local instance (created on local file system).
Instance	parse(java.lang.String urlOrName) Get defined instance by name or create temporary definition if URL provided.
void	remote(java.lang.String httpUrl) Define remote instance (available on any host).
void	remote(java.lang.String httpUrl, java.lang.String name) Define remote instance (available on any host).
void	remote(java.lang.String httpUrl, kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.RemoteInstance,kotlin.Unit> options) Define remote instance (available on any host).
void	setStatusProperties(boolean p) Allows to control automatic system properties (and product version) gathering from running instance to defined. Essential for correctly working features that are using timestamps like instance tail and instance events check.

Constructor Detail

InstanceOptions

public InstanceOptions(@NotNull
                       AemExtension aem)

Method Detail

getDefined

@NotNull
public java.util.Map<java.lang.String,com.cognifide.gradle.aem.common.instance.Instance> getDefined()

List of AEM instances on which packages could be deployed. Instance stored in map ensures name uniqueness and allows to be referenced in expanded properties.

http

public void http(@NotNull
                 kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.instance.InstanceHttpClient,? super com.cognifide.gradle.aem.common.instance.Instance,kotlin.Unit> options)

Customize HTTP connection to AEM instances.

Allows to e.g

• set using HTTP proxy,

• customize maximum time after which initializing connection to AEM will be aborted (e.g on upload, install),

• customize any options offered by Apache HTTP Client builder (use its API directly).

getStatusProperties

public boolean getStatusProperties()

Allows to control automatic system properties (and product version) gathering from running instance to defined. Essential for correctly working features that are using timestamps like instance tail and instance events check.

setStatusProperties

public void setStatusProperties(boolean p)

Allows to control automatic system properties (and product version) gathering from running instance to defined. Essential for correctly working features that are using timestamps like instance tail and instance events check.

local

public void local(@NotNull
                  java.lang.String httpUrl)

Define local instance (created on local file system).

local

public void local(@NotNull
                  java.lang.String httpUrl,
                  @NotNull
                  java.lang.String name)

Define local instance (created on local file system).

local

public void local(@NotNull
                  java.lang.String httpUrl,
                  @NotNull
                  kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.LocalInstance,kotlin.Unit> options)

Define local instance (created on local file system).

remote

public void remote(@NotNull
                   java.lang.String httpUrl)

Define remote instance (available on any host).

remote

public void remote(@NotNull
                   java.lang.String httpUrl,
                   @NotNull
                   java.lang.String name)

Define remote instance (available on any host).

remote

public void remote(@NotNull
                   java.lang.String httpUrl,
                   @NotNull
                   kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.instance.RemoteInstance,kotlin.Unit> options)

Define remote instance (available on any host).

parse

@NotNull
public Instance parse(@NotNull
                                java.lang.String urlOrName)

Get defined instance by name or create temporary definition if URL provided.