org.jboss.webbeans.bootstrap.spi
Interface BeanDeploymentArchive

All Known Subinterfaces:

EJBModule

public interface BeanDeploymentArchive

Represents a CDI bean deployment archive. A deployment archive is any library jar, library directory, EJB jar, rar archive or any war WEB-INF/classes directory contained in the Java EE deployment (as defined in the Java Platform, Enterprise Edition (Java EE) Specification, v6, Section 8.1.2). TODO Java SE definition of a deployment archive A bean deployment archive is any deployment archive with a META-INF/beans.xml file, or for a war, with a WEB-INF/beans.xml. The container is allowed to specify a deployment archive as BeanDeploymentArchive even if no beans.xml is present (for example, a container could define a deployment archive with container specific metadata to be a bean deployment archive).

Author:

Pete Muir

See Also:

EJBModule, Deployment

Method Summary

java.lang.Iterable<java.lang.Class<?>>	getBeanClasses() Gets all classes in the bean deployment archive
java.util.List<BeanDeploymentArchive>	getBeanDeploymentArchives() Get the ordered bean deployment archives which are accessible to this bean deployment archive and adjacent to it i n the deployment archive graph.
java.lang.Iterable<java.net.URL>	getBeansXml() Get any deployment descriptors in the bean deployment archive.

Method Detail

getBeanDeploymentArchives

java.util.List<BeanDeploymentArchive> getBeanDeploymentArchives()

Get the ordered bean deployment archives which are accessible to this bean deployment archive and adjacent to it i n the deployment archive graph. The bean deployment archives will be processed in the order specified. Circular dependencies will be detected and ignored by the container

Returns:

the ordered accessible bean deployment archives

getBeanClasses

java.lang.Iterable<java.lang.Class<?>> getBeanClasses()

Gets all classes in the bean deployment archive

Returns:

an iteration over the classes, empty if no classes are present

getBeansXml

java.lang.Iterable<java.net.URL> getBeansXml()

Get any deployment descriptors in the bean deployment archive. The container will normally return a single deployment descriptor per bean deployment archive (the physical META-INF/beans.xml or WEB-INF/beans.xml), however it is permitted to return other deployment descriptors defined using other methods.

Returns:

an iteration over the URLs pointing to the deployment descriptor, or an empty set if none are present