configureBootJarTask() — spring-boot Function Reference

Architecture documentation for the configureBootJarTask() function in JavaPluginAction.java from the spring-boot codebase.

Function java GradlePlugin DslExtensions calls 4 called by 1

Entity Profile

GradlePlugin→ DslExtensions→ configureBootJarTask() — spring-boot Function Reference

Dependency Diagram

graph TD
  073b5c5b_d4f1_8dea_f6e8_ba349c56084b["configureBootJarTask()"]
  74d8bc31_4ba2_e112_795c_80c2cc344e68["execute()"]
  74d8bc31_4ba2_e112_795c_80c2cc344e68 -->|calls| 073b5c5b_d4f1_8dea_f6e8_ba349c56084b
  b1f4e7fa_6dcd_b75c_aa6b_c18c1f1bfb52["javaPluginExtension()"]
  073b5c5b_d4f1_8dea_f6e8_ba349c56084b -->|calls| b1f4e7fa_6dcd_b75c_aa6b_c18c1f1bfb52
  f716b505_786b_8a0f_3ef5_bdaf043f7d3b["classpath()"]
  073b5c5b_d4f1_8dea_f6e8_ba349c56084b -->|calls| f716b505_786b_8a0f_3ef5_bdaf043f7d3b
  62834ef2_58c4_85a5_f697_b49484bec757["getMainClass()"]
  073b5c5b_d4f1_8dea_f6e8_ba349c56084b -->|calls| 62834ef2_58c4_85a5_f697_b49484bec757
  a92f6b53_10a2_29f1_0d8d_366dafe433e7["resolvedArtifacts()"]
  073b5c5b_d4f1_8dea_f6e8_ba349c56084b -->|calls| a92f6b53_10a2_29f1_0d8d_366dafe433e7
  style 073b5c5b_d4f1_8dea_f6e8_ba349c56084b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

build-plugin/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/plugin/JavaPluginAction.java lines 161–191

	private TaskProvider<BootJar> configureBootJarTask(Project project,
			TaskProvider<ResolveMainClassName> resolveMainClassName) {
		SourceSet mainSourceSet = javaPluginExtension(project).getSourceSets()
			.getByName(SourceSet.MAIN_SOURCE_SET_NAME);
		Configuration developmentOnly = project.getConfigurations()
			.getByName(SpringBootPlugin.DEVELOPMENT_ONLY_CONFIGURATION_NAME);
		Configuration testAndDevelopmentOnly = project.getConfigurations()
			.getByName(SpringBootPlugin.TEST_AND_DEVELOPMENT_ONLY_CONFIGURATION_NAME);
		Configuration productionRuntimeClasspath = project.getConfigurations()
			.getByName(SpringBootPlugin.PRODUCTION_RUNTIME_CLASSPATH_CONFIGURATION_NAME);
		Configuration runtimeClasspath = project.getConfigurations()
			.getByName(mainSourceSet.getRuntimeClasspathConfigurationName());
		Callable<FileCollection> classpath = () -> mainSourceSet.getRuntimeClasspath()
			.minus((developmentOnly.minus(productionRuntimeClasspath)))
			.minus((testAndDevelopmentOnly.minus(productionRuntimeClasspath)))
			.filter(new JarTypeFileSpec());
		return project.getTasks().register(SpringBootPlugin.BOOT_JAR_TASK_NAME, BootJar.class, (bootJar) -> {
			bootJar.setDescription(
					"Assembles an executable jar archive containing the main classes and their dependencies.");
			bootJar.setGroup(BasePlugin.BUILD_GROUP);
			bootJar.classpath(classpath);
			Provider<String> manifestStartClass = project
				.provider(() -> (String) bootJar.getManifest().getAttributes().get("Start-Class"));
			bootJar.getMainClass()
				.convention(resolveMainClassName.flatMap((resolver) -> manifestStartClass.isPresent()
						? manifestStartClass : resolver.readMainClassName()));
			bootJar.getTargetJavaVersion()
				.set(project.provider(() -> javaPluginExtension(project).getTargetCompatibility()));
			bootJar.resolvedArtifacts(runtimeClasspath.getIncoming().getArtifacts().getResolvedArtifacts());
		});
	}