spring-boot:start

Full name:

org.springframework.boot:spring-boot-maven-plugin:2.1.5.RELEASE:start

Description:

Start a spring application. Contrary to the run goal, this does not block and allows other goal to operate on the application. This goal is typically used in integration test scenario where the application is started before a test suite and stopped after.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Since version: 1.3.0.
  • Binds by default to the lifecycle phase: pre-integration-test.

Required Parameters

Name Type Since Description
classesDirectory File 1.0 Directory containing the classes and resource files that should be packaged into the archive.
Default value is: ${project.build.outputDirectory}.

Optional Parameters

Name Type Since Description
addResources boolean 1.0 Add maven resources to the classpath directly, this allows live in-place editing of resources. Duplicate resources are removed from target/classes to prevent them to appear twice if ClassLoader.getResources() is called. Please consider adding spring-boot-devtools to your project instead as it provides this feature and many more.
Default value is: false.
User property is: spring-boot.run.addResources.
agent File[] 1.0 Path to agent jar. NOTE: the use of agents means that processes will be started by forking a new JVM.
User property is: spring-boot.run.agent.
arguments String[] 1.0 Arguments that should be passed to the application. On command line use commas to separate multiple arguments.
User property is: spring-boot.run.arguments.
environmentVariables Map 2.1 List of Environment variables that should be associated with the forked process used to run the application. NOTE: the use of Environment variables means that processes will be started by forking a new JVM.
excludeGroupIds String 1.1 Comma separated list of groupId names to exclude (exact match).
User property is: spring-boot.excludeGroupIds.
excludes List 1.1 Collection of artifact definitions to exclude. The Exclude element defines a groupId and artifactId mandatory properties and an optional classifier property.
User property is: spring-boot.excludes.
folders String[] 1.0 Additional folders besides the classes directory that should be added to the classpath.
User property is: spring-boot.run.folders.
fork Boolean 1.2 Flag to indicate if the run processes should be forked. fork is automatically enabled if an agent, jvmArguments or working directory are specified, or if devtools is present.
User property is: spring-boot.run.fork.
includes List 1.2 Collection of artifact definitions to include. The Include element defines a groupId and artifactId mandatory properties and an optional classifier property.
User property is: spring-boot.includes.
jmxName String 1.3.0 The JMX name of the automatically deployed MBean managing the lifecycle of the spring application.
jmxPort int 1.3.0 The port to use to expose the platform MBeanServer if the application needs to be forked.
jvmArguments String 1.1 JVM arguments that should be associated with the forked process used to run the application. On command line, make sure to wrap multiple values between quotes. NOTE: the use of JVM arguments means that processes will be started by forking a new JVM.
User property is: spring-boot.run.jvmArguments.
mainClass String 1.0 The name of the main class. If not specified the first compiled class found that contains a 'main' method will be used.
User property is: spring-boot.run.main-class.
maxAttempts int 1.3.0 The maximum number of attempts to check if the spring application is ready. Combined with the "wait" argument, this gives a global timeout value (30 sec by default)
noverify boolean 1.0 Flag to say that the agent requires -noverify.
User property is: spring-boot.run.noverify.
profiles String[] 1.3 The spring profiles to activate. Convenience shortcut of specifying the 'spring.profiles.active' argument. On command line use commas to separate multiple profiles.
User property is: spring-boot.run.profiles.
skip boolean 1.3.2 Skip the execution.
Default value is: false.
User property is: spring-boot.run.skip.
systemPropertyVariables Map 2.1 List of JVM system properties to pass to the process. NOTE: the use of system properties means that processes will be started by forking a new JVM.
useTestClasspath Boolean 1.3 Flag to include the test classpath when running.
Default value is: false.
User property is: spring-boot.run.useTestClasspath.
wait long 1.3.0 The number of milli-seconds to wait between each attempt to check if the spring application is ready.
workingDirectory File 1.5 Current working directory to use for the application. If not specified, basedir will be used. NOTE: the use of working directory means that processes will be started by forking a new JVM.
User property is: spring-boot.run.workingDirectory.

Parameter Details

addResources:

