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.status;
   23   
   24   import javax.enterprise.deploy.spi.TargetModuleID;
   25   import javax.enterprise.deploy.spi.exceptions.OperationUnsupportedException;
   26   
   27   /**
   28    * Tracks the progress of a deployment
   29    *
   30    * @author <a href="mailto:adrian@jboss.org">Adrian Brock</a>
   31    * @version $Revision: 37459 $
   32    */
   33   public interface ProgressObject
   34   {
   35      // Constants -----------------------------------------------------
   36      
   37      // Public --------------------------------------------------------
   38      
   39      /**
   40       * Retrieve the status of the deployment
   41       *
   42       * @return the status
   43       */
   44      DeploymentStatus getDeploymentStatus();
   45      
   46      /**
   47       * Retrieve the resulting target module ids
   48       *
   49       * @return the module ids
   50       */
   51      TargetModuleID[] getResultTargetModuleIDs();
   52      
   53      /**
   54       * Return the client configuration associated with the module
   55       *
   56       * @param id the module id
   57       * @return the client configuration or null if none exists
   58       */
   59      ClientConfiguration getClientConfiguration(TargetModuleID id);
   60      
   61      /**
   62       * Is cancel supported
   63       *
   64       * @return true when cancel is supported, false otherwise
   65       */
   66      boolean isCancelSupported();
   67      
   68      /**
   69       * Cancels the deployment
   70       *
   71       * @throws OperationUnsupportedException when cancel is not supported
   72       */
   73      void cancel() throws OperationUnsupportedException;
   74      
   75      /**
   76       * Is stop supported
   77       *
   78       * @return true when stop is supported, false otherwise
   79       */
   80      boolean isStopSupported();
   81      
   82      /**
   83       * Stops the deployment
   84       *
   85       * @throws OperationUnsupportedException when stop is not supported
   86       */
   87      void stop() throws OperationUnsupportedException;
   88      
   89      /**
   90       * Add a progress listener
   91       *
   92       * @param listener the listener
   93       */
   94      void addProgressListener(ProgressListener listener);
   95      
   96      /**
   97       * Remove a progress listener
   98       *
   99       * @param listener the listener
  100       */
  101      void removeProgressListener(ProgressListener listener);
  102   }