Top Description Methods
org.jboss.modules.management

public Interface ModuleLoaderMXBean

Known Direct Implementers
org.jboss.modules.ModuleLoader.MXBeanImpl
Imports
java.util.List, .SortedMap

An MXBean for getting runtime information about a module loader.
Author
David M. Lloyd

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the string of module information
dumpAllModuleInformation
()

Dump all information for all modules as a string.

public String

Returns:

the string of module information
dumpModuleInformation
(String
the module name
name
)

Dump all information for a single module as a string.

public int

Returns:

the number of classes defined in this module loader
getClassCount
()

Get the number of classes defined in this module loader.

public long

Returns:

the estimated time in nanoseconds
getClassDefineTime
()

Get the estimated CPU time (in nanoseconds) spent defining classes for this loader.

public String

Returns:

the location, or null if the class isn't found or the location cannot be determined
getClassLocation
(String
the module name
moduleName
,
String
the class name
className
)

Get the code source location of a class within a module.

public List<DependencyInfo>

Returns:

the module's dependencies
getDependencies
(String
the module name
name
)

Get the dependencies of the named module.

public String

Returns:

a description of this module loader
getDescription
()

Get a description of this module loader.

public long

Returns:

the estimated time in nanoseconds
getLinkTime
()

Get the estimated CPU time (in nanoseconds) spent linking in the life of this module loader.

public int

Returns:

the loaded module count
getLoadedModuleCount
()

Get the number of modules currently loaded.

public long

Returns:

the estimated time in nanoseconds
getLoadTime
()

Get the estimated CPU time (in nanoseconds) spent loading modules into this loader.

public ModuleInfo

Returns:

the module description
getModuleDescription
(String
the module name
name
)

Get the complete description of this module.

public SortedMap<String, List<String>>

Returns:

the paths map information
getModulePathsInfo
(String
the module name
name
,
boolean
true for the exported paths, false for all paths
exports
)

Get a paths map for a given module.

public int

Returns:

the race count
getRaceCount
()

Get the number of times a class was defined by two threads at once.

public List<ResourceLoaderInfo>

Returns:

the module's resource loaders
getResourceLoaders
(String
the module name
name
)

Get the resource loaders of the named module.

public int

Returns:

the count
getScanCount
()

Get the number of times that dependencies of a module from this loader have been scanned.

public List<String>

Returns:

the module names
queryLoadedModuleNames
()

Obtain a list of the current module names.

public void
refreshResourceLoaders(String
the name of the module to refresh
name
)

Attempt to refresh the resource loaders of the given module.

public boolean

Returns:

true if the module was unloaded
unloadModule
(String
the string form of the module identifier to unload
name
)

Attempt to unload a module from this module loader.

Method Detail

dumpAllModuleInformationback to summary
public String dumpAllModuleInformation()

Dump all information for all modules as a string.

Returns:String

the string of module information

dumpModuleInformationback to summary
public String dumpModuleInformation(String name)

Dump all information for a single module as a string.

Parameters
name:String

the module name

Returns:String

the string of module information

getClassCountback to summary
public int getClassCount()

Get the number of classes defined in this module loader.

Returns:int

the number of classes defined in this module loader

getClassDefineTimeback to summary
public long getClassDefineTime()

Get the estimated CPU time (in nanoseconds) spent defining classes for this loader.

Returns:long

the estimated time in nanoseconds

getClassLocationback to summary
public String getClassLocation(String moduleName, String className)

Get the code source location of a class within a module.

Parameters
moduleName:String

the module name

className:String

the class name

Returns:String

the location, or null if the class isn't found or the location cannot be determined

getDependenciesback to summary
public List<DependencyInfo> getDependencies(String name)

Get the dependencies of the named module.

Parameters
name:String

the module name

Returns:List<DependencyInfo>

the module's dependencies

getDescriptionback to summary
public String getDescription()

Get a description of this module loader.

Returns:String

a description of this module loader

getLinkTimeback to summary
public long getLinkTime()

Get the estimated CPU time (in nanoseconds) spent linking in the life of this module loader.

Returns:long

the estimated time in nanoseconds

getLoadedModuleCountback to summary
public int getLoadedModuleCount()

Get the number of modules currently loaded.

Returns:int

the loaded module count

getLoadTimeback to summary
public long getLoadTime()

Get the estimated CPU time (in nanoseconds) spent loading modules into this loader.

Returns:long

the estimated time in nanoseconds

getModuleDescriptionback to summary
public ModuleInfo getModuleDescription(String name)

Get the complete description of this module.

Parameters
name:String

the module name

Returns:ModuleInfo

the module description

getModulePathsInfoback to summary
public SortedMap<String, List<String>> getModulePathsInfo(String name, boolean exports)

Get a paths map for a given module.

Parameters
name:String

the module name

exports:boolean

true for the exported paths, false for all paths

Returns:SortedMap<String, List<String>>

the paths map information

getRaceCountback to summary
public int getRaceCount()

Get the number of times a class was defined by two threads at once.

Returns:int

the race count

getResourceLoadersback to summary
public List<ResourceLoaderInfo> getResourceLoaders(String name)

Get the resource loaders of the named module.

Parameters
name:String

the module name

Returns:List<ResourceLoaderInfo>

the module's resource loaders

getScanCountback to summary
public int getScanCount()

Get the number of times that dependencies of a module from this loader have been scanned.

Returns:int

the count

queryLoadedModuleNamesback to summary
public List<String> queryLoadedModuleNames()

Obtain a list of the current module names.

Returns:List<String>

the module names

refreshResourceLoadersback to summary
public void refreshResourceLoaders(String name)

Attempt to refresh the resource loaders of the given module.

Parameters
name:String

the name of the module to refresh

unloadModuleback to summary
public boolean unloadModule(String name)

Attempt to unload a module from this module loader.

Parameters
name:String

the string form of the module identifier to unload

Returns:boolean

true if the module was unloaded