-
- All Implemented Interfaces:
-
java.io.Serializable
public final class LocalInstanceManager implements Serializable
-
-
Field Summary
Fields Modifier and Type Field Description private final InstanceManagerbaseprivate final DirectoryPropertyprojectDirprivate final DirectoryPropertyrootDirprivate final DirectoryPropertyconfigDirprivate final DirectoryPropertyoverrideDirprivate final Property<Source>sourceprivate final Property<OpenMode>openModeprivate final Property<Long>openTimeoutprivate final Property<Long>startTimeoutprivate final Property<Long>stopTimeoutprivate final Property<Long>statusTimeoutprivate final ConfigurableFileCollectionsourceFilesprivate final ListProperty<String>expandFilesprivate final MapProperty<String, Any>expandPropertiesprivate final QuickstartResolverquickstartprivate final BackupManagerbackupprivate final FilebackupZipprivate final InstallResolverinstallprivate final MapProperty<String, String>javaCompatibility
-
Constructor Summary
Constructors Constructor Description LocalInstanceManager(AemExtension aem)
-
Method Summary
Modifier and Type Method Description final Unitsource(String name)final UnitopenMode(String name)final UnitresolveFiles()final Unitquickstart(Function1<QuickstartResolver, Unit> options)Configure AEM source files when creating instances from the scratch. final Unitbackup(Function1<BackupManager, Unit> options)final Unitinstall(Function1<InstallResolver, Unit> options)Configure CRX packages, bundles to be pre-installed on instance(s). final Unitinit(Function1<LocalInstance, Unit> options)Configure action to be performed only once when instance is up first time. final List<LocalInstance>create(LocalInstance instance)final List<LocalInstance>create(Collection<LocalInstance> instances)final UnitcreateBySource(Collection<LocalInstance> instances)final UnitcreateFromBackup(Collection<LocalInstance> instances, File backupZip)final UnitcreateFromScratch(Collection<LocalInstance> instances)final Booleandestroy(LocalInstance instance)final List<LocalInstance>destroy(Collection<LocalInstance> instances)final Booleanup(LocalInstance instance, Function1<AwaitUpAction, Unit> awaitUpOptions)final List<LocalInstance>up(Collection<LocalInstance> instances, Function1<AwaitUpAction, Unit> awaitUpOptions)final Booleandown(LocalInstance instance, Function1<AwaitDownAction, Unit> awaitDownOptions)final List<LocalInstance>down(Collection<LocalInstance> instances, Function1<AwaitDownAction, Unit> awaitDownOptions)final List<LocalInstance>open(LocalInstance instance)final List<LocalInstance>open(Collection<LocalInstance> instances)final List<LocalInstance>kill(LocalInstance instance)final List<LocalInstance>kill(Collection<LocalInstance> instances)final Unitexamine(Collection<LocalInstance> instances)final UnitexaminePrerequisites(Collection<LocalInstance> instances)final UnitexaminePaths()final UnitexamineJavaAvailable()Pre-conditionally check if 'java' is available in shell scripts. final UnitexamineJavaCompatibility(Collection<LocalInstance> instances)final UnitexamineStatusUncorecognized(Collection<LocalInstance> instances)final UnitexamineRunningOther(Collection<LocalInstance> instances)final InstanceManagergetBase()final DirectoryPropertygetProjectDir()Using local AEM instances is acceptable in any project so that lookup for project applying local instance plugin is required Needed to determine e.g directory in which AEM quickstart will be stored and override files. final DirectoryPropertygetRootDir()Path in which local AEM instances will be stored. final DirectoryPropertygetConfigDir()Path for storing local AEM instances related resources. final DirectoryPropertygetOverrideDir()Path from which e.g extra files for local AEM instances will be copied. final Property<Source>getSource()Determines how instances will be created (from backup or quickstart built from the scratch). final Property<OpenMode>getOpenMode()Automatically open a web browser when instances are up. final Property<Long>getOpenTimeout()Maximum time to wait for browser open command response. final Property<Long>getStartTimeout()Maximum time to wait for start script response. final Property<Long>getStopTimeout()Maximum time to wait for stop script response. final Property<Long>getStatusTimeout()Maximum time to wait for status script response. final ConfigurableFileCollectiongetSourceFiles()Collection of files potentially needed to create instance final ListProperty<String>getExpandFiles()Wildcard file name filter expression that is used to filter in which instance files properties can be injected. final MapProperty<String, Any>getExpandProperties()Custom properties that can be injected into instance files. final QuickstartResolvergetQuickstart()final BackupManagergetBackup()Configure AEM backup sources. final FilegetBackupZip()final InstallResolvergetInstall()final MapProperty<String, String>getJavaCompatibility()Defines compatibility related to AEM versions and Java versions. -
-
Constructor Detail
-
LocalInstanceManager
LocalInstanceManager(AemExtension aem)
-
-
Method Detail
-
resolveFiles
final Unit resolveFiles()
-
quickstart
final Unit quickstart(Function1<QuickstartResolver, Unit> options)
Configure AEM source files when creating instances from the scratch.
-
backup
final Unit backup(Function1<BackupManager, Unit> options)
-
install
final Unit install(Function1<InstallResolver, Unit> options)
Configure CRX packages, bundles to be pre-installed on instance(s).
-
init
final Unit init(Function1<LocalInstance, Unit> options)
Configure action to be performed only once when instance is up first time.
-
create
final List<LocalInstance> create(LocalInstance instance)
-
create
final List<LocalInstance> create(Collection<LocalInstance> instances)
-
createBySource
final Unit createBySource(Collection<LocalInstance> instances)
-
createFromBackup
final Unit createFromBackup(Collection<LocalInstance> instances, File backupZip)
-
createFromScratch
final Unit createFromScratch(Collection<LocalInstance> instances)
-
destroy
final Boolean destroy(LocalInstance instance)
-
destroy
final List<LocalInstance> destroy(Collection<LocalInstance> instances)
-
up
final Boolean up(LocalInstance instance, Function1<AwaitUpAction, Unit> awaitUpOptions)
-
up
final List<LocalInstance> up(Collection<LocalInstance> instances, Function1<AwaitUpAction, Unit> awaitUpOptions)
-
down
final Boolean down(LocalInstance instance, Function1<AwaitDownAction, Unit> awaitDownOptions)
-
down
final List<LocalInstance> down(Collection<LocalInstance> instances, Function1<AwaitDownAction, Unit> awaitDownOptions)
-
open
final List<LocalInstance> open(LocalInstance instance)
-
open
final List<LocalInstance> open(Collection<LocalInstance> instances)
-
kill
final List<LocalInstance> kill(LocalInstance instance)
-
kill
final List<LocalInstance> kill(Collection<LocalInstance> instances)
-
examine
final Unit examine(Collection<LocalInstance> instances)
-
examinePrerequisites
final Unit examinePrerequisites(Collection<LocalInstance> instances)
-
examinePaths
final Unit examinePaths()
-
examineJavaAvailable
final Unit examineJavaAvailable()
Pre-conditionally check if 'java' is available in shell scripts.
-
examineJavaCompatibility
final Unit examineJavaCompatibility(Collection<LocalInstance> instances)
-
examineStatusUncorecognized
final Unit examineStatusUncorecognized(Collection<LocalInstance> instances)
-
examineRunningOther
final Unit examineRunningOther(Collection<LocalInstance> instances)
-
getBase
final InstanceManager getBase()
-
getProjectDir
final DirectoryProperty getProjectDir()
Using local AEM instances is acceptable in any project so that lookup for project applying local instance plugin is required Needed to determine e.g directory in which AEM quickstart will be stored and override files.
-
getRootDir
final DirectoryProperty getRootDir()
Path in which local AEM instances will be stored.
-
getConfigDir
final DirectoryProperty getConfigDir()
Path for storing local AEM instances related resources.
-
getOverrideDir
final DirectoryProperty getOverrideDir()
Path from which e.g extra files for local AEM instances will be copied.
-
getSource
final Property<Source> getSource()
Determines how instances will be created (from backup or quickstart built from the scratch).
-
getOpenMode
final Property<OpenMode> getOpenMode()
Automatically open a web browser when instances are up.
-
getOpenTimeout
final Property<Long> getOpenTimeout()
Maximum time to wait for browser open command response.
-
getStartTimeout
final Property<Long> getStartTimeout()
Maximum time to wait for start script response.
-
getStopTimeout
final Property<Long> getStopTimeout()
Maximum time to wait for stop script response.
-
getStatusTimeout
final Property<Long> getStatusTimeout()
Maximum time to wait for status script response.
-
getSourceFiles
final ConfigurableFileCollection getSourceFiles()
Collection of files potentially needed to create instance
-
getExpandFiles
final ListProperty<String> getExpandFiles()
Wildcard file name filter expression that is used to filter in which instance files properties can be injected.
-
getExpandProperties
final MapProperty<String, Any> getExpandProperties()
Custom properties that can be injected into instance files.
-
getQuickstart
final QuickstartResolver getQuickstart()
-
getBackup
final BackupManager getBackup()
Configure AEM backup sources.
-
getBackupZip
final File getBackupZip()
-
getInstall
final InstallResolver getInstall()
-
getJavaCompatibility
final MapProperty<String, String> getJavaCompatibility()
Defines compatibility related to AEM versions and Java versions.
-
-
-
-