/*
 * Copyright 2017 Graz University of Technology EAAF-Core Components has been developed in a
 * cooperation between EGIZ, A-SIT Plus, A-SIT, and Graz University of Technology.
 *
 * Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European
 * Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in
 * compliance with the Licence. You may obtain a copy of the Licence at:
 * https://joinup.ec.europa.eu/news/understanding-eupl-v12
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the Licence
 * is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the Licence for the specific language governing permissions and limitations under
 * the Licence.
 *
 * This product combines work with different licenses. See the "NOTICE" text file for details on the
 * various modules and licenses. The "NOTICE" text file is part of the distribution. Any derivative
 * works that you distribute must include a readable copy of the "NOTICE" text file.
*/

package at.gv.egiz.eaaf.core.api.gui;

import java.net.MalformedURLException;
import java.net.URI;

import javax.annotation.Nonnull;

import at.gv.egiz.eaaf.core.api.IRequest;

public interface IGuiBuilderConfigurationFactory {

  /**
   * Get a DefaultGuiBuilderConfiguration to render an error message.
   *
   * @param authUrl PublicURLPrefix of the IDP but never null
   * @return
   */
  IGuiBuilderConfiguration getDefaultErrorGui(String authUrl);

  /**
   * Get a default {@link IGuiBuilderConfiguration} that implements an iFrame to parent hop.
   * 
   * @param pendingReq Current pending-request object
   * @param endpoint Request end-point
   * @param errorKey Error identifier
   * @return GUIBuilder configuration with parent hop.
   */
  IGuiBuilderConfiguration getDefaultIFrameParentHopGui(@Nonnull IRequest pendingReq, 
      @Nonnull String endpoint, @Nonnull String errorKey);
  
  /**
   * Default Velocity based GUI builder configuration.
   *
   * <p>
   * Manly used for SAML2 POST-Binding
   * </p>
   *
   * @param pendingReq           Current processed pending-request but never null
   * @param viewName             Name of the default template (with suffix) but
   *                             never null
   * @param configRootContextDir Path to configuration root directory
   * @return GUI builder configuration
   * @throws MalformedURLException If configRootContextDir is not a valid URI
   */
  IVelocityGuiBuilderConfiguration getSpSpecificSaml2PostConfiguration(IRequest pendingReq, String viewName,
      URI configRootContextDir) throws MalformedURLException;

}