Package org.jboss.as.ee.component

Class EEModuleDescription

java.lang.Object

org.jboss.as.ee.component.EEModuleDescription

All Implemented Interfaces:

ResourceInjectionTarget

public final class EEModuleDescription
extends Object
implements ResourceInjectionTarget

Author:

David M. Lloyd

Constructor Summary

Constructors

Constructor	Description
EEModuleDescription(String applicationName, String moduleName, String earApplicationName, boolean appClient)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
void	addComponent(ComponentDescription description)	Add a component to this module.
void	addInterceptorEnvironment(String interceptorClassName, InterceptorEnvironment env)
void	addInterceptorMethodOverride(String className, InterceptorClassDescription override)	Adds a module level interceptor class override, it is merged with any existing overrides if they exist
void	addMessageDestination(String name, String jndiName)
EEModuleClassDescription	addOrGetLocalClassDescription(String className)	Adds or retrieves an existing EEModuleClassDescription for the local module.
void	addResourceInjection(ResourceInjectionConfiguration injection)
String	getApplicationName()	Returns the application name which can be the same as the module name, in the absence of a .ear top level deployment
List<BindingConfiguration>	getBindingConfigurations()
Collection<EEModuleClassDescription>	getClassDescriptions()	Returns all class descriptions in this module
ComponentDescription	getComponentByName(String name)
Collection<ComponentDescription>	getComponentDescriptions()
List<ComponentDescription>	getComponentsByClassName(String className)
ConcurrentContext	getConcurrentContext()
org.jboss.msc.service.ServiceName	getDefaultClassIntrospectorServiceName()
EEDefaultResourceJndiNames	getDefaultResourceJndiNames()
String	getDefaultSecurityDomain()
String	getDistinctName()
String	getEarApplicationName()	Unlike the getApplicationName() which follows the Jakarta EE spec semantics i.e.
InterceptorClassDescription	getInterceptorClassOverride(String className)	Get module level interceptor method overrides that are set up in ejb-jar.xml
Map<String,InterceptorEnvironment>	getInterceptorEnvironment()
Map<String,String>	getMessageDestinations()
String	getModuleName()
InjectedEENamespaceContextSelector	getNamespaceContextSelector()
Map<InjectionTarget,ResourceInjectionConfiguration>	getResourceInjections(String className)
int	getStartupBeansCount()
boolean	hasComponent(String name)
boolean	isAppClient()
int	registerStartupBean()
void	removeComponent(String componentName, String componentClassName)
void	setDefaultClassIntrospectorServiceName(org.jboss.msc.service.ServiceName defaultClassIntrospectorServiceName)
void	setDefaultSecurityDomain(String defaultSecurityDomain)
void	setDistinctName(String distinctName)
void	setModuleName(String moduleName)
void	setNamespaceContextSelector(InjectedEENamespaceContextSelector namespaceContextSelector)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EEModuleDescription

public EEModuleDescription(String applicationName,
                           String moduleName,
                           String earApplicationName,
                           boolean appClient)

Construct a new instance.

Parameters:

applicationName - the application name (which is same as the module name if the .ear is absent)

moduleName - the module name

earApplicationName - The application name (which is null if the .ear is absent)

appClient - indicates if the process type is an app client

Method Detail

addOrGetLocalClassDescription

public EEModuleClassDescription addOrGetLocalClassDescription(String className)

Adds or retrieves an existing EEModuleClassDescription for the local module. This method should only be used for classes that reside within the current deployment unit, usually by annotation scanners that are attaching annotation information.

This

Parameters:

className - The class name

Returns:

The new or existing EEModuleClassDescription

getClassDescriptions

public Collection<EEModuleClassDescription> getClassDescriptions()

Returns all class descriptions in this module

Returns:

All class descriptions

getDefaultClassIntrospectorServiceName

public org.jboss.msc.service.ServiceName getDefaultClassIntrospectorServiceName()

setDefaultClassIntrospectorServiceName

public void setDefaultClassIntrospectorServiceName(org.jboss.msc.service.ServiceName defaultClassIntrospectorServiceName)

addComponent

public void addComponent(ComponentDescription description)

Add a component to this module.

Parameters:

description - the component description

removeComponent

public void removeComponent(String componentName,
                            String componentClassName)

getApplicationName

public String getApplicationName()

Returns the application name which can be the same as the module name, in the absence of a .ear top level deployment

Returns:

getModuleName

public String getModuleName()

hasComponent

public boolean hasComponent(String name)

isAppClient

public boolean isAppClient()

Returns:

true if the process type is an app client

setModuleName

public void setModuleName(String moduleName)

getComponentByName

public ComponentDescription getComponentByName(String name)

getComponentsByClassName

public List<ComponentDescription> getComponentsByClassName(String className)

getComponentDescriptions

public Collection<ComponentDescription> getComponentDescriptions()

getNamespaceContextSelector

public InjectedEENamespaceContextSelector getNamespaceContextSelector()

setNamespaceContextSelector

public void setNamespaceContextSelector(InjectedEENamespaceContextSelector namespaceContextSelector)

getDistinctName

public String getDistinctName()

setDistinctName

public void setDistinctName(String distinctName)

getEarApplicationName

public String getEarApplicationName()

Unlike the getApplicationName() which follows the Jakarta EE spec semantics i.e. application name is the name of the top level deployment (even if it is just a jar and not an ear), this method returns the application name which follows the Jakarta Enterprise Beans spec semantics i.e. the application name is the .ear name or any configured value in application.xml. This method returns null in the absence of a .ear

Returns:

getInterceptorClassOverride

public InterceptorClassDescription getInterceptorClassOverride(String className)

Get module level interceptor method overrides that are set up in ejb-jar.xml

Parameters:

className - The class name

Returns:

The overrides, or null if no overrides have been set up

addInterceptorMethodOverride

public void addInterceptorMethodOverride(String className,
                                         InterceptorClassDescription override)

Adds a module level interceptor class override, it is merged with any existing overrides if they exist

Parameters:

className - The class name

override - The override

getBindingConfigurations

public List<BindingConfiguration> getBindingConfigurations()

addResourceInjection

public void addResourceInjection(ResourceInjectionConfiguration injection)

Specified by:

addResourceInjection in interface ResourceInjectionTarget

getResourceInjections

public Map<InjectionTarget,ResourceInjectionConfiguration> getResourceInjections(String className)

addMessageDestination

public void addMessageDestination(String name,
                                  String jndiName)

getMessageDestinations

public Map<String,String> getMessageDestinations()

addInterceptorEnvironment

public void addInterceptorEnvironment(String interceptorClassName,
                                      InterceptorEnvironment env)

getInterceptorEnvironment

public Map<String,InterceptorEnvironment> getInterceptorEnvironment()

getConcurrentContext

public ConcurrentContext getConcurrentContext()

getDefaultResourceJndiNames

public EEDefaultResourceJndiNames getDefaultResourceJndiNames()

getDefaultSecurityDomain

public String getDefaultSecurityDomain()

setDefaultSecurityDomain

public void setDefaultSecurityDomain(String defaultSecurityDomain)

getStartupBeansCount

public int getStartupBeansCount()

registerStartupBean

public int registerStartupBean()