/*
    * 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.apache.commons.lang.StringUtils;
  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 HudsonCheckStatusJobCommand extends
      AbstractHudsonApiJob<HudsonCheckStatusJobCommand>
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * Reference to the logger for this class.
     */
    private static final Logger LOG = LoggerFactory
        .getLogger(HudsonCheckStatusJobCommand.class);
  
    /**
     * The default query string to use for the xml api. Uses one variable
     * ${jobName}, that will be resolved.
     */
    private static final String DEFAULT_XML_QUERY_STRING =
        "tree=jobs[name]&xpath=hudson/job[name=\"${jobName}\"]/name/text()";
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param jobName the name of the job that shall be checked.
     */
    public HudsonCheckStatusJobCommand(final String jobName)
    {
      super(jobName);
    }
  
    /**
     * Default constructor. Sets jobName to null. Must be set before using this
     * command.
     */
    public HudsonCheckStatusJobCommand()
    {
      this(null);
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    @Override
    public void execute(final CiSystem target) throws CommandException
    {
      try
      {
        checkJobStatus(target);
      }
      catch (final Exception e)
      {
        throw new CommandException("Checking the status of job " + jobName
                                  + " failed.", e);
 
     }
   }
 
   private void checkJobStatus(final CiSystem target) throws HttpException,
     IOException, InvalidRequestException, CommandException
   {
     final String apiUrl = buildCiXmlJobApiUrl(target.getUrl(), "api/xml");
     final PostMethod method = new PostMethod(apiUrl);
     final String resolvedXmlQueryString;
     if (StringUtils.isBlank(xmlQueryString))
     {
       resolvedXmlQueryString = resolve(DEFAULT_XML_QUERY_STRING);
     }
     else
     {
       resolvedXmlQueryString = resolve(xmlQueryString);
     }
 
     method.setQueryString(URIUtil.encodeQuery(resolvedXmlQueryString));
     addRequestHeaders(method);
 
     LogHelper.logInfo(LOG, logLevel,
         "Hudson: XML-API-Url with queryString: \n\r" + apiUrl + " :: "
             + resolvedXmlQueryString);
 
     final int statusCode = target.execute(method);
 
     createResult(statusCode, method);
     logResponse(getResult().getPageContent());
 
   }
 
   private String buildCiXmlJobApiUrl(final String url, final String postPart)
   {
     return url + "/" + postPart;
   }
 
 }