Add maven resources to the classpath directly, this allows live in-place editing of resources. Duplicate resources are removed from target/classes to prevent them to appear twice if ClassLoader.getResources() is called. Please consider adding spring-boot-devtools to your project instead as it provides this feature and many more.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: spring-boot.run.addResources
  • Default: false

agent:

Path to agent jar. NOTE: the use of agents means that processes will be started by forking a new JVM.
  • Type: java.io.File[]
  • Since: 1.0
  • Required: No
  • User Property: spring-boot.run.agent

arguments:

Arguments that should be passed to the application. On command line use commas to separate multiple arguments.
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No
  • User Property: spring-boot.run.arguments

classesDirectory:

Directory containing the classes and resource files that should be packaged into the archive.
  • Type: java.io.File
  • Since: 1.0
  • Required: Yes
  • Default: ${project.build.outputDirectory}

environmentVariables:

List of Environment variables that should be associated with the forked process used to run the application. NOTE: the use of Environment variables means that processes will be started by forking a new JVM.
  • Type: java.util.Map
  • Since: 2.1
  • Required: No

excludeGroupIds:

Comma separated list of groupId names to exclude (exact match).
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: spring-boot.excludeGroupIds

excludes:

Collection of artifact definitions to exclude. The Exclude element defines a groupId and artifactId mandatory properties and an optional classifier property.
  • Type: java.util.List
  • Since: 1.1
  • Required: No
  • User Property: spring-boot.excludes

folders:

Additional folders besides the classes directory that should be added to the classpath.
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No
  • User Property: spring-boot.run.folders

fork:

Flag to indicate if the run processes should be forked. fork is automatically enabled if an agent, jvmArguments or working directory are specified, or if devtools is present.
  • Type: java.lang.Boolean
  • Since: 1.2
  • Required: No
  • User Property: spring-boot.run.fork

includes:

Collection of artifact definitions to include. The Include element defines a groupId and artifactId mandatory properties and an optional classifier property.
  • Type: java.util.List
  • Since: 1.2
  • Required: No
  • User Property: spring-boot.includes

jmxName:

The JMX name of the automatically deployed MBean managing the lifecycle of the spring application.
  • Type: java.lang.String
  • Since: 1.3.0
  • Required: No

jmxPort:

The port to use to expose the platform MBeanServer if the application needs to be forked.
  • Type: int
  • Since: 1.3.0
  • Required: No

jvmArguments:

JVM arguments that should be associated with the forked process used to run the application. On command line, make sure to wrap multiple values between quotes. NOTE: the use of JVM arguments means that processes will be started by forking a new JVM.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: spring-boot.run.jvmArguments

mainClass:

The name of the main class. If not specified the first compiled class found that contains a 'main' method will be used.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: spring-boot.run.main-class

maxAttempts:

The maximum number of attempts to check if the spring application is ready. Combined with the "wait" argument, this gives a global timeout value (30 sec by default)
  • Type: int
  • Since: 1.3.0
  • Required: No

noverify:

Flag to say that the agent requires -noverify.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: spring-boot.run.noverify

profiles:

The spring profiles to activate. Convenience shortcut of specifying the 'spring.profiles.active' argument. On command line use commas to separate multiple profiles.
  • Type: java.lang.String[]
  • Since: 1.3
  • Required: No
  • User Property: spring-boot.run.profiles

skip:

Skip the execution.
  • Type: boolean
  • Since: 1.3.2
  • Required: No
  • User Property: spring-boot.run.skip
  • Default: false

systemPropertyVariables:

List of JVM system properties to pass to the process. NOTE: the use of system properties means that processes will be started by forking a new JVM.
  • Type: java.util.Map
  • Since: 2.1
  • Required: No

useTestClasspath:

Flag to include the test classpath when running.
  • Type: java.lang.Boolean
  • Since: 1.3
  • Required: No
  • User Property: spring-boot.run.useTestClasspath
  • Default: false

wait:

The number of milli-seconds to wait between each attempt to check if the spring application is ready.
  • Type: long
  • Since: 1.3.0
  • Required: No

workingDirectory:

Current working directory to use for the application. If not specified, basedir will be used. NOTE: the use of working directory means that processes will be started by forking a new JVM.
  • Type: java.io.File
  • Since: 1.5
  • Required: No
  • User Property: spring-boot.run.workingDirectory