/*******************************************************************************
 *******************************************************************************/
package at.gv.egiz.eaaf.core.api.idp.auth;

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

import at.gv.egiz.eaaf.core.api.IRequest;
import at.gv.egiz.eaaf.core.api.idp.slo.SLOInformationInterface;
import at.gv.egiz.eaaf.core.exceptions.EAAFSSOException;

public interface ISSOManager {
	
	//TODO
	public static int EVENT_SSO_SESSION_INVALID = -1;
	public static int EVENT_SSO_SESSION_VALID = -1;
	
	
	public static final String PROCESS_ENGINE_SSO_CONSENTS_EVALUATION = "ssoconsentsevaluation";
	public static final String AUTH_DATA_SSO_SESSIONID	= "eaaf_authdata_sso_sessionId";
	
	
	/**
	 * Check if there is an active and valid SSO session for the current pending request.
	 * <br>
	 * If there is an active SSO session, the pending request will be populated with eID information from SSO session 
	 * 
	 * @param pendingReq Current incoming pending request
	 * @param httpReq http Servlet request
	 * @param httpResp http Servlet response
	 * @return true if there is a valid SSO session, otherwise false
	 * @throws EAAFSSOException
	 */
	public boolean checkAndValidateSSOSession(IRequest pendingReq, HttpServletRequest httpReq, HttpServletResponse httpResp) throws EAAFSSOException;
	
	/**
	 * Populate service provider specific SSO settings
	 * 
	 * Check if Single Sign-On is allowed for the current pending request and the requested service provider 
	 * 
	 * @param pendingReq Current incoming pending request
	 * @param httpReq http Servlet request
	 * @return true if SSO is allowed for this service provider, otherwise false
	 */
	public void isSSOAllowedForSP(IRequest pendingReq, HttpServletRequest httpReq);
	
	
	/**
	 * Populate the current pending request with eID information from an existing SSO session 
	 * 
	 * @param pendingReq pending request that should be populated by SSO session
	 * @throws EAAFSSOException if pending request contains no SSO information or population failed
	 */
	public void populatePendingRequestWithSSOInformation(IRequest pendingReq) throws EAAFSSOException;
	
	
	/**
	 * Destroy an active SSO session on IDP site only
	 * 
	 * @param httpReq http servlet request
	 * @param httpResp http servlet response
	 * @param pendingReq 
	 * @return true if a SSO session was closed successfully, otherwise false
	 * @throws EAAFSSOException in case of an internal processing error
	 */
	public boolean destroySSOSessionOnIDPOnly(HttpServletRequest httpReq, HttpServletResponse httpResp, IRequest pendingReq) throws EAAFSSOException;
	
	
	
	// ************************* old ***************************************************	
	String createNewSSOSessionCookie(HttpServletRequest req, HttpServletResponse resp, IRequest pendingReq)  throws EAAFSSOException;

	
	void createNewSSOSession(IRequest pendingReq, String newSSOSessionId, SLOInformationInterface sloInformation) throws EAAFSSOException;
//	{
//		internalDBSSOSession = authenticatedSessionStorage.createInternalSSOSession(pendingReq);				
//		authenticatedSessionStorage.addSSOInformation(internalDBSSOSession.getSessionID(), 
//				newSSOSessionId, sloInformation, pendingReq);	
//
//	}


	void updateSSOSession(IRequest pendingReq, String newSSOSessionId, SLOInformationInterface sloInformation)  throws EAAFSSOException;
//	{
//		authenticatedSessionStorage.addSSOInformation(moaSession.getSessionID(), 
//				newSSOSessionId, sloInformation, pendingReq);
//	}




}