A B C D E F G H I J K L M N O P R S T W

A

AbstractJarWriter - Class in org.springframework.boot.loader.tools

Abstract base class for JAR writers.

AbstractJarWriter() - Constructor for class org.springframework.boot.loader.tools.AbstractJarWriter

addMainClassTimeoutWarningListener(Packager.MainClassTimeoutWarningListener) - Method in class org.springframework.boot.loader.tools.Packager

Add a listener that will be triggered to display a warning if searching for the main class takes too long.

APPLICATION - Static variable in class org.springframework.boot.loader.tools.StandardLayers

The application layer.

attachSignalHandler(Runnable) - Static method in class org.springframework.boot.loader.tools.SignalUtils

Handle INT signals by calling the specified Runnable.

B

BuildPropertiesWriter - Class in org.springframework.boot.loader.tools

A BuildPropertiesWriter writes the build-info.properties for consumption by the Actuator.

BuildPropertiesWriter(File) - Constructor for class org.springframework.boot.loader.tools.BuildPropertiesWriter

Creates a new BuildPropertiesWriter that will write to the given outputFile.

BuildPropertiesWriter.NullAdditionalPropertyValueException - Exception in org.springframework.boot.loader.tools

Exception thrown when an additional property with a null value is encountered.

BuildPropertiesWriter.ProjectDetails - Class in org.springframework.boot.loader.tools

Build-system agnostic details of a project.

C

close() - Method in class org.springframework.boot.loader.tools.JarWriter

Close the writer.

COMPILE - Static variable in interface org.springframework.boot.loader.tools.LibraryScope

The library is used at compile time and runtime.

createBuildInfo(BuildPropertiesWriter.ProjectDetails) - Method in class org.springframework.boot.loader.tools.BuildPropertiesWriter

CUSTOM - Static variable in interface org.springframework.boot.loader.tools.LibraryScope

Marker for custom scope when custom configuration is used.

CustomLoaderLayout - Interface in org.springframework.boot.loader.tools

Additional interface that can be implemented by Layouts that write their own loader classes.

D

DefaultLaunchScript - Class in org.springframework.boot.loader.tools

Default implementation of LaunchScript.

DefaultLaunchScript(File, Map<?, ?>) - Constructor for class org.springframework.boot.loader.tools.DefaultLaunchScript

Create a new DefaultLaunchScript instance.

DefaultLayoutFactory - Class in org.springframework.boot.loader.tools

Default implementation of LayoutFactory.

DefaultLayoutFactory() - Constructor for class org.springframework.boot.loader.tools.DefaultLayoutFactory

DEPENDENCIES - Static variable in class org.springframework.boot.loader.tools.StandardLayers

The dependencies layer.

doWithLibraries(LibraryCallback) - Method in interface org.springframework.boot.loader.tools.Libraries

Iterate all relevant libraries.

E

EntryWriter - Interface in org.springframework.boot.loader.tools

Interface used to write jar entry data.

equals(Object) - Method in class org.springframework.boot.loader.tools.Layer

Expanded() - Constructor for class org.springframework.boot.loader.tools.Layouts.Expanded

F

FileUtils - Class in org.springframework.boot.loader.tools

Utilities for manipulating files and directories in Spring Boot tooling.

FileUtils() - Constructor for class org.springframework.boot.loader.tools.FileUtils

findMainClass(File) - Static method in class org.springframework.boot.loader.tools.MainClassFinder

Find the main class from a given folder.

findMainClass(JarFile, String) - Static method in class org.springframework.boot.loader.tools.MainClassFinder

Find the main class in a given jar file.

findMainMethod(JarFile) - Method in class org.springframework.boot.loader.tools.Packager

findSingleMainClass(File) - Static method in class org.springframework.boot.loader.tools.MainClassFinder

Find a single main class from the given rootFolder.

findSingleMainClass(File, String) - Static method in class org.springframework.boot.loader.tools.MainClassFinder

Find a single main class from the given rootFolder.

findSingleMainClass(JarFile, String) - Static method in class org.springframework.boot.loader.tools.MainClassFinder

Find a single main class in a given jar file.

findSingleMainClass(JarFile, String, String) - Static method in class org.springframework.boot.loader.tools.MainClassFinder

Find a single main class in a given jar file.

forFile(File) - Static method in class org.springframework.boot.loader.tools.Layouts

Return a layout for the given source file.

G

getAdditionalProperties() - Method in class org.springframework.boot.loader.tools.BuildPropertiesWriter.ProjectDetails

