hk2 4.0.1 · com.sun.enterprise.module.HK2Module · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	addImport(HK2Module module)
public HK2Module	addImport(ModuleDependency new module's definition dependency) Create and add a new module to this module's list of imports.
public void	addListener(ModuleChangeListener the listener listener) Add a new module change listener
public void	detach() Detach this module from its registry.
public void	dumpState(PrintStream writer)
public ClassLoader	Returns: the public `ClassLoader` getClassLoader() Return the `ClassLoader` instance associated with this module.
public List<HK2Module>	Returns: Can be empty but never null. Read-only. getImports() Returns the list of imported modules.
public ModuleMetadata	getMetadata() Gets the metadata of this module.
public ModuleDefinition	Returns: the module definition getModuleDefinition() Returns the module definition for this module instance
public String	getName() Short-cut for `getModuleDefinition().getName()`.
public <T> Iterable<Class<? extends T>>	getProvidersClass(Class<T> serviceClass)
public Iterable<Class<T>>	getProvidersClass(String name)
public ModulesRegistry	Returns: the registry owning the module getRegistry() Returns the registry owning this module
public ModuleState	Returns: the module's state getState() Returns the module's state
public boolean	hasProvider(Class<T> serviceClass) Returns true if this module has any provider for the given service class.
public boolean	Returns: true if this module is sharable. isShared() Returns true if this module is sharable.
public boolean	Returns: true is the module is sticky isSticky() Returns true if the module is sticky.
public void	refresh() Trigger manual refresh mechanism, the module will check all its URLs and generate change events if any of them has changed.
public void	removeListener(ModuleChangeListener the listener to unregister listener) Unregister a module change listener
public void	resolve() Ensure that this module is `resolved`.
public void	setSticky(boolean true if the module should stick around sticky) Sets the sticky flag.
public void	start() Forces module startup.
public boolean	Returns: true if unloading was successful stop() Forces module stop.
public void	uninstall() Removes the module from the registry backing store, the module will need be reinstalled to be loaded.

Method Detail

addImport	back to summary
public void addImport(HK2Module module)

addImport	back to summary
public HK2Module addImport(ModuleDependency dependency) Create and add a new module to this module's list of imports. Parameters dependency:ModuleDependency new module's definition

addImport

back to summary

public HK2Module addImport(ModuleDependency dependency)

Create and add a new module to this module's list of imports.

Parameters

dependency:ModuleDependency: new module's definition

addListener	back to summary
public void addListener(ModuleChangeListener listener) Add a new module change listener Parameters listener:ModuleChangeListener the listener

addListener

back to summary

public void addListener(ModuleChangeListener listener)

Add a new module change listener

Parameters

listener:ModuleChangeListener: the listener

detach	back to summary
public void detach() Detach this module from its registry. This does not free any of the loaded resources. Only proper release of all references to the public class loader will ensure module being garbage collected. Detached modules are orphan and will be garbage collected if resources are properly disposed.

dumpState	back to summary
public void dumpState(PrintStream writer)

getClassLoader back to summary

getClassLoader	back to summary
public ClassLoader getClassLoader() Return the `ClassLoader` instance associated with this module. Only designated public interfaces will be loaded and returned by this classloader Returns:ClassLoader the public `ClassLoader`

public ClassLoader getClassLoader()

Return the ClassLoader instance associated with this module. Only designated public interfaces will be loaded and returned by this classloader

Returns:ClassLoader: the public ClassLoader

getImports back to summary

getImports	back to summary
public List<HK2Module> getImports() Returns the list of imported modules. This is the module version of `ModuleDefinition#getDependencies()`, but after fully resolved. To enforce the stable class visibility, once `HK2Module` is created, dependencies cannot be changed — that is, we don't want "a.b.C" to suddenly mean something different once the code starts running. Returns:List<HK2Module> Can be empty but never null. Read-only.

public List<HK2Module> getImports()

Returns the list of imported modules.

This is the module version of ModuleDefinition#getDependencies(), but after fully resolved.

To enforce the stable class visibility, once HK2Module is created, dependencies cannot be changed — that is, we don't want "a.b.C" to suddenly mean something different once the code starts running.

Returns:List<HK2Module>: Can be empty but never null. Read-only.

getMetadata	back to summary
public ModuleMetadata getMetadata() Gets the metadata of this module.

getModuleDefinition	back to summary
public ModuleDefinition getModuleDefinition() Returns the module definition for this module instance Returns:ModuleDefinition the module definition

getModuleDefinition

back to summary

public ModuleDefinition getModuleDefinition()

Returns the module definition for this module instance

Returns:ModuleDefinition: the module definition

getName	back to summary
public String getName() Short-cut for `getModuleDefinition().getName()`.

getProvidersClass	back to summary
public <T> Iterable<Class<? extends T>> getProvidersClass(Class<T> serviceClass)

getProvidersClass	back to summary
public Iterable<Class<T>> getProvidersClass(String name)

getRegistry	back to summary
public ModulesRegistry getRegistry() Returns the registry owning this module Returns:ModulesRegistry the registry owning the module

getRegistry

back to summary

public ModulesRegistry getRegistry()

Returns the registry owning this module

Returns:ModulesRegistry: the registry owning the module

getState	back to summary
public ModuleState getState() Returns the module's state Returns:ModuleState the module's state

getState

back to summary

public ModuleState getState()

Returns the module's state

Returns:ModuleState: the module's state

hasProvider	back to summary
public boolean hasProvider(Class<T> serviceClass) Returns true if this module has any provider for the given service class.

isShared	back to summary
public boolean isShared() Returns true if this module is sharable. A sharable module means that onlu one instance of the module classloader will be used by all users. Returns:boolean true if this module is sharable.

isShared

back to summary

public boolean isShared()

Returns true if this module is sharable. A sharable module means that onlu one instance of the module classloader will be used by all users.

Returns:boolean: true if this module is sharable.

isSticky	back to summary
public boolean isSticky() Returns true if the module is sticky. A sticky module cannot be stopped or unloaded. Once a sticky module is loaded or started, it will stay in the JVM until it exists. Returns:boolean true is the module is sticky

isSticky

back to summary

public boolean isSticky()

Returns true if the module is sticky. A sticky module cannot be stopped or unloaded. Once a sticky module is loaded or started, it will stay in the JVM until it exists.

Returns:boolean: true is the module is sticky

refresh	back to summary
public void refresh() Trigger manual refresh mechanism, the module will check all its URLs and generate change events if any of them has changed. This will allow the owning registry to force a module upgrade at next module request.

removeListener	back to summary
public void removeListener(ModuleChangeListener listener) Unregister a module change listener Parameters listener:ModuleChangeListener the listener to unregister

removeListener

back to summary

public void removeListener(ModuleChangeListener listener)

Unregister a module change listener

Parameters

listener:ModuleChangeListener: the listener to unregister

resolve back to summary

resolve	back to summary
public void resolve() throws ResolveError Ensure that this module is `resolved`. If the module is already resolved, this method does nothing. Otherwise, iterate over all declared ModuleDependency instances and use the associated `ModuleRegistry` to resolve it. After successful completion of this method, the module state is `ModuleState#RESOLVED`. Exceptions ResolveError: if any of the declared dependency of this module cannot be satisfied

public void resolve() throws ResolveError

Ensure that this module is resolved.

If the module is already resolved, this method does nothing. Otherwise, iterate over all declared ModuleDependency instances and use the associated ModuleRegistry to resolve it. After successful completion of this method, the module state is ModuleState#RESOLVED.

Exceptions

ResolveError:: if any of the declared dependency of this module cannot be satisfied

setSticky	back to summary
public void setSticky(boolean sticky) Sets the sticky flag. Parameters sticky:boolean true if the module should stick around

setSticky

back to summary

public void setSticky(boolean sticky)

Sets the sticky flag.

Parameters

sticky:boolean: true if the module should stick around

start	back to summary
public void start() throws ResolveError Forces module startup. In most cases, the runtime will take care of starting modules when they are first used. There could be cases where code need to manually start a sub module. Invoking this method will move the module to the `ModuleState.READY`, the `Lifecycle.start` method will be invoked.

stop back to summary

stop	back to summary
public boolean stop() Forces module stop. In most cases, the runtime will take care of stopping modules when the last module user released its interest. However, in certain cases, it may be interesting to manually stop the module. Stopping the module means that the module is removed from the registry, the class loader references are released (note : the class loaders will only be released if all instances of any class loaded by them are gc'ed). If a `LifecyclePolicy` for this module is defined, the `Lifecycle.stop(HK2Module)` method will be called and finally the module state will be returned to `ModuleState.NEW`. Returns:boolean true if unloading was successful

public boolean stop()

Forces module stop. In most cases, the runtime will take care of stopping modules when the last module user released its interest. However, in certain cases, it may be interesting to manually stop the module. Stopping the module means that the module is removed from the registry, the class loader references are released (note : the class loaders will only be released if all instances of any class loaded by them are gc'ed). If a LifecyclePolicy for this module is defined, the Lifecycle.stop(HK2Module) method will be called and finally the module state will be returned to ModuleState.NEW.

Returns:boolean: true if unloading was successful

uninstall	back to summary
public void uninstall() Removes the module from the registry backing store, the module will need be reinstalled to be loaded.

public Interface HK2Module

Method Summary

Method Detail