1   /*
    2   * JBoss, Home of Professional Open Source
    3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
    4   * by the @authors tag. See the copyright.txt in the distribution for a
    5   * full listing of individual contributors.
    6   *
    7   * This is free software; you can redistribute it and/or modify it
    8   * under the terms of the GNU Lesser General Public License as
    9   * published by the Free Software Foundation; either version 2.1 of
   10   * the License, or (at your option) any later version.
   11   *
   12   * This software is distributed in the hope that it will be useful,
   13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   15   * Lesser General Public License for more details.
   16   *
   17   * You should have received a copy of the GNU Lesser General Public
   18   * License along with this software; if not, write to the Free
   19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
   20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
   21   */
   22   package javax.enterprise.deploy.spi;
   23   
   24   import java.beans.PropertyChangeListener;
   25   
   26   import javax.enterprise.deploy.model.DDBean;
   27   import javax.enterprise.deploy.model.XpathEvent;
   28   import javax.enterprise.deploy.spi.exceptions.BeanNotFoundException;
   29   import javax.enterprise.deploy.spi.exceptions.ConfigurationException;
   30   
   31   /**
   32    * A configuration associated with one or more deployment descriptors.
   33    *
   34    * @author <a href="mailto:adrian@jboss.org">Adrian Brock</a>
   35    * @version $Revision: 37459 $
   36    */
   37   public interface DConfigBean
   38   {
   39      // Constants -----------------------------------------------------
   40      
   41      // Public --------------------------------------------------------
   42      
   43      /**
   44       * Get the XML text for this configuration
   45       *
   46       * @return the xml text
   47       */
   48      DDBean getDDBean();
   49      
   50      /**
   51       * Get the xpaths this deployment descriptor requires
   52       *
   53       * @return the xpaths
   54       */
   55      String[] getXpaths();
   56      
   57      /**
   58       * Return the JavaBean containing server specific deployment information
   59       *
   60       * @param bean the xml data to be evaluated
   61       * @return the server specific configuration 
   62       * @throws ConfigurationException for errors generating the configuring bean
   63       */
   64      DConfigBean getDConfigBean(DDBean bean) throws ConfigurationException;
   65      
   66      /**
   67       * Remove a child
   68       *
   69       * @param bean the child
   70       * @throws BeanNotFoundException when the bean is not found
   71       */
   72      void removeDConfigBean(DConfigBean bean) throws BeanNotFoundException;
   73      
   74      /**
   75       * A notification that the DDBean provided has changed and that this bean or
   76       * child needs re-evaluating
   77       *
   78       * @param event the event
   79       */
   80      void notifyDDChange(XpathEvent event);
   81      
   82      /**
   83       * Add a property change listener
   84       *
   85       * @param listener the listener
   86       */
   87      void addPropertyChangeListener(PropertyChangeListener listener);
   88      
   89      /**
   90       * Remove a property change listener
   91       *
   92       * @param listener the listener
   93       */
   94      void removePropertyChangeListener(PropertyChangeListener listener);
   95   }