getArtifact() - Method in class org.springframework.boot.loader.tools.BuildPropertiesWriter.ProjectDetails

getBackupFile() - Method in class org.springframework.boot.loader.tools.Packager

Return the File to use to backup the original source.

getClassesLocation() - Method in interface org.springframework.boot.loader.tools.Layout

Returns the location of classes within the archive.

getClassesLocation() - Method in class org.springframework.boot.loader.tools.Layouts.Jar

getClassesLocation() - Method in class org.springframework.boot.loader.tools.Layouts.War

getClasspathIndexFileLocation() - Method in class org.springframework.boot.loader.tools.Layouts.Jar

getClasspathIndexFileLocation() - Method in interface org.springframework.boot.loader.tools.RepackagingLayout

Returns the location of the classpath index file that should be written or null if not index is required.

getFile() - Method in class org.springframework.boot.loader.tools.Library

Return the library file.

getGroup() - Method in class org.springframework.boot.loader.tools.BuildPropertiesWriter.ProjectDetails

getLauncherClassName() - Method in interface org.springframework.boot.loader.tools.Layout

Returns the launcher class name for this layout.

getLauncherClassName() - Method in class org.springframework.boot.loader.tools.Layouts.Expanded

getLauncherClassName() - Method in class org.springframework.boot.loader.tools.Layouts.Jar

getLauncherClassName() - Method in class org.springframework.boot.loader.tools.Layouts.None

getLauncherClassName() - Method in class org.springframework.boot.loader.tools.Layouts.War

getLayer(String) - Method in interface org.springframework.boot.loader.tools.Layers

Return the layer that contains the given resource name.

getLayer(Library) - Method in interface org.springframework.boot.loader.tools.Layers

Return the layer that contains the given library.

getLayersIndexFileLocation() - Method in interface org.springframework.boot.loader.tools.LayeredLayout

Returns the location of the layers index file that should be written or null if not index is required.

getLayersIndexFileLocation() - Method in class org.springframework.boot.loader.tools.Layouts.LayeredJar

getLayout(File) - Method in class org.springframework.boot.loader.tools.DefaultLayoutFactory

getLayout(File) - Method in interface org.springframework.boot.loader.tools.LayoutFactory

Return a Layout for the specified source file.

getLayout() - Method in class org.springframework.boot.loader.tools.Packager

getLibraryDestination(String, LibraryScope) - Method in interface org.springframework.boot.loader.tools.Layout

Deprecated.

since 2.3.0 in favor of Layout.getLibraryLocation(java.lang.String, org.springframework.boot.loader.tools.LibraryScope)

getLibraryDestination(String, LibraryScope) - Method in class org.springframework.boot.loader.tools.Layouts.Jar

Deprecated.

getLibraryDestination(String, LibraryScope) - Method in class org.springframework.boot.loader.tools.Layouts.War

Deprecated.

getLibraryLocation(String, LibraryScope, Layer) - Method in interface org.springframework.boot.loader.tools.LayeredLayout

Returns the destination path for a given library within the context of a layer.

getLibraryLocation(String, LibraryScope) - Method in interface org.springframework.boot.loader.tools.Layout

Returns the destination path for a given library.

getLibraryLocation(String, LibraryScope) - Method in class org.springframework.boot.loader.tools.Layouts.Jar

getLibraryLocation(String, LibraryScope, Layer) - Method in class org.springframework.boot.loader.tools.Layouts.LayeredJar

getLibraryLocation(String, LibraryScope) - Method in class org.springframework.boot.loader.tools.Layouts.War

getName() - Method in class org.springframework.boot.loader.tools.BuildPropertiesWriter.ProjectDetails

getName() - Method in class org.springframework.boot.loader.tools.Library

Return the name of file as it should be written.

getRepackagedClassesLocation(Layer) - Method in interface org.springframework.boot.loader.tools.LayeredLayout

Returns the location to which classes should be moved within the context of a layer.

getRepackagedClassesLocation() - Method in class org.springframework.boot.loader.tools.Layouts.Jar

getRepackagedClassesLocation(Layer) - Method in class org.springframework.boot.loader.tools.Layouts.LayeredJar

getRepackagedClassesLocation() - Method in interface org.springframework.boot.loader.tools.RepackagingLayout

Returns the location to which classes should be moved.

getRunningProcess() - Method in class org.springframework.boot.loader.tools.RunProcess

Return the running process.

getScope() - Method in class org.springframework.boot.loader.tools.Library

Return the scope of the library.

getSource() - Method in class org.springframework.boot.loader.tools.Packager

