org.jboss.modules.management
Interface ModuleLoaderMXBean


public interface ModuleLoaderMXBean

An MXBean for getting runtime information about a module loader.

Author:
David M. Lloyd

Method Summary
 String dumpAllModuleInformation()
          Dump all information for all modules as a string.
 String dumpModuleInformation(String name)
          Dump all information for a single module as a string.
 List<DependencyInfo> getDependencies(String name)
          Get the dependencies of the named module.
 int getLoadedModuleCount()
          Get the number of modules currently loaded.
 ModuleInfo getModuleDescription(String name)
          Get the complete description of this module.
 SortedMap<String,List<String>> getModulePathsInfo(String name, boolean exports)
          Get a paths map for a given module.
 List<ResourceLoaderInfo> getResourceLoaders(String name)
          Get the resource loaders of the named module.
 List<String> queryLoadedModuleNames()
          Obtain a list of the current module names.
 void refreshResourceLoaders(String name)
          Attempt to refresh the resource loaders of the given module.
 void relink(String name)
          Attempt to relink the given module.
 boolean unloadModule(String name)
          Attempt to unload a module from this module loader.
 

Method Detail

getLoadedModuleCount

int getLoadedModuleCount()
Get the number of modules currently loaded.

Returns:
the loaded module count

queryLoadedModuleNames

List<String> queryLoadedModuleNames()
Obtain a list of the current module names.

Returns:
the module names

dumpModuleInformation

String dumpModuleInformation(String name)
Dump all information for a single module as a string.

Parameters:
name - the module name
Returns:
the string of module information

dumpAllModuleInformation

String dumpAllModuleInformation()
Dump all information for all modules as a string.

Returns:
the string of module information

unloadModule

boolean unloadModule(String name)
Attempt to unload a module from this module loader.

Parameters:
name - the string form of the module identifier to unload
Returns:
true if the module was unloaded

refreshResourceLoaders

void refreshResourceLoaders(String name)
Attempt to refresh the resource loaders of the given module.

Parameters:
name - the name of the module to refresh

relink

void relink(String name)
Attempt to relink the given module.

Parameters:
name - the name of the module to relink

getDependencies

List<DependencyInfo> getDependencies(String name)
Get the dependencies of the named module.

Parameters:
name - the module name
Returns:
the module's dependencies

getResourceLoaders

List<ResourceLoaderInfo> getResourceLoaders(String name)
Get the resource loaders of the named module.

Parameters:
name - the module name
Returns:
the module's resource loaders

getModuleDescription

ModuleInfo getModuleDescription(String name)
Get the complete description of this module.

Parameters:
name - the module name
Returns:
the module description

getModulePathsInfo

SortedMap<String,List<String>> getModulePathsInfo(String name,
                                                  boolean exports)
Get a paths map for a given module.

Parameters:
name - the module name
exports - true for the exported paths, false for all paths
Returns:
the paths map information


Copyright © 2011. All Rights Reserved.