com.netflix.nicobar.core.module.jboss

Class JBossModuleLoader

java.lang.Object

org.jboss.modules.ModuleLoader

com.netflix.nicobar.core.module.jboss.JBossModuleLoader

public class JBossModuleLoader
extends org.jboss.modules.ModuleLoader

Specialization of the ModuleLoader class which exposes many of the protected methods for convenience. The ModuleSpec repository is backed by a Map contained within this class so that ModuleSpecs can be directly injected instead of located via a ModuleFinder. This class exposes operations for different revisions of a given module using the ModuleIdentifier "slot" as a revision holder.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.Comparator<org.jboss.modules.ModuleIdentifier>	MODULE_ID_COMPARATOR Comparator used for the module revision sorting
protected java.util.SortedMap<org.jboss.modules.ModuleIdentifier,org.jboss.modules.ModuleSpec>	moduleSpecs Module Spec repo.

Fields inherited from class org.jboss.modules.ModuleLoader

NO_FINDERS

Constructor Summary

Constructors

Constructor and Description
JBossModuleLoader() Construct a instance with an empty module spec repository.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addModuleSpec(org.jboss.modules.ModuleSpec moduleSpec) Add a ModuleSpec to the internal repository making it ready to load.
org.jboss.modules.Module	findLoadedModule(org.jboss.modules.ModuleIdentifier revisionId) Find a module from the local repository.
java.util.Set<org.jboss.modules.ModuleIdentifier>	getAllRevisionIds(java.lang.String scriptModuleId) Find all module revisionIds with a common name
static java.util.Set<ModuleId>	getDependencyScriptModuleIds(org.jboss.modules.ModuleSpec moduleSpec) Extract the Module dependencies for the given module in the form of ScriptModule ids.
org.jboss.modules.ModuleIdentifier	getLatestRevisionId(ModuleId scriptModuleId) Find the highest revision for the given scriptModuleId
java.util.Map<ModuleId,org.jboss.modules.ModuleIdentifier>	getLatestRevisionIds() Get a map of the the moduleId to ModuleIdentifier with the highest revision
long	getLatestRevisionNumber(ModuleId scriptModuleId) Find the highest revision for the given scriptModuleId
org.jgrapht.DirectedGraph<ModuleId,org.jgrapht.graph.DefaultEdge>	getModuleNameGraph() Construct the Module dependency graph of a module loader where each vertex is the module name
org.jboss.modules.ModuleSpec	getModuleSpec(org.jboss.modules.ModuleIdentifier revisionId) Get a ModuleSpec that was added to this instance
static long	getRevisionNumber(org.jboss.modules.ModuleIdentifier revisionId) Helper method to parse out the revision number from a ModuleIdentifier
void	rescanModule(org.jboss.modules.Module module) Rescan a module.
void	unloadAllModuleRevision(java.lang.String scriptModuleId) Unload all module revisions with the give script module id
void	unloadModule(org.jboss.modules.Module module) Unload a module from the local repository.
void	unloadModule(org.jboss.modules.ModuleIdentifier revisionId) Unload the given revision of a module from the local repository.

Methods inherited from class org.jboss.modules.ModuleLoader

findLoadedModuleLocal, findModule, forClass, forClassLoader, getDependencies, getFinders, iterateModules, loadModule, loadModuleLocal, preloadExportedModule, preloadModule, preloadModule, refreshResourceLoaders, relink, setAndRefreshResourceLoaders, setAndRelinkDependencies, toString, unloadModuleLocal

Methods inherited from class java.lang.Object

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

Field Detail

MODULE_ID_COMPARATOR

protected static final java.util.Comparator<org.jboss.modules.ModuleIdentifier> MODULE_ID_COMPARATOR

Comparator used for the module revision sorting

moduleSpecs

protected final java.util.SortedMap<org.jboss.modules.ModuleIdentifier,org.jboss.modules.ModuleSpec> moduleSpecs