getTime() - Method in class org.springframework.boot.loader.tools.BuildPropertiesWriter.ProjectDetails

getVersion() - Method in class org.springframework.boot.loader.tools.BuildPropertiesWriter.ProjectDetails

H

handleSigInt() - Method in class org.springframework.boot.loader.tools.RunProcess

Return if the process was stopped.

handleTimeoutWarning(long, String) - Method in interface org.springframework.boot.loader.tools.Packager.MainClassTimeoutWarningListener

Handle a timeout warning.

hashCode() - Method in class org.springframework.boot.loader.tools.Layer

hasJustEnded() - Method in class org.springframework.boot.loader.tools.RunProcess

I

ImagePackager - Class in org.springframework.boot.loader.tools

Utility class that can be used to export a fully packaged archive to an OCI image.

ImagePackager(File) - Constructor for class org.springframework.boot.loader.tools.ImagePackager

Create a new ImagePackager instance.

IMPLICIT - Static variable in interface org.springframework.boot.loader.tools.Layers

The default layer resolver.

initialize() - Static method in class org.springframework.boot.loader.tools.LogbackInitializer

isAlreadyPackaged() - Method in class org.springframework.boot.loader.tools.Packager

isAlreadyPackaged(File) - Method in class org.springframework.boot.loader.tools.Packager

isExecutable() - Method in interface org.springframework.boot.loader.tools.Layout

Returns if loader classes should be included to make the archive executable.

isExecutable() - Method in class org.springframework.boot.loader.tools.Layouts.Jar

isExecutable() - Method in class org.springframework.boot.loader.tools.Layouts.None

isExecutable() - Method in class org.springframework.boot.loader.tools.Layouts.War

isUnpackRequired() - Method in class org.springframework.boot.loader.tools.Library

Return if the file cannot be used directly as a nested jar and needs to be unpacked.

iterator() - Method in interface org.springframework.boot.loader.tools.Layers

Return the jar layers in the order that they should be added (starting with the least frequently changed layer).

iterator() - Method in class org.springframework.boot.loader.tools.StandardLayers

J

Jar() - Constructor for class org.springframework.boot.loader.tools.Layouts.Jar

JarWriter - Class in org.springframework.boot.loader.tools

Writes JAR content, ensuring valid directory entries are always created and duplicate items are ignored.

JarWriter(File) - Constructor for class org.springframework.boot.loader.tools.JarWriter

Create a new JarWriter instance.

JarWriter(File, LaunchScript) - Constructor for class org.springframework.boot.loader.tools.JarWriter

Create a new JarWriter instance.

JavaExecutable - Class in org.springframework.boot.loader.tools

Provides access to the java binary executable, regardless of OS.

JavaExecutable() - Constructor for class org.springframework.boot.loader.tools.JavaExecutable

K

kill() - Method in class org.springframework.boot.loader.tools.RunProcess

Kill this process.

L

LaunchScript - Interface in org.springframework.boot.loader.tools

A script that can be prepended to the front of a JAR file to make it executable.

Layer - Class in org.springframework.boot.loader.tools

A named layer used to separate the jar when creating a Docker image.

Layer(String) - Constructor for class org.springframework.boot.loader.tools.Layer

Create a new Layer instance with the specified name.

LayeredJar() - Constructor for class org.springframework.boot.loader.tools.Layouts.LayeredJar

LayeredLayout - Interface in org.springframework.boot.loader.tools

A specialization of RepackagingLayout that supports layers in the repackaged archive.

Layers - Interface in org.springframework.boot.loader.tools

Interface to provide information about layers to the Repackager.

Layout - Interface in org.springframework.boot.loader.tools

Strategy interface used to determine the layout for a particular type of archive.

LayoutFactory - Interface in org.springframework.boot.loader.tools

Factory interface used to create a Layout.

Layouts - Class in org.springframework.boot.loader.tools

Common Layouts.

Layouts.Expanded - Class in org.springframework.boot.loader.tools

Executable expanded archive layout.

Layouts.Jar - Class in org.springframework.boot.loader.tools

Executable JAR layout.

Layouts.LayeredJar - Class in org.springframework.boot.loader.tools

Executable JAR layout with support for layers.

Layouts.None - Class in org.springframework.boot.loader.tools

No layout.

Layouts.War - Class in org.springframework.boot.loader.tools

Executable WAR layout.

Libraries - Interface in org.springframework.boot.loader.tools

Encapsulates information about libraries that may be packed into the archive.

Library - Class in org.springframework.boot.loader.tools

Encapsulates information about a single library that may be packed into the archive.

