/*
    * Copyright (c) 2001 - 2005 ivata limited.
    * All rights reserved.
    * -----------------------------------------------------------------------------
    * ivata masks may be redistributed under the GNU General Public
    * License as published by the Free Software Foundation;
    * version 2 of the License.
    *
    * These programs are free software; you can redistribute them and/or
   * modify them under the terms of the GNU General Public License
   * as published by the Free Software Foundation; version 2 of the License.
   *
   * These programs are distributed in the hope that they 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 in the file LICENSE.txt for more
   * details.
   *
   * If you would like a copy of the GNU General Public License write to
   *
   * Free Software Foundation, Inc.
   * 59 Temple Place - Suite 330
   * Boston, MA 02111-1307, USA.
   *
   *
   * To arrange commercial support and licensing, contact ivata at
   *                  http://www.ivata.com/contact.jsp
   * -----------------------------------------------------------------------------
   * $Log: InputMaskAction.java,v $
   * Revision 1.12.2.1  2005/10/08 10:53:22  colinmacleod
   * Added debug logging when value object is modified or added.
   *
   * Revision 1.12  2005/04/11 14:52:05  colinmacleod
   * Added execute override.
   *
   * Revision 1.11  2005/04/09 18:04:18  colinmacleod
   * Changed copyright text to GPL v2 explicitly.
   *
   * Revision 1.10  2005/03/10 10:37:56  colinmacleod
   * Added handling of client-program session to
   * persistence session.
   *
   * Revision 1.9  2005/01/19 12:56:36  colinmacleod
   * Added OperationNotSupportedException to clear.
   *
   * Revision 1.8  2005/01/10 19:06:02  colinmacleod
   * Applied persistence manager methods to remove.
   *
   * Revision 1.7  2005/01/07 08:08:24  colinmacleod
   * Moved up a version number.
   * Changed copyright notices to 2005.
   * Updated the documentation:
   *   - started working on multiproject:site docu.
   *   - changed the logo.
   * Added checkstyle and fixed LOADS of style issues.
   * Added separate thirdparty subproject.
   * Added struts (in web), util and webgui (in webtheme) from ivata op.
   *
   * Revision 1.6  2004/12/29 15:32:19  colinmacleod
   * List/input mask actions are no longer hard-coded.
   * Overrides added via request parameters
   * - defaults via new methods on the factory.
   *
   * Revision 1.5  2004/12/23 21:28:32  colinmacleod
   * Modifications to add ivata op compatibility.
   *
   * Revision 1.4  2004/11/12 15:10:42  colinmacleod
   * Moved persistence classes from ivata op as a replacement for
   * ValueObjectLocator.
   *
   * Revision 1.3  2004/11/11 13:49:46  colinmacleod
   * Added log4j logging.
   *
   * Revision 1.2  2004/05/19 20:34:17  colinmacleod
   * Added methods to add, amend and remove value objects.
   *
   * Revision 1.1.1.1  2004/05/16 20:40:33  colinmacleod
   * Ready for 0.1 release
   * -----------------------------------------------------------------------------
   */
  package com.ivata.mask.web.struts;
  import java.util.List;
  
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  import javax.servlet.http.HttpSession;
  
  import org.apache.log4j.Logger;
  import org.apache.struts.action.ActionErrors;
  import org.apache.struts.action.ActionForm;
  import org.apache.struts.action.ActionMapping;
  
  import com.ivata.mask.MaskFactory;
  import com.ivata.mask.persistence.PersistenceManager;
  import com.ivata.mask.persistence.PersistenceSession;
  import com.ivata.mask.util.StringHandling;
  import com.ivata.mask.util.SystemException;
  import com.ivata.mask.valueobject.ValueObject;
 /***
  * <p>
  * Add, amend or remove an existing value object in the list of value objects.
  * </p>
  *
  * @since ivata masks 0.4 (2004-05-10)
  * @author Colin MacLeod
  * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
  * @version $Revision: 1.12.2.1 $
  */
 public class InputMaskAction extends MaskAction {
     /***
      * <p>
      * This log provides tracing and debugging information.
      * </p>
      */
     private Logger log = Logger.getLogger(InputMaskAction.class);
     /***
      * <p>
      * This factory is needed to access the masks and groups of masks.
      * </p>
      */
     private MaskFactory maskFactory;
     /***
      * <p>
      * Used to locate the value objects by their shared base class.
      * </p>
      */
     private PersistenceManager persistenceManager;
     /***
      * <p>
      * Create a new AddAction with the given value object locator.
      * </p>
      *
      * @param persistenceManagerParam
      *            used to locate the value objects by their shared base class.
      * @param maskFactoryParam
      *            Refer to {@link MaskAction#MaskAction}.
      * @param authenticatorParam
      *            Refer to {@link MaskAction#MaskAction}.
      */
     public InputMaskAction(final MaskFactory maskFactoryParam,
             final PersistenceManager persistenceManagerParam,
             final MaskAuthenticator authenticatorParam) {
         super(maskFactoryParam, authenticatorParam);
         this.maskFactory = maskFactoryParam;
         this.persistenceManager = persistenceManagerParam;
     }
 
     /***
      * Overridden to trap the Clear/New button. If this is pressed, the forward
      * <code>new</code> is returned which you can then route to
      * <code>NewAction</code> via the <strong>Struts</strong> framework.
      *
      * @param mappingParam
      * Refer to {@link MaskAction#execute}.
      * @param errorsParam
      * Refer to {@link MaskAction#execute}.
      * @param formParam
      * Refer to {@link MaskAction#execute}.
      * @param requestParam
      * Refer to {@link MaskAction#execute}.
      * @param responseParam
      * Refer to {@link MaskAction#execute}.
      * @param sessionParam
      * Refer to {@link MaskAction#execute}.
      * @return <code>new</code> if the new/clear button was pressed, otherwise
      * the same as the super constructor.
      * @throws SystemException
      * Refer to {@link MaskAction#execute}.
      */
     public String execute(ActionMapping mappingParam, ActionErrors errorsParam,
             ActionForm formParam, HttpServletRequest requestParam,
             HttpServletResponse responseParam, HttpSession sessionParam)
             throws SystemException {
         String clear = getFromRequestOrForm("clear", requestParam, formParam);
         if (!StringHandling.isNullOrEmpty(clear)) {
             return "new";
         }
         return super.execute(mappingParam, errorsParam, formParam,
                 requestParam, responseParam, sessionParam);
     }
     /***
      * <p>
      * Adds the value object to the list, or amends an existing value object.
      * </p>
      *
      * @param mapping
      *            Refer to
      *            {@link com.ivata.mask.web.struts.MaskAction#onConfirm}.
      * @param errors
      *            Refer to
      *            {@link com.ivata.mask.web.struts.MaskAction#onConfirm}.
      * @param form
      *            Refer to
      *            {@link com.ivata.mask.web.struts.MaskAction#onConfirm}.
      * @param request
      *            Refer to
      *            {@link com.ivata.mask.web.struts.MaskAction#onConfirm}.
      * @param response
      *            Refer to
      *            {@link com.ivata.mask.web.struts.MaskAction#onConfirm}.
      * @param session
      *            Refer to
      *            {@link com.ivata.mask.web.struts.MaskAction#onConfirm}.
      * @param defaultForward Refer to
      *            {@link com.ivata.mask.web.struts.MaskAction#onConfirm}.
      * @return Refer to {@link com.ivata.mask.web.struts.MaskAction#onConfirm}.
      * @throws SystemException
      *             Refer to
      *             {@link com.ivata.mask.web.struts.MaskAction#onConfirm}.
      */
     public String onConfirm(final ActionMapping mapping,
             final ActionErrors errors, final ActionForm form,
             final HttpServletRequest request,
             final HttpServletResponse response,
             final HttpSession session,
             final String defaultForward) throws SystemException {
         assert (form != null);
         InputMaskForm maskForm = (InputMaskForm) form;
         Class baseClass = maskForm.getBaseClass();
         ValueObject valueObject = maskForm.getValueObject();
         String thisIdString = valueObject.getIdString();
         // if the id string is null or empty, we should add a new item to the
         // list
         PersistenceSession persistenceSession =
             persistenceManager.openSession(session.getAttribute(
                     "securitySession"));
         try {
             if (StringHandling.isNullOrEmpty(thisIdString)) {
                 if (log.isDebugEnabled()) {
                     log.debug("Adding new value object with "
                         + valueObject.getClass()
                         + ": "
                         + valueObject);
                 }
                 valueObject = persistenceManager.add(persistenceSession,
                         valueObject);
             } else {
                 if (log.isDebugEnabled()) {
                     log.debug("Modifiing value object with "
                         + valueObject.getClass()
                         + ", id "
                         + valueObject.getIdString()
                         + ": "
                         + valueObject);
                 }
                 // if it is not a new item, find the existing one and amend it
                 persistenceManager.amend(persistenceSession, valueObject);
             }
         } finally {
             persistenceSession.close();
         }
         if (maskForm.isRefreshOpener()) {
             request.setAttribute("refreshOpener", "true");
         }
         return defaultForward;
     }
     /***
      * <p>
      * Removes the value object from the list.
      * </p>
      * @param mapping
      * Refer to {@link com.ivata.mask.web.struts.MaskAction#onDelete}.
      * @param errors
      * Refer to {@link com.ivata.mask.web.struts.MaskAction#onDelete}.
      * @param form
      * Refer to {@link com.ivata.mask.web.struts.MaskAction#onDelete}.
      * @param request
      * Refer to {@link com.ivata.mask.web.struts.MaskAction#onDelete}.
      * @param response
      * Refer to {@link com.ivata.mask.web.struts.MaskAction#onDelete}.
      * @param session
      * Refer to {@link com.ivata.mask.web.struts.MaskAction#onDelete}.
      *
      * @return Refer to {@link com.ivata.mask.web.struts.MaskAction#onDelete}.
      * @throws SystemException
      * Refer to {@link com.ivata.mask.web.struts.MaskAction#onDelete}.
      */
     public String onDelete(final ActionMapping mapping,
             final ActionErrors errors, final ActionForm form,
             final HttpServletRequest request,
             final HttpServletResponse response,
             final HttpSession session,
             final String defaultForward)
             throws SystemException {
         InputMaskForm maskForm = (InputMaskForm) form;
         Class baseClass = maskForm.getBaseClass();
         PersistenceSession persistenceSession = persistenceManager
                 .openSession();
         List valueObjects;
         boolean found = false;
         ValueObject thisValueObject = maskForm.getValueObject();
         String thisIdString = thisValueObject.getIdString();
         try {
             persistenceManager.remove(
                     persistenceSession,
                     baseClass,
                     thisIdString);
         } finally {
             persistenceSession.close();
         }
         clear(mapping, errors, form, request, response, session);
         if (maskForm.isRefreshOpener()) {
             request.setAttribute("refreshOpener", "true");
         }
         return defaultForward;
     }
 }