ModuleContext (Java API Reference for Oracle WebLogic Server)

```
public interface ModuleContext
```
All information about a module available during deployment or during tools processing. ***************************************************************************** Note about WL directory in user applications ***************************************************************************** Please refer to ApplicationConstants constants GENERATED_OUTPUT_DIR and CACHE_DIR for more details API --- The META-INF/.WL_internal/generated/ & META-INF/.WL_internal/cache/ directories will be available via getGeneratedOutputDir() & getCacheDir() ToolsModule & Module implementations may choose to add this directory as a class loading location. *****************************************************************************

Excluded in public API Reference.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`checkShareability()` Enabled only if shared module class loader is setup for this module instance.
`java.lang.Boolean`	`checkShareableConfiguration()`
`void`	`createdSharedModuleClassLoader()`
`java.io.File`	`getAltDDFile()` Indicates that the module has an alternate descriptor location that is outside the module
`weblogic.application.archive.ApplicationArchive`	`getApplicationArchive()` Deprecated.
`java.lang.String`	`getApplicationId()` The unique application identifier includes the name and version information
`java.lang.String`	`getApplicationName()` Application name.
`java.io.File`	`getCacheDir()` This directory may not exist.
`weblogic.utils.classloaders.ClassFinder`	`getClassFinder()` Available only for Tools /** Available only for Tools
`weblogic.utils.classloaders.GenericClassLoader`	`getClassLoader()` Class loader used as the module class loader.
`java.lang.String`	`getClassLoaderClassPath()` Class path for Class loader used as the module class loader.
`java.io.File`	`getConfigDir()`
`java.util.Set<java.lang.Class<? extends java.lang.annotation.Annotation>>`	`getExtensionAnnotationClasses()` Valid only if isExtensible() returns true
`java.io.File`	`getGeneratedOutputDir()` This directory may not exist.
`java.lang.String`	`getId()` A unique identifier for the module valid only for deployment
`java.lang.String`	`getName()` Java EE 6 module name defined with in deployment descriptor.
`java.io.File`	`getOutputDir()` Available only for Tools Indicates the final output location for the module
`java.lang.String`	`getOutputFileName()` Available only for Tools Indicates the final output file name for the module
`java.lang.String`	`getPartitionName()`
`DeploymentPlanBean`	`getPlan()`
`weblogic.application.naming.ModuleRegistry`	`getRegistry()`
`weblogic.utils.classloaders.GenericClassLoader`	`getTemporaryClassLoader()`
`java.lang.String`	`getType()`
`java.lang.String`	`getURI()`
`weblogic.j2ee.validation.ModuleValidationInfo`	`getValidationInfo()` Available only for Tools
`weblogic.utils.jars.VirtualJarFile`	`getVirtualJarFile()` Refers to the VirtualJarFile representation of the module.
`boolean`	`isArchive()` Available only for Tools Indicates that the module is an archive
`boolean`	`isExtensible()`
`void`	`markShareability()` Store the information that module has shareable module class loader setup
`void`	`markShareableConfiguration(boolean value)` Store the information that module has shareable module class loading configuration.
`void`	`removeTemporaryClassLoader()` Clean up the temporary class loader
`boolean`	`wasSharedModuleClassLoaderCreated()`

- Method Detail
  - getURI
```
java.lang.String getURI()
```
    Returns:
    
    The URI of the module relative to the enterprise application root
  - getId
```
java.lang.String getId()
```
    A unique identifier for the module valid only for deployment
  - getName
```
java.lang.String getName()
```
    Java EE 6 module name defined with in deployment descriptor. The name is available only after the descriptors have been parsed. During deployment, the name needs to be available before module's prepare phase, that means the descriptors must be parsed in module's init phase. In AppMerge, the name is only available after the module merge. The name is not available in appc.
    
    Returns:
    
    module name defined with in deployment descriptor.
  - getApplicationId
```
java.lang.String getApplicationId()
```
    The unique application identifier includes the name and version information
  - getPartitionName
```
java.lang.String getPartitionName()
```
    Returns:
    
    The partition name to which the module has been deployed. This always return null for tools since there is no concept of partitions in tools
  - getApplicationName
```
java.lang.String getApplicationName()
```
    Application name. Does not include application version
  - getType
```
java.lang.String getType()
```
    Returns:
    
    The type constants are declared in WebLogicModuleType
  - getRegistry
```
weblogic.application.naming.ModuleRegistry getRegistry()
```
    Returns:
    
    The value may be null if the module does not have a registry
  - getConfigDir
```
java.io.File getConfigDir()
```
    Returns:
    
    Configuration root from the plan
  - getPlan
```
DeploymentPlanBean getPlan()
```
    Returns:
    
    Descriptor bean representation of the deployment plan associated with the application
  - getValidationInfo
```
weblogic.j2ee.validation.ModuleValidationInfo getValidationInfo()
```
    Available only for Tools
    
    Returns:
    
    the module validation info object to be used and populated during populateValidationInfo
  - isArchive
```
boolean isArchive()
```
    Available only for Tools Indicates that the module is an archive
  - getAltDDFile
```
java.io.File getAltDDFile()
```
    Indicates that the module has an alternate descriptor location that is outside the module
  - getOutputDir
```
java.io.File getOutputDir()
```
    Available only for Tools Indicates the final output location for the module
  - getOutputFileName
```
java.lang.String getOutputFileName()
```
    Available only for Tools Indicates the final output file name for the module
  - getVirtualJarFile
```
weblogic.utils.jars.VirtualJarFile getVirtualJarFile()
```
    Refers to the VirtualJarFile representation of the module. Only refers to the module file, not other files it could refer to (like libraries) The value is valid only if the module URI represents a valid archive or a directory. In all other cases, the value is null. For example, the value is null for modules that are represented by xml files or for modules that faulty archives that cannot be opened up For now use this method and not the deprecated method we are considering supporting in the future. At that time use getApplicationArchive() instead
  - getApplicationArchive
```
@Deprecated
weblogic.application.archive.ApplicationArchive getApplicationArchive()
```
    Deprecated.
    
    Returns:
    
    Application archive for the module The value is valid only if the module URI represents a valid archive or a directory. In all other cases, the value is null. For example, the value is null for modules that are represented by xml files or for modules that faulty archives that cannot be opened up
  - getClassLoader
```
weblogic.utils.classloaders.GenericClassLoader getClassLoader()
```
    Class loader used as the module class loader. The class loader is created for the module after initialization i.e. Module.init or ToolsModule.initClassFinder method
  - getClassLoaderClassPath
```
java.lang.String getClassLoaderClassPath()
```
    Class path for Class loader used as the module class loader. This includes shared module class loader, but not other parent class loader's class path The class loader is created for the module after initialization i.e. Module.init or ToolsModule.initClassFinder method
  - getClassFinder
```
weblogic.utils.classloaders.ClassFinder getClassFinder()
```
    Available only for Tools /** Available only for Tools
    
    Returns:
    
    The class finder passed into the ToolsModule during initClassFinder invocation.
  - getGeneratedOutputDir
```
java.io.File getGeneratedOutputDir()
```
    This directory may not exist. File.mkdirs() must be invoked before writing to this directory
  - getCacheDir
```
java.io.File getCacheDir()
```
    This directory may not exist. File.mkdirs() must be invoked before writing to this directory
  - isExtensible
```
boolean isExtensible()
```
    Returns:
    
    true if the underlying module implementation has been marked extensible
  - getExtensionAnnotationClasses
```
java.util.Set<java.lang.Class<? extends java.lang.annotation.Annotation>> getExtensionAnnotationClasses()
```
    Valid only if isExtensible() returns true
    
    Returns:
    
    a list of all annotation classes that registered module extension factories for this module type support
  - getTemporaryClassLoader
```
weblogic.utils.classloaders.GenericClassLoader getTemporaryClassLoader()
```
    Returns:
    
    Create or get a temporary class loader for the module to process annotations
  - removeTemporaryClassLoader
```
void removeTemporaryClassLoader()
```
    Clean up the temporary class loader
  - markShareableConfiguration
```
void markShareableConfiguration(boolean value)
```
    Store the information that module has shareable module class loading configuration. It doesn't necessarily mean that shareable module class loader will be completely setup
  - checkShareableConfiguration
```
java.lang.Boolean checkShareableConfiguration()
```
    Returns:
    
    null if shareable configuration has never been searched, true if the shareable configuration was searched and found, false if shareable configuration was searched and not found
  - markShareability
```
void markShareability()
```
    Store the information that module has shareable module class loader setup
  - checkShareability
```
boolean checkShareability()
```
    Enabled only if shared module class loader is setup for this module instance. When this flag is used, it is assumed that all conditions were met for app domain class loader based sharing to be enabled.
  - createdSharedModuleClassLoader
```
void createdSharedModuleClassLoader()
```
  - wasSharedModuleClassLoaderCreated
```
boolean wasSharedModuleClassLoaderCreated()
```

Interface ModuleContext

Method Summary

Method Detail

getURI

getId

getName

getApplicationId

getPartitionName

getApplicationName

getType

getRegistry

getConfigDir

getPlan

getValidationInfo

isArchive

getAltDDFile

getOutputDir

getOutputFileName

getVirtualJarFile

getApplicationArchive

getClassLoader

getClassLoaderClassPath

getClassFinder

getGeneratedOutputDir

getCacheDir

isExtensible

getExtensionAnnotationClasses

getTemporaryClassLoader

removeTemporaryClassLoader

markShareableConfiguration

checkShareableConfiguration

markShareability

checkShareability

createdSharedModuleClassLoader

wasSharedModuleClassLoaderCreated