org.wildfly.swarm.bootstrap.env

Class ApplicationEnvironment

java.lang.Object

org.wildfly.swarm.bootstrap.env.ApplicationEnvironment

public class ApplicationEnvironment
extends Object

Entry-point to runtime environment.

This class uses the fraction-manifest.yaml from each fraction, along with the container-wide wildfly-swarm-manifest.yaml if executing in an uberjar mode in order to determine information such as:

• uberjar vs non-uberjar execution mode
• removable dependencies
• bootstrap swarm artifacts
• bootstrap swarm modules
• all installed fractions

Author:

Bob McWhirter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApplicationEnvironment.Mode

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_MAIN_CLASS_NAME

Method Summary

Modifier and Type	Method and Description
List<String>	bootstrapArtifacts() List of bootstrap artifacts to look for fractions.
List<ArtifactCoordinates>	bootstrapArtifactsAsCoordinates()
List<String>	bootstrapModules() List of bootstrap modules to bootstrap the fractions.
List<FractionManifest>	fractionManifests() Retrieve a sorted list of installed fraction manifests.
static ApplicationEnvironment	get() Fetch the ApplicationEnvironment
String	getAsset()
ClassLoader	getBootstrapClassLoader()
Set<String>	getDependencies() List of application-level dependencies.
String	getMainClassName() Retrieve the user's main-class name, if specified, else the default.
ApplicationEnvironment.Mode	getMode()
List<String>	getRemovableDependencies() List of removable dependencies, such as the bootstrap Swarm jars and anything transitive not directly required by the application.
boolean	isHollow() Determine if this application is defined to be hollow.
Set<String>	resolveDependencies(List<String> exclusions) [hb] TODO: these javadocs are wrong and describe a previous implementation of this method Resolve the application's dependencies.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAIN_CLASS_NAME

public static final String DEFAULT_MAIN_CLASS_NAME

See Also:

Constant Field Values

Method Detail

get

public static ApplicationEnvironment get()

Fetch the ApplicationEnvironment

Returns:

The environment.

bootstrapModules

public List<String> bootstrapModules()

List of bootstrap modules to bootstrap the fractions.

Returns:

The list of simple module names

bootstrapArtifacts

public List<String> bootstrapArtifacts()

List of bootstrap artifacts to look for fractions.

Returns:

The list of Maven GAVs to bootstrap.

bootstrapArtifactsAsCoordinates

public List<ArtifactCoordinates> bootstrapArtifactsAsCoordinates()

getMode

public ApplicationEnvironment.Mode getMode()

getDependencies

public Set<String> getDependencies()

List of application-level dependencies.

Only applicable for uberjar executions.

Returns:

The list of Maven GAVs for application dependencies.

getRemovableDependencies

public List<String> getRemovableDependencies()

List of removable dependencies, such as the bootstrap Swarm jars and anything transitive not directly required by the application.

Returns:

The list of Maven GAVs that may be removed.

resolveDependencies

public Set<String> resolveDependencies(List<String> exclusions)
                                throws IOException

[hb] TODO: these javadocs are wrong and describe a previous implementation of this method Resolve the application's dependencies.

Using combinations of getDependencies()} and getRemovableDependencies(), depending on execution mode, resolves application dependencies, taking into account any exclusions.

Parameters:

exclusions - Maven GAVs to exclude.

Returns:

Set of paths to dependency artifacts.

Throws:

IOException

getAsset

public String getAsset()

getMainClassName

public String getMainClassName()

Retrieve the user's main-class name, if specified, else the default.

Returns:

The user's main-class name, else the default Swarm main.

isHollow

public boolean isHollow()

Determine if this application is defined to be hollow.

Returns:

true if hollow, otherwise false.

getBootstrapClassLoader

public ClassLoader getBootstrapClassLoader()
                                    throws org.jboss.modules.ModuleLoadException

Throws:

org.jboss.modules.ModuleLoadException

fractionManifests

public List<FractionManifest> fractionManifests()

Retrieve a sorted list of installed fraction manifests.

Returns:

The sorted list of installed fraction manifests.