org.springframework.boot.loader.tools

Class Repackager

java.lang.Object

org.springframework.boot.loader.tools.Packager

org.springframework.boot.loader.tools.Repackager

public class Repackager
extends Packager

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

Since:

1.0.0

Author:

Phillip Webb, Andy Wilkinson, Stephane Nicoll, Madhura Bhave, Scott Frederick

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.boot.loader.tools.Packager

Packager.MainClassTimeoutWarningListener

Constructor Summary

Constructors

Constructor and Description
Repackager(File source) Create a new Repackager instance.
Repackager(File source, LayoutFactory layoutFactory) Deprecated. since 2.3.10 for removal in 2.5 in favor of Repackager(File) and Packager.setLayoutFactory(LayoutFactory)

Method Summary

Modifier and Type	Method and Description
void	repackage(File destination, Libraries libraries) Repackage to the given destination so that it can be launched using ' java -jar'.
void	repackage(File destination, Libraries libraries, LaunchScript launchScript) Repackage to the given destination so that it can be launched using ' java -jar'.
void	repackage(File destination, Libraries libraries, LaunchScript launchScript, FileTime lastModifiedTime) Repackage to the given destination so that it can be launched using ' java -jar'.
void	repackage(Libraries libraries) Repackage the source file so that it can be run using 'java -jar'.
void	setBackupSource(boolean backupSource) Sets if source files should be backed up when they would be overwritten.

Methods inherited from class org.springframework.boot.loader.tools.Packager

addMainClassTimeoutWarningListener, findMainMethod, getBackupFile, getLayout, getSource, isAlreadyPackaged, isAlreadyPackaged, setBackupFile, setIncludeRelevantJarModeJars, setLayers, setLayout, setLayoutFactory, setMainClass, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

Repackager

public Repackager(File source)

Create a new Repackager instance.

Parameters:

source - the source archive file to package

Repackager

@Deprecated
public Repackager(File source,
                              LayoutFactory layoutFactory)

Deprecated. since 2.3.10 for removal in 2.5 in favor of Repackager(File) and Packager.setLayoutFactory(LayoutFactory)

Create a new Repackager instance.

Parameters:

source - the source archive file to package

layoutFactory - the layout factory to use or null

Method Detail

setBackupSource

public void setBackupSource(boolean backupSource)

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

Parameters:

backupSource - if source files should be backed up

repackage

public void repackage(Libraries libraries)
               throws IOException

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

Parameters:

libraries - the libraries required to run the archive

Throws:

IOException - if the file cannot be repackaged

repackage

public void repackage(File destination,
                      Libraries libraries)
               throws IOException

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

Parameters:

destination - the destination file (may be the same as the source)

libraries - the libraries required to run the archive

Throws:

IOException - if the file cannot be repackaged

repackage

public void repackage(File destination,
                      Libraries libraries,
                      LaunchScript launchScript)
               throws IOException

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

Parameters:

destination - the destination file (may be the same as the source)

libraries - the libraries required to run the archive

launchScript - an optional launch script prepended to the front of the jar

Throws:

IOException - if the file cannot be repackaged

Since:

1.3.0

repackage

public void repackage(File destination,
                      Libraries libraries,
                      LaunchScript launchScript,
                      FileTime lastModifiedTime)
               throws IOException

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

Parameters:

destination - the destination file (may be the same as the source)

libraries - the libraries required to run the archive

launchScript - an optional launch script prepended to the front of the jar

lastModifiedTime - an optional last modified time to apply to the archive and its contents

Throws:

IOException - if the file cannot be repackaged

Since:

2.3.0