/*
    * Copyright 2012 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.ci.comm.hudson.command;
  
  import java.io.IOException;
  
  import org.apache.commons.httpclient.HttpException;
  import org.apache.commons.httpclient.methods.PostMethod;
  import org.apache.commons.httpclient.util.URIUtil;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import de.smartics.ci.comm.CiSystem;
  import de.smartics.ci.comm.LogHelper;
  import de.smartics.ci.comm.command.CommandException;
  import de.smartics.ci.comm.command.InvalidRequestException;
  
  /**
   * Check status job command.
   */
  public final class HudsonGenericJobCommand extends
      AbstractHudsonApiJob<HudsonGenericJobCommand>
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * Reference to the logger for this class.
     */
    static final Logger LOG = LoggerFactory
        .getLogger(HudsonGenericJobCommand.class);
  
    /**
     * The ci xml job api URL.
     */
    private String ciXmlJobApiUrl;
  
    /**
     * The regexp to check the response.
     */
    private String regexp;
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param jobName the name of the job that shall be checked.
     */
    public HudsonGenericJobCommand(final String jobName)
    {
      super(jobName);
    }
  
    /**
     * Default constructor. Sets jobName to null. Must be set before using this
     * command.
     */
    public HudsonGenericJobCommand()
    {
      this(null);
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    /**
     * Sets the ci xml job api URL.
     *
     * @param ciXmlJobApiUrl the ci xml job api URL.
     */
    public void setCiXmlJobApiUrl(final String ciXmlJobApiUrl)
    {
      this.ciXmlJobApiUrl = ciXmlJobApiUrl;
    }
  
   /**
    * Sets the regexp used to check if the response is valid. If the regexp
    * matches the response is treated as OK (true) but only if the response code
    * (HTTP response code) is 2xx or 3xx.
    *
    * @param regexp the regexp used to check the response.
    */
   public void setResponseCheckingRegexp(final String regexp)
   {
     this.regexp = regexp;
   }
 
   // --- business -------------------------------------------------------------
 
   @Override
   public void execute(final CiSystem target) throws CommandException
   {
     try
     {
       executeGenericJob(target);
     }
     catch (final Exception e)
     {
       throw new CommandException("Checking the status of job " + jobName
                                  + " failed.", e);
 
     }
   }
 
   private void executeGenericJob(final CiSystem target) throws HttpException,
     IOException, InvalidRequestException, CommandException
   {
     final String resolvedCiXmlJobApiUrl = resolve(ciXmlJobApiUrl);
     final String resolvedXmlQueryString = resolve(xmlQueryString);
 
     final PostMethod method = new PostMethod(resolvedCiXmlJobApiUrl);
 
     method.setQueryString(URIUtil.encodeQuery(resolvedXmlQueryString));
     addRequestHeaders(method);
 
     LogHelper.logInfo(LOG, logLevel,
         "Hudson: XML-API-URL called with queryString: \n\r"
             + resolvedCiXmlJobApiUrl + " :: " + resolvedXmlQueryString);
 
     final int statusCode = target.execute(method);
 
     createResult(statusCode, method);
     logResponse(getResult().getPageContent());
   }
 
   /**
    * Check the response.
    *
    * @param response the response.
    * @throws CommandException when command failed.
    */
   protected void checkResponseString(final String response)
     throws CommandException
   {
     final String resolvedRegexp = resolve(regexp);
     if (!response.matches(resolvedRegexp))
     {
       LogHelper.logError(LOG, logLevel,
           "Regexp did not match response! Regexp: " + resolvedRegexp);
       throw new CommandException("Regexp did not match response! Regexp: "
                                  + resolvedRegexp);
     }
   }
 
   // --- object basics --------------------------------------------------------
 
 }