com.netflix.nicobar.core.module.jboss

Class JBossModuleUtils

java.lang.Object

com.netflix.nicobar.core.module.jboss.JBossModuleUtils

public class JBossModuleUtils
extends java.lang.Object

Utility methods for working with Modules

Field Summary

Fields

Modifier and Type	Field and Description
static org.jboss.modules.DependencySpec	JRE_DEPENDENCY_SPEC Dependency specification which allows for importing the core JRE classes
static org.jboss.modules.DependencySpec	NICOBAR_CORE_DEPENDENCY_SPEC Dependency specification which allows for importing the core library classes

Constructor Summary

Constructors

Constructor and Description
JBossModuleUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addPropertiesToSpec(org.jboss.modules.ModuleSpec.Builder moduleSpecBuilder, java.util.Map<java.lang.String,java.lang.String> properties) Add properties to the ModuleSpec
static org.jboss.modules.ModuleIdentifier	createRevisionId(ModuleId scriptModuleId, long revisionNumber) Helper method to create a revisionId in a consistent manner
static org.jboss.modules.ModuleIdentifier	getPluginModuleId(ScriptCompilerPluginSpec pluginSpec) Create the ModuleIdentifier for the given ScriptCompilerPluginSpec
static org.jboss.modules.ModuleIdentifier	getPluginModuleId(java.lang.String pluginId) Create the ModuleIdentifier for the given ScriptCompilerPluginSpec ID
static void	populateCompilerModuleSpec(org.jboss.modules.ModuleSpec.Builder moduleSpecBuilder, ScriptCompilerPluginSpec pluginSpec, java.util.Map<ModuleId,org.jboss.modules.ModuleIdentifier> latestRevisionIds) Populates a ModuleSpec with runtime resources, dependencies and properties from the ScriptCompilerPluginSpec Helpful when creating a ModuleSpec from a ScriptLibPluginSpec
static void	populateModuleSpecWithAppImports(org.jboss.modules.ModuleSpec.Builder moduleSpecBuilder, java.lang.ClassLoader appClassLoader, java.util.Set<java.lang.String> appPackages) Populates a ModuleSpec with a dependency on application runtime packages specified as a set of package paths, loaded within the given classloader.
static void	populateModuleSpecWithCompilationRoot(org.jboss.modules.ModuleSpec.Builder moduleSpecBuilder, java.nio.file.Path compilationRoot) Populates a builder with a ResourceLoaderSpec to a filesystem resource root.
static void	populateModuleSpecWithCoreDependencies(org.jboss.modules.ModuleSpec.Builder moduleSpecBuilder, ScriptArchive scriptArchive) Populates a module spec builder with core dependencies on JRE, Nicobar, itself, and compiler plugins.
static void	populateModuleSpecWithModuleDependency(org.jboss.modules.ModuleSpec.Builder moduleSpecBuilder, java.util.Set<java.lang.String> moduleImportFilterPaths, java.util.Set<java.lang.String> dependencyExportFilterPaths, org.jboss.modules.ModuleIdentifier dependentModuleIdentifier) Populate a module spec builder with a dependencies on other modules.
static void	populateModuleSpecWithResources(org.jboss.modules.ModuleSpec.Builder moduleSpecBuilder, ScriptArchive scriptArchive) Populates a module spec builder with source files, resources and properties from the ScriptArchive

Methods inherited from class java.lang.Object

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

Field Detail

NICOBAR_CORE_DEPENDENCY_SPEC

public static final org.jboss.modules.DependencySpec NICOBAR_CORE_DEPENDENCY_SPEC

Dependency specification which allows for importing the core library classes

JRE_DEPENDENCY_SPEC

public static final org.jboss.modules.DependencySpec JRE_DEPENDENCY_SPEC

Dependency specification which allows for importing the core JRE classes

Constructor Detail

JBossModuleUtils

public JBossModuleUtils()

Method Detail

populateModuleSpecWithResources

public static void populateModuleSpecWithResources(org.jboss.modules.ModuleSpec.Builder moduleSpecBuilder,
                                   ScriptArchive scriptArchive)
                                            throws org.jboss.modules.ModuleLoadException

Populates a module spec builder with source files, resources and properties from the ScriptArchive

Parameters:

moduleSpecBuilder - builder to populate

scriptArchive - ScriptArchive to copy from

Throws:

