some more pvp2 updates

4 files changed, 10 insertions, 268 deletions

diff --git a/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/AbstractGUIFormBuilderConfiguration.java b/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/AbstractGUIFormBuilderConfiguration.java
deleted file mode 100644
index 999552891..000000000
--- a/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/AbstractGUIFormBuilderConfiguration.java
+++ /dev/null
@@ -1,111 +0,0 @@
-/*
- * Copyright 2014 Federal Chancellery Austria
- * MOA-ID has been developed in a cooperation between BRZ, the Federal
- * Chancellery Austria - ICT staff unit, and Graz University of Technology.
- *
- * Licensed under the EUPL, Version 1.1 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:
- * http://www.osor.eu/eupl/
- *
- * 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.egovernment.moa.id.auth.frontend.builder;
-
-import java.util.HashMap;
-import java.util.Map;
-
-import at.gv.egiz.eaaf.core.api.gui.IGUIBuilderConfiguration;
-import at.gv.egovernment.moa.util.MiscUtil;
-
-/**
- * @author tlenz
- *
- */
-public abstract class AbstractGUIFormBuilderConfiguration implements IGUIBuilderConfiguration {
-
-	public static final String PARAM_AUTHCONTEXT = "contextPath";
-	public static final String PARAM_FORMSUBMITENDPOINT = "submitEndpoint";
-	
-	public static final String PARAM_PENDINGREQUESTID = "pendingReqID";
-	
-	private String authURL = null;
-	private String viewName = null;
-	private String formSubmitEndpoint = null;
-	
-	/**
-	 * @param authURL IDP PublicURL-Prefix which should be used, but never null
-	 * @param viewName Name of the template (with suffix) but never null
-	 * @param formSubmitEndpoint EndPoint on which the form should be submitted, 
-	 * or null if the form must not submitted
-	 * 
-	 */
-	public AbstractGUIFormBuilderConfiguration(String authURL, String viewName, String formSubmitEndpoint) {
-		if (viewName.startsWith("/"))
-			this.viewName = viewName.substring(1);
-		else
-			this.viewName = viewName;
-		
-		if (authURL.endsWith("/"))
-			this.authURL = authURL.substring(0, authURL.length() - 1);
-		else
-			this.authURL = authURL;
-		
-		if (MiscUtil.isNotEmpty(formSubmitEndpoint)) {
-			if (formSubmitEndpoint.startsWith("/"))
-				this.formSubmitEndpoint = formSubmitEndpoint;
-			else		
-				this.formSubmitEndpoint = "/" + formSubmitEndpoint;
-		}
-	}
-	
-	
-	/**
-	 * Define the parameters, which should be evaluated in the template <br>
-	 * <b>IMPORTANT:</b> external HTML escapetion is required, because it is NOT done internally during the building process
-	 * 
-	 * @return Map of parameters, which should be added to template
-	 */
-	abstract protected Map<String, Object> getSpecificViewParameters();
-	
-	
-	/* (non-Javadoc)
-	 * @see at.gv.egovernment.moa.id.auth.frontend.builder.IGUIBuilderConfiguration#getViewName()
-	 */
-	@Override
-	public final String getViewName() {
-		return this.viewName;
-		
-	}
-	
-
-	/* (non-Javadoc)
-	 * @see at.gv.egovernment.moa.id.auth.frontend.builder.IGUIBuilderConfiguration#getViewParameters()
-	 */
-	@Override
-	public final Map<String, Object> getViewParameters() {
-		//get parameters from detail implementation
-		Map<String, Object> specParams = getSpecificViewParameters();
-		if (specParams == null)
-			specParams = new HashMap<String, Object>();
-		
-		//add generic parameters
-		specParams.put(PARAM_AUTHCONTEXT, this.authURL);		
-		if (this.formSubmitEndpoint != null)
-			specParams.put(PARAM_FORMSUBMITENDPOINT, this.formSubmitEndpoint);
-		
-		return specParams;
-		
-	}
-
-}
diff --git a/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/AbstractServiceProviderSpecificGUIFormBuilderConfiguration.java b/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/AbstractServiceProviderSpecificGUIFormBuilderConfiguration.java
index e1f995e82..2fcec92c5 100644
--- a/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/AbstractServiceProviderSpecificGUIFormBuilderConfiguration.java
+++ b/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/AbstractServiceProviderSpecificGUIFormBuilderConfiguration.java
@@ -30,6 +30,7 @@ import java.util.Map;
 import org.apache.commons.lang.StringEscapeUtils;
 
 import at.gv.egiz.eaaf.core.api.IRequest;
