package at.gv.egovernment.moa.id.protocols.stork2;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import at.gv.egovernment.moa.id.auth.data.AuthenticationSession;
import at.gv.egovernment.moa.id.auth.exception.MOAIDException;
import at.gv.egovernment.moa.id.config.auth.OAAuthParameter;
import at.gv.egovernment.moa.id.data.IAuthData;

import eu.stork.peps.auth.commons.IPersonalAttributeList;
import eu.stork.peps.auth.commons.PersonalAttribute;

import java.util.List;

/**
 * An {@link AttributeProvider} can fetch a set of stork attributes. It might complete the query within one method call,
 * but might also need to redirect to another webservice to accomplish its task.
 */
public interface AttributeProvider {
	
	/**
	 * Acquire the specified attribute. Returns {@code null} when attribute retrieval is in progress, but requires for
	 * for redirecting the user to an external service. Use {@link AttributeProvider#parse(HttpServletRequest)} to parse
	 * the response.
	 *
	 * @param attributes the list of attributes to be acquired
	 * @param spCountyCode the sp county code
	 * @param authData the moasession
	 * @return the personal attribute
	 * @throws UnsupportedAttributeException the unsupported attribute exception
	 * @throws ExternalAttributeRequestRequiredException an attribute request to an external service has to be done
	 * @throws MOAIDException the mOAID exception
	 */
	public IPersonalAttributeList acquire(PersonalAttribute attributes, String spCountyCode, IAuthData authData) throws UnsupportedAttributeException, ExternalAttributeRequestRequiredException, MOAIDException;

    public IPersonalAttributeList acquire(List<PersonalAttribute> attributes, String spCountyCode, IAuthData authData) throws UnsupportedAttributeException, ExternalAttributeRequestRequiredException, MOAIDException;

    /**
	 * Perform redirect.
	 *
	 * @param url the return URL ending with ?artifactId=...
	 * @param req the request we got from the S-PEPS and for which we have to ask our APs
	 * @param resp the response to the preceding request
	 * @param oaParam the oa param
	 * @throws MOAIDException the mOAID exception
	 */
	public void performRedirect(String url, HttpServletRequest req, HttpServletResponse resp, OAAuthParameter oaParam) throws MOAIDException;
	
	/**
	 * Parses the response we got from the external attribute provider.
	 *
	 * @param httpReq the http req
	 * @return a list of attributes
	 * @throws UnsupportedAttributeException if the provider cannot find anything familiar in the provided httpReq
	 * @throws MOAIDException if something went wrong
	 */
	public IPersonalAttributeList parse(HttpServletRequest httpReq) throws UnsupportedAttributeException, MOAIDException;

    /**
     * Returns the list of supported attributes
     *
     * @return a list of attributes
     * @throws MOAIDException if something went wrong
     */
    public List<String> getSupportedAttributeNames() throws MOAIDException;



}