All Implemented Interfaces:

kotlin.Comparable , org.gradle.api.Named , org.gradle.api.Task , org.gradle.api.internal.DynamicObjectAware , org.gradle.api.internal.TaskInternal , org.gradle.api.plugins.ExtensionAware , org.gradle.util.Configurable
```
public class DBPrepareTask
extends AbstractICMASContainerTask<RedirectToLoggerCallback, RedirectToLoggerCallback, Long>
                    
```
Task to run dbPrepare on a running container.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public final static String`	`TASK_NAME`
`private final Property<String>`	`mode`
`private final Property<String>`	`clean`
`private final Property<String>`	`cartridges`
`private final Property<String>`	`propertyKeys`
`private List<String>`	`additionalParameters`
`private final Property<DevelopmentConfiguration.DatabaseParameters>`	`databaseConfiguration`
`private final Property<DevelopmentConfiguration.WebserverConfiguration>`	`webserverConfiguration`
`private final Property<DevelopmentConfiguration.ASPortConfiguration>`	`portConfiguration`
`private final SetProperty<String>`	`cartridgeList`
`private final SetProperty<String>`	`testCartridgeList`
`private String`	`debug`
`private String`	`classpathLayout`
`private final Property<ContainerHandle>`	`container`
`private final Property<String>`	`url`
`private final DirectoryProperty`	`certPath`
`private final Property<String>`	`apiVersion`
`private final Property<DockerClientService>`	`dockerClientService`
`private Boolean`	`enabled`
`private String`	`description`
`private String`	`group`
`private final Property<Duration>`	`timeout`
`private final TaskStateInternal`	`state`
`private Boolean`	`impliesSubProjects`
`private final Boolean`	`hasCustomActions`

Constructor Summary

Constructors
Constructor	Description
`DBPrepareTask(Project project, ProgressLoggerFactory progressLoggerFactory)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Property<String>`	`getMode()`
`final Property<String>`	`getClean()`
`final Property<String>`	`getCartridges()`
`final Property<String>`	`getPropertyKeys()`
`final List<String>`	`getAdditionalParameters()`
`final Unit`	`setAdditionalParameters(List<String> additionalParameters)`
`final Collection<String>`	`getNodeValues()`	Return the possible values for the task option mode
`final Collection<String>`	`getCleanDBValues()`	Return the possible values for the task option clean
`final static ContainerEnvironment`	`createDBPrepareEnvironment(String jmxHost)`	Creates the environment the dbPrepare process inside the container is started with.

Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractICMASContainerTask
getCartridgeList, getClasspathLayout, getDatabaseConfiguration, getDebug, getDebugOptionValues, getPortConfiguration, getTestCartridgeList, getWebserverConfiguration, runRemoteCommand, setClasspathLayout, setDebug
Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractContainerTask
currentContainerState, getContainer, getContainer
Methods inherited from class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
getApiVersion, getCertPath, getDockerClient, getDockerClientService, getUrl, onComplete, onError, onNext, start
Methods inherited from class org.gradle.api.internal.AbstractTask
acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects
Methods inherited from class org.gradle.api.DefaultTask
compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService
Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractExistingContainerTask
executeUsing
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DBPrepareTask
```
DBPrepareTask(Project project, ProgressLoggerFactory progressLoggerFactory)
```
- Method Detail
  - getMode
```
@Input() final Property<String> getMode()
```
  - getClean
```
@Input() final Property<String> getClean()
```
  - getCartridges
```
@Input() final Property<String> getCartridges()
```
  - getPropertyKeys
```
@Input() final Property<String> getPropertyKeys()
```
  - getAdditionalParameters
```
@Input() final List<String> getAdditionalParameters()
```
  - setAdditionalParameters
```
 final Unit setAdditionalParameters(List<String> additionalParameters)
```
  - getNodeValues
```
 final Collection<String> getNodeValues()
```
    Return the possible values for the task option mode
  - getCleanDBValues
```
 final Collection<String> getCleanDBValues()
```
    Return the possible values for the task option clean
  - createDBPrepareEnvironment
```
 final static ContainerEnvironment createDBPrepareEnvironment(String jmxHost)
```
    Creates the environment the dbPrepare process inside the container is started with.
    The preparation progress is exposed by that process as JMX attributes, so the JMX connector of the container is enabled. The RMI stubs it hands out are created for jmxHost, otherwise they would refer to an address that cannot be resolved outside the container.
    
    Parameters:
    
    jmxHost - the host the JMX connector of the container is reachable at
    
    Returns:
    
    the environment variables to be added to the ones of the container

Class DBPrepareTask

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractICMASContainerTask

Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractContainerTask

Methods inherited from class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask

Methods inherited from class org.gradle.api.internal.AbstractTask

Methods inherited from class org.gradle.api.DefaultTask

Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractExistingContainerTask

Methods inherited from class java.lang.Object

Constructor Detail

DBPrepareTask

Method Detail

getMode

getClean

getCartridges

getPropertyKeys

getAdditionalParameters

setAdditionalParameters

getNodeValues

getCleanDBValues

createDBPrepareEnvironment