+import at.gv.egiz.eaaf.core.impl.gui.AbstractGUIFormBuilderConfiguration;
 import at.gv.egovernment.moa.id.auth.frontend.utils.FormBuildUtils;
 import at.gv.egovernment.moa.id.commons.MOAIDAuthConstants;
 import at.gv.egovernment.moa.id.commons.api.IOAAuthParameters;
diff --git a/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/DefaultGUIFormBuilderConfiguration.java b/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/DefaultGUIFormBuilderConfiguration.java
index 5283089ed..e59c19219 100644
--- a/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/DefaultGUIFormBuilderConfiguration.java
+++ b/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/DefaultGUIFormBuilderConfiguration.java
@@ -30,6 +30,7 @@ import org.apache.commons.lang.StringEscapeUtils;
 
 import at.gv.egiz.eaaf.core.api.IRequest;
 import at.gv.egiz.eaaf.core.api.gui.ModifyableGuiBuilderConfiguration;
+import at.gv.egiz.eaaf.core.impl.gui.AbstractGUIFormBuilderConfiguration;
 	
 /**
  * This class builds MOA-ID GUI forms from default resource paths
diff --git a/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/GUIFormBuilderImpl.java b/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/GUIFormBuilderImpl.java
index 1bacc93c7..43d499589 100644
--- a/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/GUIFormBuilderImpl.java
+++ b/id/server/moa-id-frontend-resources/src/main/java/at/gv/egovernment/moa/id/auth/frontend/builder/GUIFormBuilderImpl.java
@@ -22,154 +22,40 @@
  */
 package at.gv.egovernment.moa.id.auth.frontend.builder;
 
-import java.io.BufferedReader;
 import java.io.File;
 import java.io.FileInputStream;
-import java.io.IOException;
 import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.StringWriter;
 import java.net.URI;
-import java.util.Iterator;
-import java.util.Map;
-import java.util.Map.Entry;
 
-import javax.servlet.http.HttpServletResponse;
-
-import org.apache.velocity.VelocityContext;
-import org.apache.velocity.app.VelocityEngine;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
 import at.gv.egiz.eaaf.core.api.gui.IGUIBuilderConfiguration;
-import at.gv.egiz.eaaf.core.api.gui.IGUIFormBuilder;
 import at.gv.egiz.eaaf.core.exceptions.GUIBuildException;
-import at.gv.egiz.eaaf.core.impl.gui.velocity.VelocityProvider;
-import at.gv.egovernment.moa.id.commons.MOAIDConstants;
+import at.gv.egiz.eaaf.core.impl.gui.AbstractGUIFormBuilderImpl;
 import at.gv.egovernment.moa.id.commons.api.AuthConfiguration;
 import at.gv.egovernment.moa.logging.Logger;
-import at.gv.egovernment.moa.util.MiscUtil;
 
 /**
  * @author tlenz 
  *
  */
 @Service("guiFormBuilder")
