com.intershop.gradle.icm.tasks

Class SpawnJavaProcess

com.intershop.gradle.icm.tasks.SpawnJavaProcess

Direct Known Subclasses:

StartICMServer

public class SpawnJavaProcess

Generic task for starting a java process in the background.

Field Detail

Companion

public static com.intershop.gradle.icm.tasks.SpawnJavaProcess.Companion Companion

Constructor Detail

SpawnJavaProcess

public SpawnJavaProcess()

initializes object factory.

Method Detail

provideMain

public void provideMain(@NotNull
                        org.gradle.api.provider.Provider<java.lang.String> mainClass)

Set provider for main class property.

Parameters:

mainClass - set provider for main class.

getMain

@Input
 @NotNull
public java.lang.String getMain()

setMain

public void setMain(@NotNull
                    java.lang.String p)

provideReadyString

public void provideReadyString(@NotNull
                               org.gradle.api.provider.Provider<java.lang.String> readyString)

Set provider for a ready string property.

Parameters:

readyString - set provider for ready string.

getReadyString

@Input
 @NotNull
public java.lang.String getReadyString()

setReadyString

public void setReadyString(@NotNull
                           java.lang.String p)

providerMinHeapSize

public void providerMinHeapSize(@NotNull
                                org.gradle.api.provider.Provider<java.lang.String> minHeapSize)

Set provider for minHeapSize string property.

Parameters:

minHeapSize - minimum memory size.

getMinHeapSize

@Optional
 @Input
 @NotNull
public java.lang.String getMinHeapSize()

setMinHeapSize

public void setMinHeapSize(@NotNull
                           java.lang.String value)

providerMaxHeapSize

public void providerMaxHeapSize(@NotNull
                                org.gradle.api.provider.Provider<java.lang.String> maxHeapSize)

Set provider for maxHeapSize string property.

Parameters:

maxHeapSize - maximum memory size.

getMaxHeapSize

@Optional
 @Input
 @NotNull
public java.lang.String getMaxHeapSize()

setMaxHeapSize

public void setMaxHeapSize(@NotNull
                           java.lang.String value)

getWorkingDir

@Optional
 @Input
 @NotNull
public java.io.File getWorkingDir()

The workingDir is used for the execution of the java process.

setWorkingDir

public void setWorkingDir(@NotNull
                          java.io.File value)

The workingDir is used for the execution of the java process.

getPidFile

@OutputFile
 @NotNull
public java.io.File getPidFile()

The file will contain the pid of the process. As long this file exists, it should be not possible to spawn a new prcess.

setPidFile

public void setPidFile(@NotNull
                       java.io.File value)

The file will contain the pid of the process. As long this file exists, it should be not possible to spawn a new prcess.

getClasspath

@Classpath
 @NotNull
public org.gradle.api.file.FileCollection getClasspath()

This file collection contains the main class and all necessary class files for execution.

setClasspath

public void setClasspath(@NotNull
                         org.gradle.api.file.FileCollection value)

This file collection contains the main class and all necessary class files for execution.

providerJvmArgs

public void providerJvmArgs(@NotNull
                            org.gradle.api.provider.Provider<java.util.List> jvmArgs)

Set provider for JVM arguments.

Parameters:

jvmArgs - list of JVM arguments.

getJvmArgs

@Input
 @NotNull
public java.util.List<java.lang.String> getJvmArgs()

This list contains parameters for the jvm.

setJvmArgs

public void setJvmArgs(@NotNull
                       java.util.List<java.lang.String> p)

This list contains parameters for the jvm.

jvmArgs

public void jvmArgs(@NotNull
                    java.lang.Object... jvmArgs)

Add JVM args to the list of JVM args.

Parameters:

jvmArgs - one ore more JVM arguments.

jvmArgs

public void jvmArgs(@NotNull
                    java.lang.Iterable<? extends java.lang.Object> jvmArgs)

Add a list of JVM args to the list of JVM args.

Parameters:

jvmArgs - list of JVM arguments.

providerArgs

public void providerArgs(@NotNull
                         org.gradle.api.provider.Provider<java.util.List> args)

Set provider for arguments passed to the main class.

Parameters:

args - list of arguments.

getArgs

@Input
 @NotNull
public java.util.List<java.lang.String> getArgs()

This list contains parameters passed to the main java class.

setArgs

public void setArgs(@NotNull
                    java.util.List<java.lang.String> p)

This list contains parameters passed to the main java class.

args

public void args(@NotNull
                 java.lang.Object... args)

Add args to the list of args passed to the main class.

Parameters:

args - one ore more arguments.

args

public void args(@NotNull
                 java.lang.Iterable<? extends java.lang.Object> args)

Add a list of args to the list of args passed to the main class.

Parameters:

args - list of arguments.

argsString

public void argsString(@NotNull
                       java.lang.String args)

Command line arguments passed to the main class. This list will replace the configured parameters.

Parameters:

args - string of parameters.

providerEnvironment

public void providerEnvironment(@NotNull
                                org.gradle.api.provider.Provider<java.util.Map> environment)

Set provider for environment.

Parameters:

environment - provider for environment map.

getEnvironment

@Input
 @NotNull
public java.util.Map<java.lang.String,java.lang.Object> getEnvironment()

This map contains environment properties.

setEnvironment

public void setEnvironment(@NotNull
                           java.util.Map<java.lang.String,? extends java.lang.Object> value)

This map contains environment properties.

environment

public void environment(@NotNull
                        java.util.Map<java.lang.String,? extends java.lang.Object> env)

Add a map of environment variables to the map of environment variables.

Parameters:

env - map of environment variables.

environment

public void environment(@NotNull
                        java.lang.String key,
                        @NotNull
                        java.lang.Object value)

Add a new key value pair to the environment variables.

Parameters:

key - name of environment variable.

value - value of environment variable.

providerSystemProperties

public void providerSystemProperties(@NotNull
                                     org.gradle.api.provider.Provider<java.util.Map> systemProperties)

Set provider for system properties.

Parameters:

systemProperties - provider for system properties map.

getSystemProperties

@Input
 @NotNull
public java.util.Map<java.lang.String,java.lang.Object> getSystemProperties()

This map contains system properties.

setSystemProperties

public void setSystemProperties(@NotNull
                                java.util.Map<java.lang.String,? extends java.lang.Object> value)

This map contains system properties.

systemProperties

public void systemProperties(@NotNull
                             java.util.Map<java.lang.String,? extends java.lang.Object> props)

Add a map of system properties to the map of system properties.

systemProperty

public void systemProperty(@NotNull
                           java.lang.String key,
                           @NotNull
                           java.lang.Object value)

Add a new key value pair to the map of system properties.

Parameters:

key - name of system property.

value - value of system property.

getDebug

public boolean getDebug()

Enable debugging for the process. The process is started suspended and listening on port 5005. This can be configured also over the gradle parameter "debug-java".

getDebugOptions

@NotNull
public org.gradle.process.JavaDebugOptions getDebugOptions()

This get the available debug configuration for the java process.

debugOptions

public void debugOptions(@NotNull
                         org.gradle.api.Action<org.gradle.process.JavaDebugOptions> action)

Configures the debug options for this java process.

Parameters:

action - new configuration for debug options.

getValueString

@NotNull
public java.lang.String getValueString(@NotNull
                                                java.lang.Object v)

spawnProcess

public void spawnProcess()

Task action starts the java process in the background.