package at.gv.egovernment.moa.id.config.proxy;

import java.util.HashMap;
import java.util.Map;

/**
 * Holds configuration data concerning an online application for use by the MOA-ID Proxy component.
 * These include the login type (stateful or stateless), the HTTP authentication type,
 * and information needed to add authentication parameters or headers for a URL connection 
 * to the remote online application.
 * @see <code>MOAIDConfiguration-1.1.xsd</code>, element <code>Configuration</code>
 * 
 * @author Stefan Knirsch
 * @version $Id$
 */
public class OAConfiguration {

  /** Constant for an login method */  
  public static final String LOGINTYPE_STATEFUL = "stateful";
  /** Constant for an login method */
  public static final String LOGINTYPE_STATELESS = "stateless";
  
  /** Constant for an auth method */
  public static final String BASIC_AUTH = "basic";
  /** Constant for an auth method */
  public static final String HEADER_AUTH = "header";
  /** Constant for an auth method */
  public static final String PARAM_AUTH = "param";
  
  /** login type: stateful or stateless */
  String loginType;
  /** authentication type: basic, header, or param */
  String authType;
  /** 
   * mapping of parameter names to AuthenticationData field names
   * in case of authentication type <code>"header-auth"</code>
   */
  Map paramAuthMapping;
  /** 
   * mapping of parameter names to AuthenticationData field names
   * in case of authentication type <code>"param-auth"</code>
   */
  Map headerAuthMapping;
  /** mapping for user ID to be used in case of authentication type <code>"basic-auth"</code> */
  String basicAuthUserIDMapping;
  /** mapping for password to be used in case of authentication type <code>"basic-auth"</code> */
  String basicAuthPasswordMapping;
  
  /**
   * Returns the basicAuthPasswordMapping.
   * @return String
   */
  public String getBasicAuthPasswordMapping() {
    return basicAuthPasswordMapping;
  }
  
  /**
   * Returns the basicAuthUserIDMapping.
   * @return String
   */
  public String getBasicAuthUserIDMapping() {
    return basicAuthUserIDMapping;
  }
  
  /**
   * Returns the headerAuthMapping.
   * @return HashMap
   */
  public Map getHeaderAuthMapping() {
    return headerAuthMapping;
  }
  
  /**
   * Returns the loginType.
   * @return String
   */
  public String getLoginType() {
    return loginType;
  }
  
  /**
   * Returns the paramAuthMapping.
   * @return HashMap
   */
  public Map getParamAuthMapping() {
    return paramAuthMapping;
  }
  
  /**
   * Sets the basicAuthPasswordMapping.
   * @param basicAuthPasswordMapping The basicAuthPasswordMapping to set
   */
  public void setBasicAuthPasswordMapping(String basicAuthPassword) {
    this.basicAuthPasswordMapping = basicAuthPassword;
  }
  
  /**
   * Sets the basicAuthUserIDMapping.
   * @param basicAuthUserIDMapping The basicAuthUserIDMapping to set
   */
  public void setBasicAuthUserIDMapping(String basicAuthUserID) {
    this.basicAuthUserIDMapping = basicAuthUserID;
  }
  
  /**
   * Sets the headerAuthMapping.
   * @param headerAuthMapping The headerAuthMapping to set
   */
  public void setHeaderAuthMapping(HashMap headerAuth) {
    this.headerAuthMapping = headerAuth;
  }
  
  /**
   * Sets the loginType.
   * @param loginType The loginType to set
   */
  public void setLoginType(String loginType) {
    this.loginType = loginType;
  }
  
  /**
   * Sets the paramAuthMapping.
   * @param paramAuthMapping The paramAuthMapping to set
   */
  public void setParamAuthMapping(HashMap paramAuth) {
    this.paramAuthMapping = paramAuth;
  }
  
  /**
   * Returns the authType.
   * @return String
   */
  public String getAuthType() {
    return authType;
  }
  
  /**
   * Sets the authType.
   * @param authType The authType to set
   */
  public void setAuthType(String authLoginType) {
    this.authType = authLoginType;
  }

}