Library(File, LibraryScope) - Constructor for class org.springframework.boot.loader.tools.Library

Create a new Library.

Library(File, LibraryScope, boolean) - Constructor for class org.springframework.boot.loader.tools.Library

Create a new Library.

Library(String, File, LibraryScope, boolean) - Constructor for class org.springframework.boot.loader.tools.Library

Create a new Library.

library(Library) - Method in interface org.springframework.boot.loader.tools.LibraryCallback

Callback for a single library backed by a File.

LibraryCallback - Interface in org.springframework.boot.loader.tools

Callback interface used to iterate Libraries.

LibraryScope - Interface in org.springframework.boot.loader.tools

The scope of a library.

LoaderClassesWriter - Interface in org.springframework.boot.loader.tools

Writer used by CustomLoaderLayouts to write classes into a repackaged JAR.

LogbackInitializer - Class in org.springframework.boot.loader.tools

Utility to initialize logback (when present) to use INFO level logging.

LogbackInitializer() - Constructor for class org.springframework.boot.loader.tools.LogbackInitializer

M

MainClassFinder - Class in org.springframework.boot.loader.tools

Finds any class with a public static main method by performing a breadth first search.

MainClassFinder() - Constructor for class org.springframework.boot.loader.tools.MainClassFinder

N

None() - Constructor for class org.springframework.boot.loader.tools.Layouts.None

NONE - Static variable in interface org.springframework.boot.loader.tools.Libraries

Represents no libraries.

NullAdditionalPropertyValueException(String) - Constructor for exception org.springframework.boot.loader.tools.BuildPropertiesWriter.NullAdditionalPropertyValueException

O

org.springframework.boot.loader.tools - package org.springframework.boot.loader.tools

Tools for generating executable JAR/WAR files.

P

packageImage(Libraries, BiConsumer<ZipEntry, EntryWriter>) - Method in class org.springframework.boot.loader.tools.ImagePackager

Create an packaged image.

Packager - Class in org.springframework.boot.loader.tools

Abstract base class for packagers.

Packager(File, LayoutFactory) - Constructor for class org.springframework.boot.loader.tools.Packager

Create a new Packager instance.

Packager.MainClassTimeoutWarningListener - Interface in org.springframework.boot.loader.tools

Callback interface used to present a warning when finding the main class takes too long.

processBuilder(String...) - Method in class org.springframework.boot.loader.tools.JavaExecutable

Create a new ProcessBuilder that will run with the Java executable.

ProjectDetails(String, String, String, String, Instant, Map<String, String>) - Constructor for class org.springframework.boot.loader.tools.BuildPropertiesWriter.ProjectDetails

PROVIDED - Static variable in interface org.springframework.boot.loader.tools.LibraryScope

The library is needed for compile but is usually provided when running.

R

removeDuplicatesFromOutputDirectory(File, File) - Static method in class org.springframework.boot.loader.tools.FileUtils

Utility to remove duplicate files from an "output" directory if they already exist in an "origin".

repackage(Libraries) - Method in class org.springframework.boot.loader.tools.Repackager

Repackage the source file so that it can be run using 'java -jar'.

repackage(File, Libraries) - Method in class org.springframework.boot.loader.tools.Repackager

Repackage to the given destination so that it can be launched using ' java -jar'.

repackage(File, Libraries, LaunchScript) - Method in class org.springframework.boot.loader.tools.Repackager

Repackage to the given destination so that it can be launched using ' java -jar'.

Repackager - Class in org.springframework.boot.loader.tools

Utility class that can be used to repackage an archive so that it can be executed using 'java -jar'.

Repackager(File) - Constructor for class org.springframework.boot.loader.tools.Repackager

Repackager(File, LayoutFactory) - Constructor for class org.springframework.boot.loader.tools.Repackager

RepackagingLayout - Interface in org.springframework.boot.loader.tools

A specialization of Layout that repackages an existing archive by moving its content to a new location.

RESOURCES - Static variable in class org.springframework.boot.loader.tools.StandardLayers

The resources layer.

run(boolean, String...) - Method in class org.springframework.boot.loader.tools.RunProcess

run(boolean, Collection<String>, Map<String, String>) - Method in class org.springframework.boot.loader.tools.RunProcess

RunProcess - Class in org.springframework.boot.loader.tools

Utility used to run a process.

RunProcess(String...) - Constructor for class org.springframework.boot.loader.tools.RunProcess

Creates new RunProcess instance for the specified command.

RunProcess(File, String...) - Constructor for class org.springframework.boot.loader.tools.RunProcess

Creates new RunProcess instance for the specified working directory and command.