-public class GUIFormBuilderImpl implements IGUIFormBuilder {
+public class GUIFormBuilderImpl extends AbstractGUIFormBuilderImpl {
 	
-	private static final String DEFAULT_CONTENT_TYPE = MOAIDConstants.DEFAULT_CONTENT_TYPE_HTML_UTF8;
+
 	private static final String CONFIG_HTMLTEMPLATES_DIR = "htmlTemplates/";
 	private static final String CLASSPATH_HTMLTEMPLATES_DIR = "templates/";
 			
 	@Autowired private AuthConfiguration authConfig;
-	private VelocityEngine engine;
-		
+
 	public GUIFormBuilderImpl() throws GUIBuildException {
-		try {
-			engine = VelocityProvider.getClassPathVelocityEngine();
-			
-		} catch (Exception e) {
-			Logger.fatal("Initialization of Velocity-Engine to render GUI components FAILED.", e);
-			throw new GUIBuildException("Initialization of Velocity-Engine to render GUI components FAILED.", e);
-			
-		}
+		super();
 		
 	}
-		
-	public void build(HttpServletResponse httpResp, IGUIBuilderConfiguration config, String loggerName) throws GUIBuildException {
-		build(httpResp, config, getInternalContentType(config), loggerName);
-		
-	}
-		
-	@Override
-	public void build(HttpServletResponse httpResp, IGUIBuilderConfiguration config, 
-			String contentType, String loggerName) throws GUIBuildException {
-		
-		InputStream is = null;
-		try {
-			String viewName = config.getViewName();			
-			is = getTemplateInputStream(config);
-			
-			//build Velocity Context from input paramters
-			VelocityContext context = buildContextFromViewParams(config.getViewParameters());
-
-			//evaluate template
-			StringWriter writer = new StringWriter();
-			engine.evaluate(context, writer, loggerName, new BufferedReader(new InputStreamReader(is)));
-							
-			//write template to response
-			final byte[] content = writer.toString().getBytes("UTF-8");
-			httpResp.setStatus(HttpServletResponse.SC_OK);
-			httpResp.setContentLength(content.length);
-			httpResp.setContentType(contentType);						
-			httpResp.getOutputStream().write(content);
-			
-			if (Logger.isTraceEnabled()) {
-				Logger.trace("Write Content for viewName:" + viewName 
-						+ ". Contentsize:" + String.valueOf(content.length)
-						+ " BufferSize:" + httpResp.getBufferSize()
-						+ " ContentType:" + contentType);
-				for (String el : httpResp.getHeaderNames())
-					Logger.trace(" * Headername:" + el + " Value:" + httpResp.getHeader(el));
 				
-			}
-			
-		} catch (IOException e) {
-			Logger.error("GUI form-builder has an internal error.", e);
-			throw new GUIBuildException("GUI form-builder has an internal error.", e);
-						
-		} finally {
-			if (is != null)
-				try {
-					is.close();
-					
-				} catch (IOException e) {
-					Logger.error("Can NOT close GUI-Template InputStream.", e);
-					
-				}
-		}
-		
-	}
-
-	/**
-	 * Generate a new {@link VelocityContext} and populate it with MOA-ID GUI parameters
-	 * 
-	 * @param config
-	 * @return
-	 */
-	public VelocityContext generateVelocityContextFromConfiguration(IGUIBuilderConfiguration config) {
-		return buildContextFromViewParams(config.getViewParameters());
-		
-	}
-	
-	/**
-	 * Load the template from different resources
-	 * 
-	 * @param config
-	 * @return An {@link InputStream} but never null. The {@link InputStream} had to be closed be the invoking method
-	 * @throws GUIBuildException
-	 */
-	public InputStream getTemplateInputStream(IGUIBuilderConfiguration config) throws GUIBuildException {			
-		InputStream is = getInternalTemplate(config);
-		if (is == null) {
-			Logger.warn("No GUI with viewName:" + config.getViewName() + " FOUND.");
-			throw new GUIBuildException("No GUI with viewName:" + config.getViewName() + " FOUND.");
-		
-		}		
-		return is;
-		
-	}
-	
-	private String getInternalContentType(IGUIBuilderConfiguration config) {
-		if (MiscUtil.isEmpty(config.getDefaultContentType()))
-			return DEFAULT_CONTENT_TYPE;
-		
-		else
-			return config.getDefaultContentType();
-		
-	}
-	
-	private InputStream getInternalTemplate(IGUIBuilderConfiguration config) throws GUIBuildException {
+	@Override
+	protected InputStream getInternalTemplate(IGUIBuilderConfiguration config) throws GUIBuildException {
 		String viewName = config.getViewName();
 		
 		//load specific template
@@ -193,7 +79,7 @@ public class GUIFormBuilderImpl implements IGUIFormBuilder {
 					Logger.debug("GUI template:" + viewName + " is not found in configuration directory. "
 							+ " Load template from project library ... ");					
 					try  {
-						pathLocation = getInternalClasspathTemplateDir(config) + viewName;
+						pathLocation = super.getInternalClasspathTemplateDir(config, CLASSPATH_HTMLTEMPLATES_DIR) + viewName;
 						is = Thread.currentThread()
 								.getContextClassLoader()
 								.getResourceAsStream(pathLocation);				
@@ -219,39 +105,4 @@ public class GUIFormBuilderImpl implements IGUIFormBuilder {
 		
 	}
 	
-	
-	/**
-	 * @return
-	 */
-	private String getInternalClasspathTemplateDir(IGUIBuilderConfiguration config) {
-		String dir = config.getClasspathTemplateDir();
-		if (dir != null) {
-			if (!dir.endsWith("/"))
-				dir += "/";
-			
-			return dir;			
-			
-		} else
-			return CLASSPATH_HTMLTEMPLATES_DIR;
-	}
-	
-	/**
-	 * @param viewParams
-	 * @return
-	 */
-	private VelocityContext buildContextFromViewParams(Map<String, Object> viewParams) {
-		VelocityContext context = new VelocityContext();
-				
-		if (viewParams != null) {
-			Iterator<Entry<String, Object>> interator = viewParams.entrySet().iterator();
-			while (interator.hasNext()) {
-				Entry<String, Object> el = interator.next();
-				context.put(el.getKey(), el.getValue());
-			}
-			
-		} 
-		
-		return context;
-	}
-	
 }