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

import java.util.Map;

import at.gv.egovernment.moa.id.config.proxy.OAConfiguration;
import at.gv.egovernment.moa.id.data.AuthenticationData;

/**
 * Determines authentication parameters and headers to be added to a {@link java.net.URLConnection}
 * to the remote online application. 
 * Utilizes {@link OAConfiguration} and {@link AuthenticationData}.
 * 
 * @author Paul Ivancsics
 * @version $Id$
 */
public interface LoginParameterResolver {

	/** Constants used in <code>MOAIDConfiguration-1.2.xsd</code>, type <code>MOAAuthDataType</code>,
	 *  naming predicates used by the <code>LoginParameterResolver</code>. */
	public static final String MOAGivenName = "MOAGivenName";
	/** Constant used in <code>MOAIDConfiguration-1.2.xsd</code>, type <code>MOAAuthDataType</code> */
	public static final String MOAFamilyName = "MOAFamilyName";
	/** Constant used in <code>MOAIDConfiguration-1.2.xsd</code>, type <code>MOAAuthDataType</code> */
	public static final String MOADateOfBirth = "MOADateOfBirth";
	/** Constant used in <code>MOAIDConfiguration-1.2.xsd</code>, type <code>MOAAuthDataType</code> */
	public static final String MOABPK = "MOABPK";
	/** Constant used in <code>MOAIDConfiguration-1.2.xsd</code>, type <code>MOAAuthDataType</code> */
	public static final String MOAPublicAuthority = "MOAPublicAuthority";
	/** Constant used in <code>MOAIDConfiguration-1.2.xsd</code>, type <code>MOAAuthDataType</code> */
	public static final String MOABKZ = "MOABKZ";
	/** Constant used in <code>MOAIDConfiguration-1.2.xsd</code>, type <code>MOAAuthDataType</code> */
	public static final String MOAQualifiedCertificate =
		"MOAQualifiedCertificate";
	/** Constant used in <code>MOAIDConfiguration-1.2.xsd</code>, type <code>MOAAuthDataType</code> */
	public static final String MOAStammzahl = "MOAStammzahl";
	/** Constant used in <code>MOAIDConfiguration-1.2.xsd</code>, type <code>MOAAuthDataType</code> */
	public static final String MOAIdentificationValueType = "MOAIdentificationValueType";
	/** Constant used in <code>MOAIDConfiguration-1.2.xsd</code>, type <code>MOAAuthDataType</code> */
	public static final String MOAIPAddress = "MOAIPAddress";

	/**
	 * Returns authentication headers to be added to a URLConnection.
	 * 
	 * @param oaConf configuration data
	 * @param authData authentication data
	* @param clientIPAddress client IP address
	 * @return A map, the keys being header names and values being corresponding header values.
	 * <br>In case of authentication type <code>"basic-auth"</code>, header fields
	 * <code>username</code> and <code>password</code>.
	 * <br>In case of authentication type <code>"header-auth"</code>, header fields
	 * derived from parameter mapping and authentication data provided.
	 * <br>Otherwise, an empty map.
	 */
	public Map getAuthenticationHeaders(
		OAConfiguration oaConf,
		AuthenticationData authData,
		String clientIPAddress)	throws LoginParameterResolverException, NotAllowedException;
  
	/**
	 * Returns request parameters to be added to a URLConnection.
	 * 
	 * @param oaConf configuration data
	 * @param authData authentication data
	* @param clientIPAddress client IP address
	 * @return A map, the keys being parameter names and values being corresponding parameter values.
	 * <br>In case of authentication type <code>"param-auth"</code>, parameters
	 * derived from parameter mapping and authentication data provided.
	 * <br>Otherwise, an empty map.
	 */
	public Map getAuthenticationParameters(
		OAConfiguration oaConf,
		AuthenticationData authData,
		String clientIPAddress)	throws LoginParameterResolverException;

	public void configure(String configuration) throws LoginParameterResolverException, NotAllowedException;

}