/**
    * Copyright 2005-2007 the original author or authors.
    *
    * Licensed under the Gnu General Pubic 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.opensource.org/licenses/gpl-license.php
    *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   * See the Gnu General Public License for more details.
   */
  package org.figure8.join.control.action;
  
  import org.figure8.join.control.JoinAction;
  import org.figure8.join.control.form.DeploymentsForm;
  import org.figure8.join.businessfacades.environment.EnvironmentManager;
  import org.figure8.join.businessobjects.environment.EnvironmentMapping;
  import org.figure8.join.businessobjects.environment.LogicalEnvironment;
  import org.figure8.join.businessobjects.environment.PhysicalEnvironment;
  import org.figure8.join.util.LogUtil;
  
  import org.apache.commons.logging.Log;
  import org.apache.struts.action.ActionForm;
  import org.apache.struts.action.ActionForward;
  import org.apache.struts.action.ActionMapping;
  
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  
  import java.util.List;
  /**
   * This is a Struts action controller for managing Deployments retrieval related operations.
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.1 $
   * @struts.action path="/deployments" name="DeploymentsForm"
   *                scope="request" parameter="op" validate="true"
   *                input="/pages/mainpage.jsp?body=/jsp/environment/deploymentshistory.jsp"
   * @struts.action-forward name="History" path="/jsp/environment/deploymentshistory.jsp"
   */
  public class DeploymentsActions extends JoinAction{
  
     // Static -------------------------------------------------------------------
     
     /** Get a commons logger */
     private static final Log log = LogUtil.getLog(DeploymentsActions.class);
  
     /** Operation code for retrieving deployments for a logical environment. */
     public static final String LOGICALENV_OP = "getByLogical";
     /** Operation code for retrieving deployments for a physical environment. */
     public static final String PHYSICALENV_OP = "getByPhysical";
     /** Operation code for retrieving deployments for an environment mapping. */
     public static final String ENVMAPPING_OP = "getByEnvMapping";
  
     /** The request scope for specifying the title of the screen (used by view) */
     public static final String TITLE_KEY = "title";
  
     /**
      * The request scope attribute under which the retrivied deployments
      * list is stored.
      */
     public static final String DEPLOYMENTS_KEY = "deployments";
  
  
     // Attributes ---------------------------------------------------------------
  
     /** The EnvironmentManager implementation to use */
     protected EnvironmentManager environmentManager = null;
  
  
     // Constructors -------------------------------------------------------------
  
     /** Creates a new instance of DeploymentsActions. */
     public DeploymentsActions(){
     }
  
  
     // Public -------------------------------------------------------------------
  
     /** @param environmentManager The EnvironmentManager implementation to use */
     public void setEnvironmentManager(EnvironmentManager environmentManager){
        this.environmentManager = environmentManager;
     }
  
  
     // Implementation of JoinAction ---------------------------------------------
  
     /**
      * @param operation String representing the operation to invoke on Action
      * @param mapping Mapping between forwards name and path for this action
      * @param form The form object containing request parameters
      * @param request The servlet container request wrapper
      * @param response The servlet container response wrapper
      * @return A forward to the next view to render and display
      * @throws Exception such as InfraStructureExceptions ...
      */
     public ActionForward doExecute(String operation, ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       // Trace operation to execute.
       log.debug("doExecute() called for '" + operation + "' operation");
 
       if (form instanceof DeploymentsForm){
          // Get deployments form for operations.
          DeploymentsForm dForm = (DeploymentsForm)form;
 
          if (LOGICALENV_OP.equals(operation)){
             return getDeploymentsForLogicalEnvironment(mapping, dForm, request, response);
          }
          else if (PHYSICALENV_OP.equals(operation)){
             return getDeploymentsForPhysicalEnvironment(mapping, dForm, request, response);
          }
          else if (ENVMAPPING_OP.equals(operation)){
             return getDeploymentsForEnvironmentMapping(mapping, dForm, request, response);
          }
       }
 
       // This should not happen...
       return null;
    }
 
 
    // Protected ----------------------------------------------------------------
 
    /**
     * Retrieve deployments for a specified logical environment.
     * @return A forward to the next view to render and display
     */
    protected ActionForward getDeploymentsForLogicalEnvironment(ActionMapping mapping, DeploymentsForm form,
                                                    HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       // Retrieve deployments from manager.
       LogicalEnvironment environment = environmentManager.getLogicalEnvironment(form.getLogicalEnvKey());
       List deployments = environmentManager.getDeployments(environment);
       // Store into request attributes before forwarding.
       request.setAttribute(LogicalEnvironmentActions.ENVIRONMENT_KEY, environment);
       request.setAttribute(DEPLOYMENTS_KEY, deployments);
       request.setAttribute(TITLE_KEY, "title.deployments.bylogicalenv");
       request.setAttribute("criterion", "logicalenv");
 
       return mapping.findForward("History");
    }
 
    /**
     * Retrieve deployments for a specified physical environment.
     * @return A forward to the next view to render and display
     */
    protected ActionForward getDeploymentsForPhysicalEnvironment(ActionMapping mapping, DeploymentsForm form,
                                                    HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       // Retrieve deployments from manager.
       PhysicalEnvironment environment = environmentManager.getPhysicalEnvironment(form.getPhysicalEnvKey());
       List deployments = environmentManager.getDeployments(environment);
       // Store into request attributes before forwarding.
       request.setAttribute(PhysicalEnvironmentActions.ENVIRONMENT_KEY, environment);
       request.setAttribute(DEPLOYMENTS_KEY, deployments);
       request.setAttribute(TITLE_KEY, "title.deployments.byphysicalenv");
       request.setAttribute("criterion", "physicalenv");
 
       return mapping.findForward("History");
    }
 
    /**
     * Retrieve deployments for a specified environment mapping.
     * @return A forward to the next view to render and display
     */
    protected ActionForward getDeploymentsForEnvironmentMapping(ActionMapping mapping, DeploymentsForm form,
                                                    HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       // Retrieve environment mapping from manager.
       EnvironmentMapping envMapping = environmentManager.getEnvironmentMapping(form.getId());
       // Store into request attributes before forwarding.
       request.setAttribute(EnvironmentMappingActions.MAPPING_KEY, envMapping);
       request.setAttribute(DEPLOYMENTS_KEY, envMapping.getDeployments());
       request.setAttribute(TITLE_KEY, "title.deployments.byenvmapping");
       request.setAttribute("criterion", "envmapping");
 
       return mapping.findForward("History");
    }
 }