/**
    * 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.form;
  
  import org.figure8.join.control.JoinForm;
  import org.figure8.join.control.action.ResourceActions;
  
  import org.apache.struts.action.ActionMapping;
  
  import javax.servlet.http.HttpServletRequest;
  
  import java.util.Map;
  import java.util.Date;
  import java.util.Arrays;
  import java.util.HashMap;
  import java.text.SimpleDateFormat;
  /**
   * Form object used for manipulating Resources into Join application
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.3 $
   *
   * @struts.form name="resourceForm"
   */
  public class ResourceForm extends JoinForm{
     
     // Attributes ---------------------------------------------------------------
     
     /** This resource name (must be unique) */
     private String name;
     /** The path to the log directory of this resource */
     private String logDirPath;
     /** The path to the current log file of this resource */
     private String logFilePath;
     /** The key of this resource type */
     private String resourceTypeKey;
     /** The identifier of machine this resource is hosted on */
     private long machineId = -1;
  
     /** The category of this resource (this determine its persistent implementation) */
     private String category;
     /** The starting date of changes tracking period. */
     private Date startDate;
     /** The ending date of changes tracking period. */
     private Date endDate;
     /** The hour of day for configuration time */
     private int startHour;
     /** The minute of hour for configuration time */
     private int startMin;
  
     /** The string representation of identifier of machine this resource is hosted on */
     private String machineIdStr;
     /** The String representation of changes tracking period start date. */
     private String startDateStr = null;
     /** The String representation of changes tracking period start hour. */
     private String startHourStr = null;
     /** The String representation of changes tracking period start minutes. */
     private String startMinStr = null;
     /** The String representation of changes tracking period end date. */
     private String endDateStr = null;
  
     /** The list of actually supported resource categories */
     public static final String[] SUPPORTED_CATEGORIES = {"EIS", "Service", "VersionedResource", "Gateway"};
     /** The map of actually supported resource implementations (key is the category) */
     public static Map SUPPORTED_IMPLEMENTATIONS;
  
     static{
        SUPPORTED_IMPLEMENTATIONS = new HashMap();
        SUPPORTED_IMPLEMENTATIONS.put("EIS", "org.figure8.join.businessobjects.environment.EIS");
        SUPPORTED_IMPLEMENTATIONS.put("Service", "org.figure8.join.businessobjects.environment.Service");
        SUPPORTED_IMPLEMENTATIONS.put("Gateway", "org.figure8.join.businessobjects.environment.Gateway");
        SUPPORTED_IMPLEMENTATIONS.put("VersionedResource", "org.figure8.join.businessobjects.environment.VersionedResource");
     }
  
  
     // Constructors -------------------------------------------------------------
     
     /** Creates a new instance of ResourceForm */
     public ResourceForm(){
     }
   
     
     // Public -------------------------------------------------------------------
  
     /** @return This resource name (must be unique) */
     public String getName(){
        return name;
     }
    /** @param name This resource name (must be unique) */
    public void setName(String name){
       this.name = name;
    }
    /** @return The path to the log directory of this resource */
    public String getLogDirPath(){
       return logDirPath;
    }
    /** @param logDirPath The path to the log directory of this resource */
    public void setLogDirPath(String logDirPath){
       this.logDirPath = logDirPath;
    }
    /** @return The path to the current log file of this resource */
    public String getLogFilePath(){
       return logFilePath;
    }
    /** @param logFilePath The path to the current log file of this resource */
    public void setLogFilePath(String logFilePath){
       this.logFilePath = logFilePath;
    }
    /** @return he key of this resource type */
    public String getResourceTypeKey(){
       return resourceTypeKey;
    }
    /** @param typeKey he key of this resource type */
    public void setResourceTypeKey(String typeKey){
       this.resourceTypeKey = typeKey;
    }
    /** @return The identifier of machine this resource is hosted on */
    public long getMachineId(){
       return machineId;
    }
    /** @param machineId The identifier of machine this resource is hosted on */
    public void setMachineId(long machineId){
       this.machineId = machineId;
       this.machineIdStr = String.valueOf(machineId);
    }
 
    /** @return The category of this resource (this determine its persistent implementation) */
    public String getCategory(){
       return category;
    }
    /** @param category The category of this resource (this determine its persistent implementation) */
    public void setCategory(String category){
       this.category = category;
    }
 
    /** @return The string representation of identifier of machine this resource is hosted on */
    public String getMachineIdStr(){
       return machineIdStr;
    }
    /** @param machineIdStr The string representation of identifier of machine this resource is hosted on */
    public void setMachineIdStr(String machineIdStr){
       this.machineIdStr = machineIdStr;
    }
    /** @return The starting date of changes tracking period */
    public Date getStartDate(){
       return startDate;
    }
    /** @param startDateStr The String representation of changes tracking period start date (must be a date) */
    public void setStartDateStr(String startDateStr){
       this.startDateStr = startDateStr;
    }
    /** @param startHourStr The String representation of changes tracking period start hour (must be an integer) */
    public void setStartHourStr(String startHourStr){
       this.startHourStr = startHourStr;
    }
    /** @param startMinStr The String representation of changes tracking period start minute (must be an integer) */
    public void setStartMinStr(String startMinStr){
       this.startMinStr = startMinStr;
    }
    /** @return The ending date of changes tracking period */
    public Date getEndDate(){
       return endDate;
    }
    /** @param endDateStr The String representation of changes tracking period start date (must be a date) */
    public void setEndDateStr(String endDateStr){
       this.endDateStr = endDateStr;
    }
 
    /**
     * Retrieve the supported resource categories for form validation purpose. This
     * is a hook that will allow subclasses to override and specifiy their supported
     * resource categories implementations.
     * @return The current default SUPPORTED_CATEGORIES static variable
     */
    public static String[] getSupportedCategories(){
       return SUPPORTED_CATEGORIES;
    }
 
    /**
     * Retrieve the FQN of the Java class representing a valid implementation for a
     * resource category. This is a hook that will allow subclasses to override and
     * specifiy their own categories implementations.
     * @param category The resource category to get implementation for
     * @return The full name of Java resource implementation or null if none match
     */
    public static String getSupportedImplementation(String category){
       return (String)SUPPORTED_IMPLEMENTATIONS.get(category);
    }
 
 
    // Implementation of JoinForm -----------------------------------------------
    
    /**
     * Validation of the form attributes.
     * @param operation String representing the operation to invoke on Action
     * @param mapping Mapping between forwards name and path for this action
     * @param request The servlet container request wrapper
     */
    public void doValidate(String operation, ActionMapping mapping, HttpServletRequest request){
 
       // Check if category is missing.
       if (category == null || category.length() == 0)
          addActionError("errors.required", getGuiMessageResources().getMessage("label.resource.category"));
       else{
          // Check if it is a valid category.
          if (!Arrays.asList(getSupportedCategories()).contains(category))
             addActionError("errors.invalid", getGuiMessageResources().getMessage("label.resource.category"));
       }
 
       // Check attributes depending on operation.
       if (ResourceActions.LOAD_OP.equals(operation)){
          // Check if identifier is missing.
          validateEntityObjectId();
       }
       else if (ResourceActions.SAVE_OP.equals(operation)){
          // Check if name is missing.
          if (name == null || name.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.resource.name"));
          // Check if resource type key is missing.
          if (resourceTypeKey == null || resourceTypeKey.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.resource.resourcetype"));
          // Check if machine identifier is missing if not an EIS.
          if (!"EIS".equals(category)){
             if (machineIdStr == null || machineIdStr.length() == 0)
                addActionError("errors.required", getGuiMessageResources().getMessage("label.resource.machine"));
             else{
                try {machineId = Long.valueOf(machineIdStr).longValue();}
                catch (Exception e){
                   addActionError("errors.integer", getGuiMessageResources().getMessage("label.resource.machine"));
                }
             }
          }
       }
       else if (ResourceActions.CONFIG_OP.equals(operation)){
          // Clear errors made so far.
          errors.clear();
          // Check if name is missing.
          if (name == null || name.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.resource.name"));
          // Check and see if starting date is missing.
          if (startDateStr == null || startDateStr.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.gateway.history.startdate"));
          else{
             // Build a format using a locale pattern.
             SimpleDateFormat format = new SimpleDateFormat(getMessageResources().getMessage("pattern.date.stringtodate"));
             // Check if it's parsable.
             try {startDate = format.parse(startDateStr);}
             catch (Exception e){
                addActionError("errors.format", getGuiMessageResources().getMessage("label.gateway.history.startdate"));
             }
          }
          // Check and see if start hour is missing.
          if (startHourStr == null || startHourStr.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.gateway.history.starthour"));
          else{
             // Check and see if start hour is an integer.
             try {startHour = Integer.valueOf(startHourStr).intValue();}
             catch (Exception e){
                addActionError("errors.integer", getGuiMessageResources().getMessage("label.gateway.history.starthour"));
             }
             // Check that it is in correct range.
             if (startHour < 0 || startHour > 23)
                addActionError("errors.range", getGuiMessageResources().getMessage("label.gateway.history.starthour"), "00", "23");
          }
          // Check and see if start minute is missing.
          if (startMinStr == null || startMinStr.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.gateway.history.startmin"));
          else{
             // Check and see if start minute is an integer.
             try {startMin = Integer.valueOf(startMinStr).intValue();}
             catch (Exception e){
                addActionError("errors.integer", getGuiMessageResources().getMessage("label.gateway.history.startmin"));
             }
             // Check that it is in correct range.
             if (startMin < 0 || startHour > 59)
                addActionError("errors.range", getGuiMessageResources().getMessage("label.gateway.history.startmin"), "00", "59");
          }
       }
       else if (ResourceActions.CHANGES_OP.equals(operation)){
          // Clear errors made so far.
          errors.clear();
          // Check if name is missing.
          if (name == null || name.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.resource.name"));
          // Check and see if starting date is missing.
          if (startDateStr == null || startDateStr.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.gateway.history.startdate"));
          else{
             // Build a format using a locale pattern.
             SimpleDateFormat format = new SimpleDateFormat(getMessageResources().getMessage("pattern.date.stringtodate"));
             // Check if it's parsable.
             try {startDate = format.parse(startDateStr);}
             catch (Exception e){
                addActionError("errors.format", getGuiMessageResources().getMessage("label.gateway.history.startdate"));
             }
          }
          // Check and see if ending date is missing.
          if (endDateStr == null || endDateStr.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.gateway.history.enddate"));
          else{
             // Build a format using a locale pattern.
             SimpleDateFormat format = new SimpleDateFormat(getMessageResources().getMessage("pattern.date.stringtodate"));
             // Check if it's parsable.
             try {endDate = format.parse(endDateStr);}
             catch (Exception e){
                addActionError("errors.format", getGuiMessageResources().getMessage("label.gateway.history.enddate"));
             }
          }
       }
    }
    
    
    // Override of ActionForm ---------------------------------------------------
 
    /**
     * Reset form attributes.
     * @param mapping Mapping between forwards name and path for this action
     * @param request The servlet container request wrapper
     */
    public void reset(ActionMapping mapping, HttpServletRequest request){
       super.reset(mapping, request);
       // Reset form attributes.
       name = null;
       machineId = -1;
       logDirPath = null;
       logFilePath = null;
       resourceTypeKey = null;
       category = null;
       machineIdStr = null;
    }
 }