/**
    * Copyright 2005-2006 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.StatusForm;
  import org.figure8.join.core.DuplicateEntityException;
  import org.figure8.join.businessobjects.commons.Status;
  import org.figure8.join.businessfacades.commons.IntegrationProcessManager;
  import org.figure8.join.util.LogUtil;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.beanutils.PropertyUtils;
  import org.apache.struts.action.ActionForm;
  import org.apache.struts.action.ActionForward;
  import org.apache.struts.action.ActionMapping;
  
  import javax.servlet.http.HttpSession;
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  /**
   * Struts action used for managing Integration process status within Join application
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.1 $
   *
   * @struts.action path="/status" name="statusForm"
   *                scope="request" parameter="op" validate="true"
   *                input="/pages/mainpage.jsp?body=/jsp/status.jsp"
   * @struts.action-forward name="Status" path="/jsp/status.jsp"
   */
  public class StatusActions extends JoinAction{
  
     // Static -------------------------------------------------------------------
  
     /** Get a commons logger. */
     private static final Log log = LogUtil.getLog(StatusActions.class);
  
     /** Operation code for loading a specific Status */
     public static final String LOAD_OP = "load";
     /** Operation code for saving a Status (create or update) */
     public static final String SAVE_OP = "save";
  
     /**
      * The session scope attribute under which the Status object currently
      * selected by our logged-in User is stored.
      */
     public static final String STATUS_KEY = "status";
     /**
      * The request scope attribute under which is stored the Status that
      * has raised a DuplicateEntityException during save of another one.
      */
     public static final String DUPLICATE_STATUS_KEY = "duplicate";
     
     /** The request scope attribute under which is store the list of managed status. */
     public static final String STATUS_LIST_KEY = "statusList";
     
  
     // Attributes ---------------------------------------------------------------
  
     /** Join integration process manager. */
     protected IntegrationProcessManager processManager;
     
     
     // Constructors -------------------------------------------------------------
  
     /** Creates a new instance of StatusActions. */
     public StatusActions(){
     }
   
     
     // Public -------------------------------------------------------------------
  
     /** @param manager <code>IntegrationProcessManager</code> implementation instance */
     public void setIntegrationProcessManager(IntegrationProcessManager manager){
        this.processManager = manager;
     }
  
  
     // 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
     */
    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 (LOAD_OP.equals(operation)){
          return loadStatus(mapping, form, request, response);
       }
       else if (SAVE_OP.equals(operation)){
          return saveStatus(mapping, form, request, response);
       }
       else{
          // Default : empty status management page.
          request.getSession().removeAttribute(STATUS_KEY);
          request.setAttribute(STATUS_LIST_KEY, processManager.getStatus());
          return mapping.findForward("Status");
       }
    }
    
    
    // Protected ----------------------------------------------------------------
    
    /**
     * Load a specified status from datastore and fill form with it.
     * @return A forward to the next view to render and display
     */
    protected ActionForward loadStatus(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
       throws Exception{
 
       if (form instanceof StatusForm){
          // Get the requested status from manager.
          StatusForm sForm = (StatusForm)form;
          Status status = processManager.getStatus(sForm.getId());
 
          // Store status within session.
          HttpSession session = request.getSession();
          session.setAttribute(STATUS_KEY, status);
          // Copy form into the status properties.
          PropertyUtils.copyProperties(sForm, status);
 
          // Forward afert having refreshed list.
          request.setAttribute(STATUS_LIST_KEY, processManager.getStatus());
          return mapping.findForward("Status");
       }
       // This should not happen...
       return null;
    }
 
    /**
     * Save a status into datastore. The Status may be an already existing one or a
     * new one (this is indeed a create or update method).
     * @return A forward to the next view to render and display
     */
    protected ActionForward saveStatus(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
       throws Exception{
 
       if (form instanceof StatusForm){
          // Get the status form.
          StatusForm sForm = (StatusForm)form;
 
          // Is there's a status to update in session ?
          HttpSession session = request.getSession();
          Status status = (Status)session.getAttribute(STATUS_KEY);
 
          // Create a new Status or populate existing with form.
          if (status == null){
             log.info("Creation of a new Status with key: " + sForm.getKey());
             status = new Status(sForm.getKey(), sForm.getLabel(), sForm.getType());
             if (sForm.isTerminal())
                status.setTerminal(true);
             if (sForm.isCancelled())
                status.setCancelled(true);
          }
          else{
             log.info("Update of existing Status having key: " + status.getKey());
             PropertyUtils.copyProperties(status, sForm);
          }
          
          // Save status using manager.
          try {processManager.saveStatus(status);}
          catch (DuplicateEntityException dee){
             // Store exception within request.
             request.setAttribute(DUPLICATE_STATUS_KEY, dee.getOriginalEntity());
          }
 
          // Remove form and session attribute if present.
          session.removeAttribute(STATUS_KEY);
          removeObsoleteForm(mapping, request);
 
          // Forward after having refreshed list.
          request.setAttribute(STATUS_LIST_KEY, processManager.getStatus());
          return mapping.findForward("Status");
       }
       // This should not happen...
       return null;
    }
 }