Module Spec repo. Map of the revisionId to the Module specifications.

Constructor Detail

JBossModuleLoader

public JBossModuleLoader()

Construct a instance with an empty module spec repository.

Method Detail

unloadAllModuleRevision

public void unloadAllModuleRevision(java.lang.String scriptModuleId)

Unload all module revisions with the give script module id

unloadModule

public void unloadModule(org.jboss.modules.ModuleIdentifier revisionId)

Unload the given revision of a module from the local repository.

Parameters:

revisionId - ModuleIdentifier of the revision to unload

unloadModule

public void unloadModule(org.jboss.modules.Module module)

Unload a module from the local repository. Equivalent to ModuleLoader.unloadModuleLocal(Module).

Parameters:

module - the module to unload.

findLoadedModule

@Nullable
public org.jboss.modules.Module findLoadedModule(org.jboss.modules.ModuleIdentifier revisionId)

Find a module from the local repository. Equivalent to ModuleLoader.findLoadedModuleLocal(ModuleIdentifier).

Parameters:

revisionId - revisionId of the module to find

Returns:

the loaded module or null if it doesn't exist

addModuleSpec

@Nullable
public boolean addModuleSpec(org.jboss.modules.ModuleSpec moduleSpec)

Add a ModuleSpec to the internal repository making it ready to load. Note, this doesn't actually load the Module.

Parameters:

moduleSpec - spec to add

Returns:

true if the instance was added

See Also:

ModuleLoader.loadModule(ModuleIdentifier)

getModuleSpec

@Nullable
public org.jboss.modules.ModuleSpec getModuleSpec(org.jboss.modules.ModuleIdentifier revisionId)

Get a ModuleSpec that was added to this instance

Parameters:

revisionId - id to search for

Returns:

the instance associated with the given revisionIds

getLatestRevisionNumber

public long getLatestRevisionNumber(ModuleId scriptModuleId)

Find the highest revision for the given scriptModuleId

Parameters:

scriptModuleId - name to search for

Returns:

the highest revision number or -1 if no revisions exist

getLatestRevisionId

public org.jboss.modules.ModuleIdentifier getLatestRevisionId(ModuleId scriptModuleId)

Find the highest revision for the given scriptModuleId

Parameters:

scriptModuleId - name to search for

Returns:

the revisionId for the highest revision number. Revision defaults to 0 if it doesn't exist.

getAllRevisionIds

public java.util.Set<org.jboss.modules.ModuleIdentifier> getAllRevisionIds(java.lang.String scriptModuleId)

Find all module revisionIds with a common name

getLatestRevisionIds

public java.util.Map<ModuleId,org.jboss.modules.ModuleIdentifier> getLatestRevisionIds()

Get a map of the the moduleId to ModuleIdentifier with the highest revision

Returns:

immutable snapshot of the latest module revisionIds

getRevisionNumber

public static long getRevisionNumber(org.jboss.modules.ModuleIdentifier revisionId)

Helper method to parse out the revision number from a ModuleIdentifier

Returns:

revision number or -1 if it couldn't be parsed

getModuleNameGraph

public org.jgrapht.DirectedGraph<ModuleId,org.jgrapht.graph.DefaultEdge> getModuleNameGraph()

Construct the Module dependency graph of a module loader where each vertex is the module name

Returns:

a mutable snapshot of the underlying dependency

getDependencyScriptModuleIds

public static java.util.Set<ModuleId> getDependencyScriptModuleIds(org.jboss.modules.ModuleSpec moduleSpec)

Extract the Module dependencies for the given module in the form of ScriptModule ids.

rescanModule

public void rescanModule(org.jboss.modules.Module module)
                  throws org.jboss.modules.ModuleLoadException

Rescan a module. Post-compilation, this method triggers a module to pick up resources created from compilation.

Parameters:

module - a loaded module.

Throws:

org.jboss.modules.ModuleLoadException