org.springframework.boot.loader

Class Launcher

java.lang.Object

org.springframework.boot.loader.Launcher

Direct Known Subclasses:

ExecutableArchiveLauncher, PropertiesLauncher

public abstract class Launcher
extends Object

Base class for launchers that can start an application with a fully configured classpath backed by one or more Archives.

Since:

1.0.0

Author:

Phillip Webb, Dave Syer

Constructor Summary

Constructors

Constructor and Description
Launcher()

Method Summary

Modifier and Type	Method and Description
protected Archive	createArchive()
protected ClassLoader	createClassLoader(Iterator<Archive> archives) Create a classloader for the specified archives.
protected ClassLoader	createClassLoader(List<Archive> archives) Deprecated. since 2.3.0 for removal in 2.5.0 in favor of createClassLoader(Iterator)
protected ClassLoader	createClassLoader(URL[] urls) Create a classloader for the specified URLs.
protected MainMethodRunner	createMainMethodRunner(String mainClass, String[] args, ClassLoader classLoader) Create the MainMethodRunner used to launch the application.
protected Archive	getArchive() Return the root archive.
protected List<Archive>	getClassPathArchives() Deprecated. since 2.3.0 for removal in 2.5.0 in favor of implementing getClassPathArchivesIterator().
protected Iterator<Archive>	getClassPathArchivesIterator() Returns the archives that will be used to construct the class path.
protected abstract String	getMainClass() Returns the main class that should be launched.
protected boolean	isExploded() Returns if the launcher is running in an exploded mode.
protected void	launch(String[] args) Launch the application.
protected void	launch(String[] args, String launchClass, ClassLoader classLoader) Launch the application given the archive file and a fully configured classloader.

Methods inherited from class java.lang.Object

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

Constructor Detail

Launcher

public Launcher()

Method Detail

launch

protected void launch(String[] args)
               throws Exception

Launch the application. This method is the initial entry point that should be called by a subclass public static void main(String[] args) method.

Parameters:

args - the incoming arguments

Throws:

Exception - if the application fails to launch

createClassLoader

@Deprecated
protected ClassLoader createClassLoader(List<Archive> archives)
                                             throws Exception

Deprecated. since 2.3.0 for removal in 2.5.0 in favor of createClassLoader(Iterator)

Create a classloader for the specified archives.

Parameters:

archives - the archives

Returns:

the classloader

Throws:

Exception - if the classloader cannot be created

createClassLoader

protected ClassLoader createClassLoader(Iterator<Archive> archives)
                                 throws Exception

Create a classloader for the specified archives.

Parameters:

archives - the archives

Returns:

the classloader

Throws:

Exception - if the classloader cannot be created

Since:

2.3.0

createClassLoader

protected ClassLoader createClassLoader(URL[] urls)
                                 throws Exception

Create a classloader for the specified URLs.

Parameters:

urls - the URLs

Returns:

the classloader

Throws:

Exception - if the classloader cannot be created

launch

protected void launch(String[] args,
                      String launchClass,
                      ClassLoader classLoader)
               throws Exception

Launch the application given the archive file and a fully configured classloader.

Parameters:

args - the incoming arguments

launchClass - the launch class to run

classLoader - the classloader

Throws:

Exception - if the launch fails

createMainMethodRunner

protected MainMethodRunner createMainMethodRunner(String mainClass,
                                                  String[] args,
                                                  ClassLoader classLoader)

Create the MainMethodRunner used to launch the application.

Parameters:

mainClass - the main class

args - the incoming arguments

classLoader - the classloader

Returns:

the main method runner

getMainClass

protected abstract String getMainClass()
                                throws Exception

Returns the main class that should be launched.

Returns:

the name of the main class

Throws:

Exception - if the main class cannot be obtained

getClassPathArchivesIterator

protected Iterator<Archive> getClassPathArchivesIterator()
                                                  throws Exception

Returns the archives that will be used to construct the class path.

Returns:

the class path archives

Throws:

Exception - if the class path archives cannot be obtained

Since:

2.3.0

getClassPathArchives

@Deprecated
protected List<Archive> getClassPathArchives()
                                                  throws Exception

Deprecated. since 2.3.0 for removal in 2.5.0 in favor of implementing getClassPathArchivesIterator().

Returns the archives that will be used to construct the class path.

Returns:

the class path archives

Throws:

Exception - if the class path archives cannot be obtained

createArchive

protected final Archive createArchive()
                               throws Exception

Throws:

Exception

isExploded

protected boolean isExploded()

Returns if the launcher is running in an exploded mode. If this method returns true then only regular JARs are supported and the additional URL and ClassLoader support infrastructure can be optimized.

Returns:

if the jar is exploded.

Since:

2.3.0

getArchive

protected Archive getArchive()

Return the root archive.

Returns:

the root archive

Since:

2.3.1