/*
    * 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;
  
  import java.util.Properties;
  
  import de.smartics.ci.comm.command.CommandException;
  import de.smartics.ci.comm.command.CommandResult;
  import de.smartics.ci.comm.command.LoginCommandException;
  import de.smartics.ci.comm.hudson.command.HudsonCheckStatusJobCommand;
  import de.smartics.ci.comm.hudson.command.HudsonCreateJobCommand;
  import de.smartics.ci.comm.hudson.command.HudsonDeleteJobCommand;
  import de.smartics.ci.comm.hudson.command.HudsonDisableJobCommand;
  import de.smartics.ci.comm.hudson.command.HudsonEnableJobCommand;
  import de.smartics.ci.comm.hudson.command.HudsonGenericJobCommand;
  import de.smartics.ci.comm.hudson.command.HudsonLoginCommand;
  import de.smartics.ci.comm.hudson.command.HudsonUpdateJobCommand;
  
  /**
   * Controls the ci server. Right now only hudson.
   */
  public final class CiController
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The credentials used to login to the ci server.
     */
    private Credentials loginCredentials;
  
    /**
     * The proxy information used to connect to the network using a proxy.
     */
    private ProxyInformation proxy;
  
    /**
     * The login command to use to login to the ci system.
     */
    private HudsonLoginCommand loginCommand;
  
    /**
     * The command to delete a job.
     */
    private HudsonDeleteJobCommand deleteJobCommand;
  
    /**
     * The command to create a job.
     */
    private HudsonCreateJobCommand createJobCommand;
  
    /**
     * the command to update a job.
     */
    private HudsonUpdateJobCommand updateJobCommand;
  
    /**
     * The command to enable a job.
     */
    private HudsonEnableJobCommand enableJobCommand;
  
    /**
     * The command to disable a job.
     */
    private HudsonDisableJobCommand disableJobCommand;
  
    /**
     * The command to check the status of a job.
     */
    private HudsonCheckStatusJobCommand checkStatusJobCommand;
  
    /**
     * The command to execute a generic command for a job.
     */
    private HudsonGenericJobCommand genericJobCommand;
  
    /**
     * The target system on which the commands are executed.
     */
    private final CiSystem target;
  
    /**
     * The log level for this controller.
    */
   private LogLevel logLevel;
 
   // ****************************** Initializer *******************************
 
   // ****************************** Constructors ******************************
 
   /**
    * Default constructor.
    *
    * @param system the system on which the commands are executed.
    */
   public CiController(final CiSystem system)
   {
     this.target = system;
   }
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Set the log level for this controller.
    *
    * @param logLevel the log level to use.
    */
   public void setLogLevel(final LogLevel logLevel)
   {
     this.logLevel = logLevel;
   }
 
   /**
    * Sets the credentials used to login to the ci server.
    *
    * @param loginCredentials the credentials used to login to the ci server.
    */
   public void setLoginCredentials(final Credentials loginCredentials)
   {
     this.loginCredentials = loginCredentials;
   }
 
   /**
    * Sets the proxy information used to connect to the network using a proxy.
    *
    * @param proxy the proxy information used to connect to the network using a
    *          proxy.
    */
   public void setProxyInformation(final ProxyInformation proxy)
   {
     this.proxy = proxy;
   }
 
   /**
    * Sets the login command to use to login to the ci system.
    *
    * @param loginCommand the login command to use to login to the ci system.
    */
   public void setLoginCommand(final HudsonLoginCommand loginCommand)
   {
     this.loginCommand = loginCommand;
     loginCommand.setLogLevel(logLevel);
   }
 
   /**
    * Sets the command to delete a job.
    *
    * @param deleteJobCommand the command to delete a job.
    */
   public void setDeleteJobCommand(final HudsonDeleteJobCommand deleteJobCommand)
   {
     this.deleteJobCommand = deleteJobCommand;
     deleteJobCommand.setLogLevel(logLevel);
   }
 
   /**
    * Sets the command to create a job.
    *
    * @param createJobCommand the command to create a job.
    */
   public void setCreateJobCommand(final HudsonCreateJobCommand createJobCommand)
   {
     this.createJobCommand = createJobCommand;
     createJobCommand.setLogLevel(logLevel);
   }
 
   /**
    * Sets the value for updateJobCommand.
    * <p>
    * the command to update a job.
    *
    * @param updateJobCommand the value for updateJobCommand.
    */
   public void setUpdateJobCommand(final HudsonUpdateJobCommand updateJobCommand)
   {
     this.updateJobCommand = updateJobCommand;
     updateJobCommand.setLogLevel(logLevel);
   }
 
   /**
    * Sets the command to enable a job.
    *
    * @param enableJobCommand the command to enable a job.
    */
   public void setEnableJobCommand(final HudsonEnableJobCommand enableJobCommand)
   {
     this.enableJobCommand = enableJobCommand;
     enableJobCommand.setLogLevel(logLevel);
   }
 
   /**
    * Sets the command to disable a job.
    *
    * @param disableJobCommand the command to disable a job.
    */
   public void setDisableJobCommand(
       final HudsonDisableJobCommand disableJobCommand)
   {
     this.disableJobCommand = disableJobCommand;
     disableJobCommand.setLogLevel(logLevel);
   }
 
   /**
    * Sets the command to check the status of a job.
    *
    * @param statusJobCommand the command to check a job.
    */
   public void setStatusJobCommand(
       final HudsonCheckStatusJobCommand statusJobCommand)
   {
     this.checkStatusJobCommand = statusJobCommand;
     checkStatusJobCommand.setLogLevel(logLevel);
   }
 
   /**
    * Sets the generic job command.
    *
    * @param genericJobCommand the command to execute on a job.
    */
   public void setGenericJobCommand(
       final HudsonGenericJobCommand genericJobCommand)
   {
     this.genericJobCommand = genericJobCommand;
     genericJobCommand.setLogLevel(logLevel);
   }
 
   // --- business -------------------------------------------------------------
 
   /**
    * Login to the target.
    *
    * @throws LoginCommandException when the login failed.
    */
   public void login() throws LoginCommandException
   {
     loginCommand.setLoginCredentials(loginCredentials);
     loginCommand.setProxyInformation(proxy);
     loginCommand.execute(target);
   }
 
   /**
    * Create a job on the target system.
    *
    * @param jobName the name of the job.
    * @param configString the config string.
    * @throws CommandException when the command failed.
    */
   public void createJob(final String jobName, final String configString)
     throws CommandException
   {
     createJobCommand.setJobName(jobName);
     createJobCommand.setConfigString(configString);
     createJobCommand.execute(target);
   }
 
   /**
    * Update a job on the target system.
    *
    * @param jobName the name of the job.
    * @param configString the config string.
    * @throws CommandException when the command failed.
    */
   public void updateJob(final String jobName, final String configString)
     throws CommandException
   {
     updateJobCommand.setJobName(jobName);
     updateJobCommand.setConfigString(configString);
     updateJobCommand.execute(target);
   }
 
   /**
    * Disable a job on the target system.
    *
    * @param jobName the name of the job.
    * @throws CommandException when the command failed.
    */
   public void disableJob(final String jobName) throws CommandException
   {
     disableJobCommand.setJobName(jobName);
     disableJobCommand.execute(target);
   }
 
   /**
    * Enable a job on the target system.
    *
    * @param jobName the name of the job.
    * @throws CommandException when the command failed.
    */
   public void enableJob(final String jobName) throws CommandException
   {
     enableJobCommand.setJobName(jobName);
     enableJobCommand.execute(target);
   }
 
   /**
    * Delete a job on the target system.
    *
    * @param jobName the name of the job.
    * @throws CommandException when the command failed.
    */
   public void deleteJob(final String jobName) throws CommandException
   {
     deleteJobCommand.setJobName(jobName);
     deleteJobCommand.execute(target);
   }
 
   /**
    * Check status of a job on the target system and return the result.
    *
    * @param jobName the name of the job.
    * @param xmlQueryString the xml api queryString to run at the ci server.
    * @param properties a list of key value pairs used to replace variables in
    *          the xml query string.
    * @return the result of the command or null.
    * @throws CommandException when the command failed.
    */
   public CommandResult<?> checkStatusJob(final String jobName,
       final String xmlQueryString, final Properties properties)
     throws CommandException
   {
     checkStatusJobCommand.setJobName(jobName);
     checkStatusJobCommand.setXmlQueryString(xmlQueryString);
     checkStatusJobCommand.setKeyValuePairs(properties);
     checkStatusJobCommand.execute(target);
     return checkStatusJobCommand.getResult();
   }
 
   /**
    * Check status of a job on the target system and return the result.
    *
    * @param jobName the name of the job.
    * @param apiUrl the api url.
    * @param xmlQueryString the xml api queryString to run at the ci server.
    * @param regexp the regexp to check the result.
    * @param properties a list of key value pairs used to replace variables in
    *          the xml query string.
    * @return the result of the command or null.
    * @throws CommandException when the command failed.
    */
   public CommandResult<?> executeGenericJobCommand(final String jobName,
       final String apiUrl, final String xmlQueryString, final String regexp,
       final Properties properties) throws CommandException
   {
     genericJobCommand.setJobName(jobName);
     genericJobCommand.setCiXmlJobApiUrl(apiUrl);
     genericJobCommand.setXmlQueryString(xmlQueryString);
     genericJobCommand.setResponseCheckingRegexp(regexp);
     genericJobCommand.setKeyValuePairs(properties);
     genericJobCommand.execute(target);
     return genericJobCommand.getResult();
   }
 
   // --- object basics --------------------------------------------------------
 
 }