org.jboss.weld.bootstrap.spi.BeanDeploymentArchive Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of weld-osgi-bundle Show documentation
Weld runtime packaged as an OSGi bundle
There is a newer version: 6.0.0.Beta4
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2010, Red Hat, Inc., and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,  
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jboss.weld.bootstrap.spi;

import java.util.Collection;

import org.jboss.weld.bootstrap.api.Bootstrap;
import org.jboss.weld.bootstrap.api.ServiceRegistry;
import org.jboss.weld.ejb.spi.EjbDescriptor;

/**
 * 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
 * {@link 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).
 * 
 * @see Deployment
 * 
 * @author Pete Muir
 * 
 */
public interface BeanDeploymentArchive
{

   /**
    * Get the bean deployment archives which are accessible to this bean
    * deployment archive and adjacent to it in the deployment archive graph.
    * 
    * Cycles in the accessible BeanDeploymentArchive graph are allowed. If a 
    * cycle is detected by Weld, it will be automatically removed by Web
    * Beans. This means any implementor of this interface don't need to worry
    * about circularities.
    * 
    * @return the accessible bean deployment archives
    */
   public Collection getBeanDeploymentArchives();

   /**
    * Gets all classes in the bean deployment archive
    * 
    * @return the classes, empty if no classes are present
    */
   public Collection getBeanClasses();

   /**
    * Get any deployment descriptors in the bean deployment archive.
    * 
    * The container will return a a merged view of the beans.xml per bean
    * deployment archive. This will normally represent a single file such as the
    * physical META-INF/beans.xml or WEB-INF/beans.xml)
    * 
    * The container may choose to parse beans.xml itself, or it may use Weld to
    * parse beans.xml
    * 
    * @return the parsed beans.xml
    * @see {@link Bootstrap#parse(java.net.URL)}
    * @see {@link Bootstrap#parse(Iterable)}
    */
   public BeansXml getBeansXml();

   /**
    * Get all the EJBs in the deployment archive
    * 
    * @return the EJBs, or empty if no EJBs are present or if
    *         this is not an EJB archive
    */
   public Collection> getEjbs();
   
   /**
    * Get the Bean Deployment Archive scoped services
    * 
    * @return
    */
   public ServiceRegistry getServices();
   
   /**
    * Get a string which uniquely identifies the {@link BeanDeploymentArchive} within
    * the {@link Deployment}. The identifier must be consistent between multiple
    * occurrences of this deployment.
    * 
    * @return
    */
   public String getId();

}