/*
    * $Header: /cvsroot/sinon/sinon/src/java/eteg/sinon/core/CollectorConfiguration.java,v 1.2 2005/06/21 14:25:07 thiagohp Exp $
    * $Revision: 1.2 $
    * $Date: 2005/06/21 14:25:07 $
    * $Author: thiagohp $
    *
    * =============================================================================
    *
    * Copyright 2004-2005 Eteg Internet Ltda. (http://www.eteg.com.br)
   *
   * 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 eteg.sinon.core;
  
  import java.util.ArrayList;
  import java.util.List;
  import java.util.Properties;
  
  /***
   * Class that represents the configurations of a {@link Collector}.
   *
   * @author <a href="mailto:thiagohp at users.sourceforge.net">Thiago H. de Paula Figueiredo</a>
   * @author Last modified by $Author: thiagohp $
   * @version $Revision: 1.2 $
   * @see Collector
   */
  public class CollectorConfiguration {
  
      /***
       * Default timeout value: 10000 milliseconds.
       */
      private static final int DEFAULT_TIMEOUT = 10000;
  
      /***
       * Default retries value: 1.
       */
      private static final int DEFAULT_RETRIES = 1;
  
      /***
       * HTTP headers to be sent to Web sites.
       */
      private Properties httpHeaders;
  
      /***
       * List of security configurations.
       */
      private List securityConfigurations;
  
      /***
       * Fully qualified name of the class that implements the think time.
       */
      private String thinkTimeImplementationClassName;
  
      /***
       * Properties used as think time configurations.
       */
      private Properties thinkTimeProperties;
  
      /***
       * Connection timeout in milliseconds.
       */
      private int timeout;
  
      /***
       * Maximum number of download attempts of a given page.
       */
      private int retries;
  
      /***
       * Constructor without parameters.
       */
      public CollectorConfiguration() {
  
          securityConfigurations = new ArrayList();
          httpHeaders = new Properties();
          thinkTimeImplementationClassName = null;
          thinkTimeProperties = new Properties();
          timeout = DEFAULT_TIMEOUT;
          retries = DEFAULT_RETRIES;
  
      }
  
      /***
       * Returns the value of the <code>thinkTimeImplementationClassName</code>
       * property.
       * @return a <code>String</code>.
       */
      public String getThinkTimeImplementationClassName() {
          return thinkTimeImplementationClassName;
     }
 
     /***
      * Sets the value of the <code>thinkTimeImplementationClassName</code>
      * property.
      * @param thinkTimeImplementationClassName the new
      * <code>thinkTimeImplementationClassName</code> value.
      */
     public void setThinkTimeImplementationClassName(
             String thinkTimeImplementationClassName) {
 
         this.thinkTimeImplementationClassName =
                 thinkTimeImplementationClassName;
 
     }
 
     /***
      * Adds a (<code>name</code>, <code>value</code>) pair in the
      * think time configurations.
      * @param name a <code>String</code> containing the configuration name.
      * @param value a <code>String</code> containing the configuration value.
      */
     public void setThinkTimeProperty(String name, String value) {
         thinkTimeProperties.setProperty(name, value);
     }
 
     /***
      * Adds a (<code>name</code>, <code>value</code>) pair in the set of
      * HTTP headers sent to the Web site.
      * @param name a <code>String</code> containing the configuration name.
      * @param value a <code>String</code> containing the configuration value.
      */
     public void setHTTPHeader(String name, String value) {
         httpHeaders.setProperty(name, value);
     }
 
     /***
      * Returns the value associated with a given HTTP header.
      * @param name a <code>String</code> containing the name of the HTTP header.
      * @return a <code>String</code> containing the value associated with
      * the HTTP header or <code>null</code> if there is no such HTTP header.
      */
     public String getHTTPHeader(String name) {
         return httpHeaders.getProperty(name);
     }
 
     /***
      * Adds a {@link SecurityConfiguration} to this object.
      * @param configuration a {@link SecurityConfiguration} instance.
      */
     public void addSecurityConfiguration(SecurityConfiguration configuration) {
         securityConfigurations.add(configuration);
     }
 
     /***
      * Returns the value of the <code>securityConfigurations</code> property.
      * @return a a {@link SecurityConfiguration} array.
      */
     public SecurityConfiguration[] getSecurityConfigurations() {
 
         SecurityConfiguration[] configurations =
                 new SecurityConfiguration[securityConfigurations.size()];
 
         securityConfigurations.toArray(configurations);
 
         return configurations;
 
     }
 
     /***
      * Returns the {@link SecurityConfiguration} whose identifier is
      * <code>id</code>.
      * @param id a <code>String</code>.
      * @return a {@link SecurityConfiguration} instance or <code>null</code> if
      * there is no {@link SecurityConfiguration} whose identifier is
      * <code>id</code>.
      * @throws IllegalArgumentException if <code>id</code> is
      * <code>null</code>.
      */
     public SecurityConfiguration getSecurityConfiguration(String id) {
 
         final int size = securityConfigurations.size();
         SecurityConfiguration configuration;
 
         for (int i = 0; i < size; i++) {
 
             configuration =
                     (SecurityConfiguration) securityConfigurations.get(i);
 
             if (id.equals(configuration.getId())) {
                 return configuration;
             }
 
         }
 
         return null;
 
     }
 
     /***
      * Returns the value of the <code>httpHeaders</code> property.
      * @return a <code>String</code>.
      */
     public Properties getHttpHeaders() {
         return httpHeaders;
     }
 
     /***
      * Returns the value of the <code>thinkTimeProperties</code> property.
      * @return a <code>Properties</code> instance.
      */
     public Properties getThinkTimeProperties() {
         return thinkTimeProperties;
     }
 
     /***
      * Returns the value of the <code>timeout</code> property.
      * @return an <code>int</code>.
      */
     public int getTimeout() {
         return timeout;
     }
 
     /***
      * Sets the value of the <code>timeout</code> property.
      * @param timeout the new <code>timeout</code> value.
      */
     public void setTimeout(int timeout) {
         this.timeout = timeout;
     }
 
     /***
      * Returns the value of the <code>retries</code> property.
      * @return an <code>int</code>.
      */
     public int getRetries() {
         return retries;
     }
 
     /***
      * Sets the value of the <code>retries</code> property.
      * @param retries the new <code>retries</code> value.
      */
     public void setRetries(int retries) {
         this.retries = retries;
     }
 
 }