Package rife.bld.extension

Class BootWarOperation

java.lang.Object

rife.bld.operations.AbstractOperation<AbstractBootOperation<T>>

rife.bld.extension.AbstractBootOperation<BootWarOperation>

rife.bld.extension.BootWarOperation

public class BootWarOperation
extends AbstractBootOperation<BootWarOperation>

Builds and creates a Spring Boot executable web archive (WAR).

Usage:

 @BuildCommand(summary = "Creates an executable WAR for the project")
 public void bootwar() throws Exception {
     new BootWarOperation()
             .fromProject(this)
             .execute();
 }
 

Since:

1.0

Author:

Erik C. Thauvin

Field Summary

Fields inherited from class rife.bld.extension.AbstractBootOperation

logger

Constructor Summary

Constructors

Constructor	Description
BootWarOperation()

Method Summary

Modifier and Type	Method	Description
void	execute()	Performs the BootWar operation.
protected void	executeCopyWebInfProvidedLib(File stagingWebInfDirectory)	Part of the execute operation, copies the WEB-INF/lib-provided libraries.
BootWarOperation	fromProject(Project project)	Configures the operation from a Project.
List<File>	providedLibs()	Retrieves the libraries that will be used for the WAR creation in /WEB-INF/lib-provided.
BootWarOperation	providedLibs(File... jars)	Provides the libraries that will be used for the WAR creation in /WEB-INF/lib-provided.
BootWarOperation	providedLibs(String... jars)	Provides the libraries that will be used for the WAR creation in /WEB-INF/lib-provided.
BootWarOperation	providedLibs(Path... jars)	Provides the libraries that will be used for the WAR creation in /WEB-INF/lib-provided.
final BootWarOperation	providedLibs(Collection<File> jars)	Provides libraries that will be used for the WAR creation in /WEB-INF/lib-provided.
final BootWarOperation	providedLibsPaths(Collection<Path> jars)	Provides the libraries that will be used for the WAR creation in /WEB-INF/lib-provided.
final BootWarOperation	providedLibsStrings(Collection<String> jars)	Provides the libraries that will be used for the WAR creation in /WEB-INF/lib-provided.

Methods inherited from class rife.bld.extension.AbstractBootOperation

destinationDirectory, destinationDirectory, destinationDirectory, destinationDirectory, destinationFileName, destinationFileName, executeCopyBootLoader, executeCopyInfClassesFiles, executeCopyInfLibs, executeCreateArchive, executeCreateManifest, infLibs, infLibs, infLibs, infLibs, infLibs, infLibsPaths, infLibsStrings, launcherClass, launcherClass, launcherLibs, launcherLibs, launcherLibs, launcherLibs, launcherLibs, launcherLibsPaths, launcherLibsStrings, mainClass, mainClass, manifestAttribute, manifestAttributes, manifestAttributes, sourceDirectories, sourceDirectories, sourceDirectories, sourceDirectories, sourceDirectories, sourceDirectoriesPaths, sourceDirectoriesStrings, verifyExecute

Methods inherited from class rife.bld.operations.AbstractOperation

executeOnce, executeOnce, silent, silent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BootWarOperation

public BootWarOperation()

Method Details

execute

public void execute()
             throws Exception

Performs the BootWar operation.

Specified by:

execute in class AbstractOperation<AbstractBootOperation<BootWarOperation>>

Throws:

Exception

fromProject

public BootWarOperation fromProject(@NonNull
 Project project)

Configures the operation from a Project.

Sets the following:

• The destination file name to archiveBaseName and version
• The INF libs to compileClasspathJars, runtimeClasspathJars and buildDistDirectory
• The launcher class to WarLauncher
• The launcher libs to standaloneClasspathJars
• The main class to mainClass
• The Manifest-Version, Main-Class and Start-Class manifest attributes
• The source directories to buildMainDirectory and srcMainResourcesDirectory

The project main class and version must be defined.

Specified by:

fromProject in class AbstractBootOperation<BootWarOperation>

Parameters:

project - the project

Returns:

this operation instance

Throws:

NullPointerException - if the project, version or main class are null

IllegalArgumentException - if the main class is blank or empty.

providedLibs

public final BootWarOperation providedLibs(@NonNull
 Collection<File> jars)

Provides libraries that will be used for the WAR creation in /WEB-INF/lib-provided.

Parameters:

jars - a collection of Java archive files

Returns:

this operation instance

Throws:

NullPointerException - if jars is null

IllegalArgumentException - if jars is empty, or contains null or empty elements

See Also:

• providedLibs(File...)

providedLibs

public BootWarOperation providedLibs(@NonNull
 String... jars)

Provides the libraries that will be used for the WAR creation in /WEB-INF/lib-provided.

Parameters:

jars - one or more Java archive files

Returns:

this operation instance

Throws:

NullPointerException - if jars is null

IllegalArgumentException - if jars is empty, or contains null or empty elements

See Also:

• providedLibsStrings(Collection)

providedLibs

public BootWarOperation providedLibs(@NonNull
 File... jars)

Provides the libraries that will be used for the WAR creation in /WEB-INF/lib-provided.

Parameters:

jars - one or more Java archive files

Returns:

this operation instance

Throws:

NullPointerException - if jars is null

IllegalArgumentException - if jars is empty, or contains null or empty elements

See Also:

• providedLibs(Collection)

providedLibs

public BootWarOperation providedLibs(@NonNull
 Path... jars)

Provides the libraries that will be used for the WAR creation in /WEB-INF/lib-provided.

Parameters:

jars - one or more Java archive files

Returns:

this operation instance

Throws:

NullPointerException - if jars is null

IllegalArgumentException - if jars is empty, or contains null or empty elements

See Also:

• providedLibsPaths(Collection)

providedLibs

public List<File> providedLibs()

Retrieves the libraries that will be used for the WAR creation in /WEB-INF/lib-provided.

Returns:

the list of Java archive files.

providedLibsPaths

public final BootWarOperation providedLibsPaths(@NonNull
 Collection<Path> jars)

Provides the libraries that will be used for the WAR creation in /WEB-INF/lib-provided.

Parameters:

jars - one or more Java archive files

Returns:

this operation instance

Throws:

NullPointerException - if jars is null

IllegalArgumentException - if jars is empty, or contains null or empty elements

See Also:

• providedLibs(Path...)

providedLibsStrings

public final BootWarOperation providedLibsStrings(@NonNull
 Collection<String> jars)

Provides the libraries that will be used for the WAR creation in /WEB-INF/lib-provided.

Parameters:

jars - one or more Java archive files

Returns:

this operation instance

Throws:

NullPointerException - if jars is null

IllegalArgumentException - if jars is empty, or contains null or empty elements

See Also:

• providedLibs(String...)

executeCopyWebInfProvidedLib

protected void executeCopyWebInfProvidedLib(File stagingWebInfDirectory)
                                     throws IOException

Part of the execute operation, copies the WEB-INF/lib-provided libraries.

Parameters:

stagingWebInfDirectory - the staging WEB-INF directory

Throws:

IOException - if an error occurs