/*
 * Copyright 2009 Google Inc.
 * 
 * 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 com.google.jstestdriver.config;

import com.google.gson.JsonArray;
import com.google.jstestdriver.FileInfo;
import com.google.jstestdriver.Flags;
import com.google.jstestdriver.PathResolver;
import com.google.jstestdriver.Plugin;
import com.google.jstestdriver.browser.DocType;
import com.google.jstestdriver.model.BasePaths;
import com.google.jstestdriver.model.HandlerPathPrefix;

import java.io.File;
import java.util.List;
import java.util.Set;



/**
 * The interface for configuration files.
 * @author corbinsmith@gmail.com (Cory Smith)
 */
public interface Configuration {

  public Set<FileInfo> getFilesList();

  /** Creates a server address. */
  // TODO(corysmith): replace this with a URI/URL model.
  public String getServer(String flagValue, int port, HandlerPathPrefix handlerPrefix);

  /** Creates a capture address. */
  public String getCaptureAddress(String server, String captureAddress, HandlerPathPrefix prefix);

  /** A list of plugin from the configuration file. */
  public List<Plugin> getPlugins();
  
  /** The total length of time a test should take to run.*/
  public long getTestSuiteTimeout();
  
  /** Resolves all wildcard paths and places them in a new configuration. 
   * @param flags TODO*/
  public Configuration resolvePaths(PathResolver resolver, Flags flags);

  /** Returns a list of files containing test. */
  public List<FileInfo> getTests();

  /**
   * Returns the basePath for the configuration.
   */
  public BasePaths getBasePaths();

  JsonArray getGatewayConfiguration();

  /**
   * Provides the expected doctype for the test environment.
   */
  public DocType getDocType();
}