org.jboss.weld.bootstrap.spi

Interface EEModuleDescriptor

All Superinterfaces:

Service

All Known Implementing Classes:

EEModuleDescriptorImpl

public interface EEModuleDescriptor
extends Service

In Java EE environment, each BeanDeploymentArchive should provide a description of the Java EE module it belongs to (WAR, RAR, etc.). This applies to physical bean archives deployed within the given module and also to logical bean archives that belong to the module. Bean archives that are not part of a Java EE module (e.g. built-in server libraries) are not required to have a EEModuleDescriptor service registered.

EEModuleDescriptor is a per-BDA service.

It is recommended to share an immutable EEModuleDescriptor instance for all bean deployment archives of the same Java EE module. However, each bean deployment archive may register its own EEModuleDescriptor instance. In this case, all descriptors representing a given EE module must use the same id and type.

Author:

Jozef Hartinger, Martin Kouba

See Also:

EEModuleDescriptorImpl

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EEModuleDescriptor.ModuleType Enumeration of possible EE module types

Method Summary

Modifier and Type	Method and Description
String	getId()
EEModuleDescriptor.ModuleType	getType() Indicates which type of module this descriptor represents.

Methods inherited from interface org.jboss.weld.bootstrap.api.Service

cleanup

Method Detail

getId

String getId()

Returns:

a unique identifier of an EE module a given BeanDeploymentArchive belongs to.

getType

EEModuleDescriptor.ModuleType getType()

Indicates which type of module this descriptor represents.

Returns:

the type of module