org.jboss.modules.ModuleLoadException

populateModuleSpecWithCoreDependencies

public static void populateModuleSpecWithCoreDependencies(org.jboss.modules.ModuleSpec.Builder moduleSpecBuilder,
                                          ScriptArchive scriptArchive)
                                                   throws org.jboss.modules.ModuleLoadException

Populates a module spec builder with core dependencies on JRE, Nicobar, itself, and compiler plugins.

Parameters:

moduleSpecBuilder - builder to populate

scriptArchive - ScriptArchive to copy from

Throws:

org.jboss.modules.ModuleLoadException

populateModuleSpecWithModuleDependency

public static void populateModuleSpecWithModuleDependency(org.jboss.modules.ModuleSpec.Builder moduleSpecBuilder,
                                          @Nullable
                                          java.util.Set<java.lang.String> moduleImportFilterPaths,
                                          @Nullable
                                          java.util.Set<java.lang.String> dependencyExportFilterPaths,
                                          org.jboss.modules.ModuleIdentifier dependentModuleIdentifier)

Populate a module spec builder with a dependencies on other modules.

Parameters:

moduleSpecBuilder - builder to populate

moduleImportFilterPaths - paths valid for importing into the module being built. Can be null or empty to indicate that no filters should be applied.

dependencyExportFilterPaths - export paths for the dependency being linked

dependentModuleIdentifier - used to lookup the latest dependencies. see JBossModuleLoader.getLatestRevisionIds()

populateModuleSpecWithCompilationRoot

public static void populateModuleSpecWithCompilationRoot(org.jboss.modules.ModuleSpec.Builder moduleSpecBuilder,
                                         java.nio.file.Path compilationRoot)

Populates a builder with a ResourceLoaderSpec to a filesystem resource root. ScriptArchive

Parameters:

moduleSpecBuilder - builder to populate

compilationRoot - a path to the compilation resource root directory

populateModuleSpecWithAppImports

public static void populateModuleSpecWithAppImports(org.jboss.modules.ModuleSpec.Builder moduleSpecBuilder,
                                    java.lang.ClassLoader appClassLoader,
                                    java.util.Set<java.lang.String> appPackages)

Populates a ModuleSpec with a dependency on application runtime packages specified as a set of package paths, loaded within the given classloader. This is the primary way that a module gains access to packages defined in the application classloader. This dependency is NOT rexported to downstream modules.

Parameters:

moduleSpecBuilder - builder to populate

appClassLoader - a classloader the application classloader.

appPackages - the global set of application package paths.

populateCompilerModuleSpec

public static void populateCompilerModuleSpec(org.jboss.modules.ModuleSpec.Builder moduleSpecBuilder,
                              ScriptCompilerPluginSpec pluginSpec,
                              java.util.Map<ModuleId,org.jboss.modules.ModuleIdentifier> latestRevisionIds)
                                       throws org.jboss.modules.ModuleLoadException

Populates a ModuleSpec with runtime resources, dependencies and properties from the ScriptCompilerPluginSpec Helpful when creating a ModuleSpec from a ScriptLibPluginSpec

Parameters:

moduleSpecBuilder - builder to populate

pluginSpec - ScriptCompilerPluginSpec to copy from

latestRevisionIds - used to lookup the latest dependencies. see JBossModuleLoader.getLatestRevisionIds()

Throws:

org.jboss.modules.ModuleLoadException

addPropertiesToSpec

public static void addPropertiesToSpec(org.jboss.modules.ModuleSpec.Builder moduleSpecBuilder,
                       java.util.Map<java.lang.String,java.lang.String> properties)

Add properties to the ModuleSpec

Parameters:

moduleSpecBuilder - builder to populate

properties - properties to add

getPluginModuleId

public static org.jboss.modules.ModuleIdentifier getPluginModuleId(ScriptCompilerPluginSpec pluginSpec)

Create the ModuleIdentifier for the given ScriptCompilerPluginSpec

getPluginModuleId

public static org.jboss.modules.ModuleIdentifier getPluginModuleId(java.lang.String pluginId)

Create the ModuleIdentifier for the given ScriptCompilerPluginSpec ID

createRevisionId

public static org.jboss.modules.ModuleIdentifier createRevisionId(ModuleId scriptModuleId,
                                                  long revisionNumber)

Helper method to create a revisionId in a consistent manner