/*
    * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
    *
    * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package de.smartics.maven.bugzilla.command;
  
  import java.util.ArrayList;
  import java.util.List;
  
  import de.smartics.maven.issue.command.AbstractCommand;
  import de.smartics.maven.issue.command.AddProductCommand;
  import de.smartics.maven.issue.command.CommandArgument;
  import de.smartics.maven.issue.command.CommandResult.Page;
  
  /**
   * Implementation of the {@link AddProductCommand} for Bugzilla.
   */
  public final class BugzillaAddProductCommand extends
      AbstractCommand<AddProductCommand> implements AddProductCommand
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    private static final long serialVersionUID = 1L;
  
    /**
     * The service on the command target to call.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    private static final String SERVICE = "editproducts.cgi";
  
    /**
     * The title of the expected page.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    private static final String EXPECTED_PAGE_TITLE = "Product Created";
  
    /**
     * The title of a page that signals a suspicious action. This title is
     * expected if for instance the classification is unknown.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    private static final String SUSPICIOUS_ACTION = "Suspicious Action";
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    // CHECKSTYLE:OFF
  
    /**
     * Default constructor.
     *
     * @param classification the classification for the product.
     * @param product the product to add the version to.
     * @param description the description to the product.
     * @param defaultMilestone the initial default milestone of the product.
     * @param version the first version of the product.
     * @param token the token from the previous command to help the browser to
     *          secure the request.
     * @param component the component to add on product creation.
     * @param componentDescription the description to the component.
     * @param componentInitialOwner the initial owner of the component.
     */
    public BugzillaAddProductCommand(
        // NOPMD
        final CommandArgument<AddProductCommand> classification,
        final CommandArgument<AddProductCommand> product,
        final CommandArgument<AddProductCommand> description,
        final CommandArgument<AddProductCommand> defaultMilestone,
        final CommandArgument<AddProductCommand> version,
        final CommandArgument<AddProductCommand> token,
        final CommandArgument<AddProductCommand> component,
       final CommandArgument<AddProductCommand> componentDescription,
       final CommandArgument<AddProductCommand> componentInitialOwner)
   {
     super(SERVICE, attachDefaulArguments(classification, product, description,
         defaultMilestone, version, token, component, componentDescription,
         componentInitialOwner));
   }
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   private static List<CommandArgument<AddProductCommand>> attachDefaulArguments(
       // NOPMD
       final CommandArgument<AddProductCommand> classification, // NOPMD
       final CommandArgument<AddProductCommand> product,
       final CommandArgument<AddProductCommand> description,
       final CommandArgument<AddProductCommand> defaultMilestone,
       final CommandArgument<AddProductCommand> version,
       final CommandArgument<AddProductCommand> token,
       final CommandArgument<AddProductCommand> component,
       final CommandArgument<AddProductCommand> componentDescription,
       final CommandArgument<AddProductCommand> componentInitialOwner)
   {
     final List<CommandArgument<AddProductCommand>> allArguments =
         new ArrayList<CommandArgument<AddProductCommand>>(8);
     final CommandArgument<AddProductCommand> action =
         CommandArgument.create(AddProductCommand.Parameter.ACTION, "new");
     allArguments.add(action);
     allArguments.add(classification);
     allArguments.add(product);
     allArguments.add(description);
     allArguments.add(defaultMilestone);
     allArguments.add(version);
     final CommandArgument<AddProductCommand> active =
         CommandArgument.create(AddProductCommand.Parameter.IS_ACTIVE, "1");
     allArguments.add(active);
     allArguments.add(token);
     if (component != null)
     {
       allArguments.add(component);
     }
     if (componentDescription != null)
     {
       allArguments.add(componentDescription);
     }
     if (componentInitialOwner != null)
     {
       allArguments.add(componentInitialOwner);
     }
     return allArguments;
   }
 
   // CHECKSTYLE:ON
 
   // --- get&set --------------------------------------------------------------
 
   // --- business -------------------------------------------------------------
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.maven.issue.command.AbstractCommand#checkExpectation(de.smartics.maven.issue.command.CommandResult.Page)
    */
   @Override
   protected Expectation checkExpectation(final Page page)
   {
     final boolean expected = EXPECTED_PAGE_TITLE.equals(page.getTitle());
     final Expectation expectation =
         new Expectation(expected, EXPECTED_PAGE_TITLE, expected
             ? EXPECTED_PAGE_TITLE : Expectation.UNKNOWN_FLAG);
     return expectation;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.maven.issue.command.AbstractCommand#getCommandResultDescription(Page,Expectation)
    */
   @Override
   protected String getCommandResultDescription(final Page page,
       final Expectation expectation)
   {
     final CommandArgument<AddProductCommand> productArg =
         getArgument(AddProductCommand.Parameter.PRODUCT);
     final String expectationFlag = expectation.getFlag();
     if (EXPECTED_PAGE_TITLE.equals(expectationFlag))
     {
       return "Successfully added product '" + productArg.getValue() + "'.";
     }
     else if (SUSPICIOUS_ACTION.equals(page.getTitle()))
     {
       return "Failed to add product '" + productArg.getValue()
              + "'. Maybe the classification is unknown?"
              + " Please check parameters below.";
     }
     else
     {
       return "Failed to add product '" + productArg.getValue() + "'.";
     }
   }
 
   // --- object basics --------------------------------------------------------
 
 }