Package com.sun.enterprise.module.single
Class ProxyModule
java.lang.Object
com.sun.enterprise.module.single.ProxyModule
- All Implemented Interfaces:
Module
Creates a Module implementation based on a single class loader
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final ClassLoader
(package private) final ModuleDefinition
(package private) final ModulesRegistry
-
Constructor Summary
ConstructorsConstructorDescriptionProxyModule
(ModulesRegistry registry, ModuleDefinition moduleDef, ClassLoader cl) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addImport
(ModuleDependency dependency) Create and add a new module to this module's list of imports.void
addListener
(ModuleChangeListener listener) Add a new module change listenervoid
detach()
Detach this module from its registry.void
dumpState
(PrintStream writer) Return theClassLoader
instance associated with this module.Returns the list of imported modules.Gets the metadata of this module.Returns the module definition for this module instancegetName()
Short-cut forgetModuleDefinition().getName()
.getProvidersClass
(Class<T> serviceClass) getProvidersClass
(String name) Returns the registry owning this modulegetState()
Returns the module's stateboolean
hasProvider
(Class serviceClass) Returns true if this module has any provider for the given service class.boolean
isShared()
Returns true if this module is sharable.boolean
isSticky()
Returns true if the module is sticky.void
refresh()
Trigger manual refresh mechanism, the module will check all its URLs and generate change events if any of them has changed.void
removeListener
(ModuleChangeListener listener) Unregister a module change listenervoid
resolve()
Ensure that this module isresolved
.void
setSticky
(boolean sticky) Sets the sticky flag.void
start()
Forces module startup.boolean
stop()
Forces module stop.void
Removes the module from the registry backing store, the module will need be reinstalled to be loaded.
-
Field Details
-
classLoader
-
moduleDef
-
modulesRegistry
-
-
Constructor Details
-
ProxyModule
-
-
Method Details
-
getModuleDefinition
Description copied from interface:Module
Returns the module definition for this module instance- Specified by:
getModuleDefinition
in interfaceModule
- Returns:
- the module definition
-
getName
Description copied from interface:Module
Short-cut forgetModuleDefinition().getName()
. -
getRegistry
Description copied from interface:Module
Returns the registry owning this module- Specified by:
getRegistry
in interfaceModule
- Returns:
- the registry owning the module
-
getState
Description copied from interface:Module
Returns the module's state -
resolve
Description copied from interface:Module
Ensure that this module isresolved
.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 isModuleState.RESOLVED
.- Specified by:
resolve
in interfaceModule
- Throws:
ResolveError
- if any of the declared dependency of this module cannot be satisfied
-
start
Description copied from interface:Module
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 theModuleState.READY
, theLifecycle.start
method will be invoked.- Specified by:
start
in interfaceModule
- Throws:
ResolveError
-
stop
public boolean stop()Description copied from interface:Module
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 aLifecyclePolicy
for this module is defined, theLifecycle.stop(Module)
method will be called and finally the module state will be returned toModuleState.NEW
. -
detach
public void detach()Description copied from interface:Module
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. -
refresh
public void refresh()Description copied from interface:Module
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. -
getMetadata
Description copied from interface:Module
Gets the metadata of this module.- Specified by:
getMetadata
in interfaceModule
-
addListener
Description copied from interface:Module
Add a new module change listener- Specified by:
addListener
in interfaceModule
- Parameters:
listener
- the listener
-
removeListener
Description copied from interface:Module
Unregister a module change listener- Specified by:
removeListener
in interfaceModule
- Parameters:
listener
- the listener to unregister
-
getClassLoader
Description copied from interface:Module
Return theClassLoader
instance associated with this module. Only designated public interfaces will be loaded and returned by this classloader- Specified by:
getClassLoader
in interfaceModule
- Returns:
- the public
ClassLoader
-
getImports
Description copied from interface:Module
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
Module
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.- Specified by:
getImports
in interfaceModule
- Returns:
- Can be empty but never null. Read-only.
-
addImport
-
addImport
Description copied from interface:Module
Create and add a new module to this module's list of imports. -
isSticky
public boolean isSticky()Description copied from interface:Module
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. -
setSticky
public void setSticky(boolean sticky) Description copied from interface:Module
Sets the sticky flag. -
getProvidersClass
- Specified by:
getProvidersClass
in interfaceModule
-
getProvidersClass
- Specified by:
getProvidersClass
in interfaceModule
-
hasProvider
Description copied from interface:Module
Returns true if this module has any provider for the given service class.- Specified by:
hasProvider
in interfaceModule
-
dumpState
-
uninstall
public void uninstall()Description copied from interface:Module
Removes the module from the registry backing store, the module will need be reinstalled to be loaded.
-