RUNTIME - Static variable in interface org.springframework.boot.loader.tools.LibraryScope

The library is used at runtime but not needed for compile.

S

setBackupSource(boolean) - Method in class org.springframework.boot.loader.tools.Repackager

Sets if source files should be backed up when they would be overwritten.

setIncludeRelevantJarModeJars(boolean) - Method in class org.springframework.boot.loader.tools.Packager

Sets if jarmode jars relevant for the packaging should be automatcially included.

setLayers(Layers) - Method in class org.springframework.boot.loader.tools.Packager

Sets the layers that should be used in the jar.

setLayout(Layout) - Method in class org.springframework.boot.loader.tools.Packager

Sets the layout to use for the jar.

setLayoutFactory(LayoutFactory) - Method in class org.springframework.boot.loader.tools.Packager

Sets the layout factory for the jar.

setMainClass(String) - Method in class org.springframework.boot.loader.tools.Packager

Sets the main class that should be run.

sha1Hash(File) - Static method in class org.springframework.boot.loader.tools.FileUtils

Generate a SHA.1 Hash for a given file.

SignalUtils - Class in org.springframework.boot.loader.tools

Utilities for working with signal handling.

size() - Method in interface org.springframework.boot.loader.tools.EntryWriter

Return the size of the content that will be written, or -1 if the size is not known.

SNAPSHOT_DEPENDENCIES - Static variable in class org.springframework.boot.loader.tools.StandardLayers

The snapshot dependencies layer.

StandardLayers - Class in org.springframework.boot.loader.tools

Base class for the standard set of Layers.

StandardLayers() - Constructor for class org.springframework.boot.loader.tools.StandardLayers

T

toByteArray() - Method in class org.springframework.boot.loader.tools.DefaultLaunchScript

toByteArray() - Method in interface org.springframework.boot.loader.tools.LaunchScript

The content of the launch script as a byte array.

toString() - Method in class org.springframework.boot.loader.tools.JavaExecutable

toString() - Method in class org.springframework.boot.loader.tools.Layer

toString() - Method in interface org.springframework.boot.loader.tools.LibraryScope

W

War() - Constructor for class org.springframework.boot.loader.tools.Layouts.War

write(OutputStream) - Method in interface org.springframework.boot.loader.tools.EntryWriter

Write entry data to the specified output stream.

write(JarFile, Libraries, AbstractJarWriter) - Method in class org.springframework.boot.loader.tools.Packager

writeBuildProperties(BuildPropertiesWriter.ProjectDetails) - Method in class org.springframework.boot.loader.tools.BuildPropertiesWriter

writeEntries(JarFile) - Method in class org.springframework.boot.loader.tools.AbstractJarWriter

Write all entries from the specified jar file.

writeEntry(String, InputStream) - Method in class org.springframework.boot.loader.tools.AbstractJarWriter

Writes an entry.

writeEntry(String, InputStream) - Method in interface org.springframework.boot.loader.tools.LoaderClassesWriter

Write a single entry to the JAR.

writeIndexFile(String, Collection<String>) - Method in class org.springframework.boot.loader.tools.AbstractJarWriter

Write a simple index file containing the specified UTF-8 lines.

writeLoadedClasses(LoaderClassesWriter) - Method in interface org.springframework.boot.loader.tools.CustomLoaderLayout

Write the required loader classes into the JAR.

writeLoaderClasses() - Method in class org.springframework.boot.loader.tools.AbstractJarWriter

Write the required spring-boot-loader classes to the JAR.

writeLoaderClasses(String) - Method in class org.springframework.boot.loader.tools.AbstractJarWriter

Write the required spring-boot-loader classes to the JAR.

writeLoaderClasses() - Method in interface org.springframework.boot.loader.tools.LoaderClassesWriter

Write the default required spring-boot-loader classes to the JAR.

writeLoaderClasses(String) - Method in interface org.springframework.boot.loader.tools.LoaderClassesWriter

Write custom required spring-boot-loader classes to the JAR.

writeManifest(Manifest) - Method in class org.springframework.boot.loader.tools.AbstractJarWriter

Write the specified manifest.

writeNestedLibrary(String, Library) - Method in class org.springframework.boot.loader.tools.AbstractJarWriter

Write a nested library.

writeToArchive(ZipEntry, EntryWriter) - Method in class org.springframework.boot.loader.tools.AbstractJarWriter

writeToArchive(ZipEntry, EntryWriter) - Method in class org.springframework.boot.loader.tools.JarWriter

A B C D E F G H I J K L M N O P R S T W