fixed serializable issues in stork2-commons

6 files changed, 608 insertions, 0 deletions

diff --git a/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/ConfigurationCreator.java b/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/ConfigurationCreator.java
new file mode 100644
index 000000000..c53e18662
--- /dev/null
+++ b/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/ConfigurationCreator.java
@@ -0,0 +1,142 @@
+/* 
+ * 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/european-union-public-licence-eupl-v.1.1
+ * 
+ * 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.
+ */
+
+package eu.stork.peps.configuration;
+
+import eu.stork.peps.exceptions.STORKSAMLEngineException;
+import org.apache.commons.io.IOUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.HashMap;
+import java.util.InvalidPropertiesFormatException;
+import java.util.Map;
+import java.util.Properties;
+
+/**
+ * The Class InstanceCreator.
+ *
+ * @author fjquevedo
+ */
+public final class ConfigurationCreator {
+
+    /**
+     * The Constant LOGGER.
+     */
+    private static final Logger LOGGER = LoggerFactory
+            .getLogger(ConfigurationCreator.class.getName());
+
+    /**
+     * Creates the configuration.
+     *
+     * @param instanceConfs the instance configuration
+     * @return the map< string, map< string, object>>
+     * @throws STORKSAMLEngineException the STORKSAML engine exception
+     */
+    public static Map<String, Map<String, Object>> createConfiguration(
+            final Map<String, InstanceEngine> instanceConfs) throws STORKSAMLEngineException {
+
+        final HashMap<String, Map<String, Object>> instances =
+                new HashMap<String, Map<String, Object>>();
+
+        LOGGER.info("Create configuration.");
+        try {
+            // Only create instances for SAMLEngine configuration.
+            // INSTANCE
+            for (Map.Entry<String, InstanceEngine> entry : instanceConfs
+                    .entrySet()) {
+                final InstanceEngine iEngine = entry.getValue();
+
+                final Map<String, Object> intance = new HashMap<String, Object>();
+
+                // CONFIGURATION
+                for (ConfigurationEngine configuration : iEngine
+                        .getConfiguration()) {
+                    // Properties only for configuration SamlEngine.
+                    if (configuration.getName().equalsIgnoreCase(
+                            "SamlEngineConf")) {
+                        intance.put(configuration.getName(),
+                                getNewInstance(configuration.getParameters()
+                                        .get("fileConfiguration")));
+                    } else {
+                        intance.put(configuration.getName(), configuration
+                                .getParameters());
+                    }
+                }
+                instances.put(entry.getKey(), intance);
+            }
+        } catch (STORKSAMLEngineException ex) {
+            LOGGER.error("Can not create instance from file configuration.");
+            throw new STORKSAMLEngineException(ex);
+        }
+        return instances;
+    }
+
+
+    /**
+     * Gets the new instance.
+     *
+     * @param fileName the file name
+     * @return the properties from the new instance
+     * @throws STORKSAMLEngineException the STORKSAML engine
+     *                                  runtime exception
+     */
+    private static Properties getNewInstance(final String fileName)
+            throws STORKSAMLEngineException {
+        InputStream fileEngineProp = null;
+
+        // fetch base from system properties, give a default if there is nothing configured
+        String base = System.getProperty("eu.stork.samlengine.config.location");
+        if (null != base) {
+            if (!base.endsWith("/")) {
+                base += "/";
+            }
+        } else {
+            base = "/";
+        }
+
+        LOGGER.info("Create file configuration properties to Stork Saml Engine: " + base + fileName);
+
+        try {
+
+            if (null != base)
+                fileEngineProp = new FileInputStream(base + fileName);
+            else
+                fileEngineProp = ConfigurationCreator.class
+                        .getResourceAsStream(base + fileName);
+
+            final Properties configuration = new Properties();
+            configuration.loadFromXML(fileEngineProp);
+            return configuration;
+        } catch (InvalidPropertiesFormatException e) {
+            LOGGER.error("Invalid properties format.");
+            throw new STORKSAMLEngineException(e);
+        } catch (IOException e) {
+            LOGGER.error("Error read file: " + base + fileName);
+            throw new STORKSAMLEngineException(e);
+        } finally {
+            IOUtils.closeQuietly(fileEngineProp);
+        }
+    }
+
+    /**
+     * Instantiates a new instance creator.
+     */
+    private ConfigurationCreator() {
+    }
+}
\ No newline at end of file
diff --git a/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/ConfigurationEngine.java b/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/ConfigurationEngine.java
new file mode 100644
index 000000000..d9e7e467a
--- /dev/null
+++ b/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/ConfigurationEngine.java
@@ -0,0 +1,69 @@
+/* 
+ * 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/european-union-public-licence-eupl-v.1.1
+ * 
+ * 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.
+ */
+
+package eu.stork.peps.configuration;
+
+import java.util.Map;
+
+/**
+ * The Class ConfigurationEngine.
+ * 
+ * @author fjquevedo
+ */
+public class ConfigurationEngine {
+
+    /** The name of the configuration file. */
+    private String name;
+
+    /** The parameters. */
+    private Map<String, String> parameters;
+
+    /**
+     * Gets the name.
+     * 
+     * @return the name
+     */
+    public final String getName() {
+	return name;
+    }
+
+    /**
+     * Gets the parameters.
+     * 
+     * @return the parameters
+     */
+    public final Map<String, String> getParameters() {
+	return parameters;
+    }
+
+    /**
+     * Sets the name.
+     * 
+     * @param newName the new name
+     */
+    public final void setName(final String newName) {
+	this.name = newName;
+    }
+
+    /**
+     * Sets the parameters.
+     * 
+     * @param newParameters the parameters
+     */
+    public final void setParameters(final Map<String, String> newParameters) {
+	this.parameters = newParameters;
+    }
+
+}
diff --git a/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/ConfigurationReader.java b/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/ConfigurationReader.java
new file mode 100644
index 000000000..7968c77ff
--- /dev/null
+++ b/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/ConfigurationReader.java
@@ -0,0 +1,234 @@
+/* 
+ * 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/european-union-public-licence-eupl-v.1.1
+ * 
+ * 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.
+ */
+
+package eu.stork.peps.configuration;
+
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.HashMap;
+import java.util.Map;
+
+import javax.xml.XMLConstants;
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.parsers.ParserConfigurationException;
+
+import org.apache.commons.io.IOUtils;
+import org.apache.commons.lang.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.NodeList;
+import org.xml.sax.SAXException;
+
+import eu.stork.peps.exceptions.SAMLEngineException;
+import eu.stork.peps.exceptions.STORKSAMLEngineRuntimeException;
+
+/**
+ * The Class ConfigurationReader.
+ * 
+ * @author fjquevedo
+ */
+public final class ConfigurationReader {
+
+    /** The Constant SAML_ENGINE_CONFIGURATION_FILE. */
+    private static final String ENGINE_CONF_FILE = "SamlEngine.xml";
+
+    /** The Constant LOGGER. */
+    private static final Logger LOGGER = LoggerFactory
+    .getLogger(ConfigurationReader.class.getName());
+
+    /** The Constant NODE_CONFIGURATION. */
+    private static final String NODE_CONF = "configuration";
+
+    /** The Constant NODE_CONFIGURATION_NAME. */
+    private static final String NODE_CONF_NAME = "name";
+
+    /** The Constant NODE_INSTANCE_NAME. */
+    private static final String NODE_INST_NAME = "name";
+
+    /** The Constant NODE_INSTANCE. */
+    private static final String NODE_INSTANCE = "instance";
+
+    /** The Constant NODE_CONFIGURATION_NAME. */
+    private static final String NODE_PARAM_NAME = "name";
+
+    /** The Constant NODE_CONFIGURATION_NAME. */
+    private static final String NODE_PARAM_VALUE = "value";
+
+    /** The Constant NODE_CONFIGURATION_NAME. */
+    private static final String NODE_PARAMETER = "parameter";
+
+    /**
+     * Generate parameters.
+     * 
+     * @param configurationNode the configuration node
+     * 
+     * @return the map< string, string>
+     */
+    private static Map<String, String> generateParam(
+	    final Element configurationNode) {
+
+	final HashMap<String, String> parameters = new HashMap<String, String>();
+
+	final NodeList parameterNodes = configurationNode
+	.getElementsByTagName(NODE_PARAMETER);
+
+	String parameterName;
+	String parameterValue;
+
+	for (int k = 0; k < parameterNodes.getLength(); ++k) {
+	    // for every parameter find, process.
+	    final Element parameterNode = (Element) parameterNodes.item(k);
+	    parameterName = parameterNode.getAttribute(NODE_PARAM_NAME);
+	    parameterValue = parameterNode.getAttribute(NODE_PARAM_VALUE);
+
+	    // verified the content.
+	    if (StringUtils.isBlank(parameterName)
+		    || StringUtils.isBlank(parameterValue)) {
+		throw new STORKSAMLEngineRuntimeException(
+		"Error reader parameters (name - value).");
+	    } else {
+		parameters.put(parameterName.trim(), parameterValue.trim());
+	    }
+	}
+	return parameters;
+    }
+
+    /**
+     * Read configuration.
+     * 
+     * @return the map< string, instance engine>
+     * 
+     * @throws SAMLEngineException the STORKSAML engine runtime
+     *             exception
+     */
+    public static Map<String, InstanceEngine> readConfiguration()
+    throws SAMLEngineException {
+
+        // fetch base from system properties, give a default if there is nothing configured
+        String base = System.getProperty("eu.stork.samlengine.config.location");
+        if(null != base)
+            if(!base.endsWith("/"))
+                base += "/";
+
+
+	LOGGER.info("Init reader: " + base + ENGINE_CONF_FILE);
+	final Map<String, InstanceEngine> instanceConfs = 
+	    new HashMap<String, InstanceEngine>();
+
+	Document document = null;
+	// Load configuration file
+	final DocumentBuilderFactory factory = DocumentBuilderFactory
+	.newInstance();
+	DocumentBuilder builder;
+
+	InputStream engineConf = null;
+	try {
+
+	    factory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true);
+
+	    builder = factory.newDocumentBuilder();
+	    
+	    if (null != base)
+            engineConf = new FileInputStream(base + ENGINE_CONF_FILE);
+        else
+            engineConf = ConfigurationReader.class.getResourceAsStream("/" + ENGINE_CONF_FILE);
+	    
+	    document = builder.parse(engineConf);
+
+	    // Read instance
+	    final NodeList list = document.getElementsByTagName(NODE_INSTANCE);
+
+	    for (int indexElem = 0; indexElem < list.getLength(); ++indexElem) {
+		final Element element = (Element) list.item(indexElem);
+
+		final InstanceEngine instanceConf = new InstanceEngine();
+
+		// read every configuration.
+		final String instanceName = element
+		.getAttribute(NODE_INST_NAME);
+
+		if (StringUtils.isBlank(instanceName)) {
+		    throw new STORKSAMLEngineRuntimeException(
+		    "Error reader instance name.");
+		}
+		instanceConf.setName(instanceName.trim());
+
+		final NodeList confNodes = element
+		.getElementsByTagName(NODE_CONF);
+
+		for (int indexNode = 0; indexNode < confNodes.getLength(); ++indexNode) {
+
+		    final Element configurationNode = (Element) confNodes
+		    .item(indexNode);
+
+		    final String configurationName = configurationNode
+		    .getAttribute(NODE_CONF_NAME);
+
+		    if (StringUtils.isBlank(configurationName)) {
+			throw new STORKSAMLEngineRuntimeException(
+				"Error reader configuration name.");
+		    }
+
+		    final ConfigurationEngine confSamlEngine = 
+			new ConfigurationEngine();
+
+		    // Set configuration name.
+		    confSamlEngine.setName(configurationName.trim());
+
+		    // Read every parameter for this configuration.
+		    final Map<String, String> parameters = 
+			generateParam(configurationNode);
+
+		    // Set parameters
+		    confSamlEngine.setParameters(parameters);
+
+		    // Add parameters to the configuration.
+		    instanceConf.getConfiguration().add(confSamlEngine);
+		}
+
+		// Add to the list of configurations.
+		instanceConfs.put(element.getAttribute(NODE_INST_NAME),
+			instanceConf);
+	    }
+
+	} catch (SAXException e) {
+	    LOGGER.error("Error: init library parser.");
+	    throw new SAMLEngineException(e);
+	} catch (ParserConfigurationException e) {
+	    LOGGER.error("Error: parser configuration file xml.");
+	    throw new SAMLEngineException(e);
+	} catch (IOException e) {
+	    LOGGER.error("Error: read configuration file.");
+	    throw new SAMLEngineException(e);
+	} finally {
+	    IOUtils.closeQuietly(engineConf);
+	}
+
+	return instanceConfs;
+    }
+
+    /**
+     * Instantiates a new configuration reader.
+     */
+    private ConfigurationReader() {
+
+    }
+
+}
diff --git a/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/ConfigurationSingleton.java b/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/ConfigurationSingleton.java
new file mode 100644
index 000000000..d00607853
--- /dev/null
+++ b/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/ConfigurationSingleton.java
@@ -0,0 +1,74 @@
+/* 
+ * 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/european-union-public-licence-eupl-v.1.1
+ * 
+ * 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.
+ */
+
+package eu.stork.peps.configuration;
+
+import java.util.Map;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import eu.stork.peps.exceptions.SAMLEngineException;
+import eu.stork.peps.exceptions.STORKSAMLEngineException;
+import eu.stork.peps.exceptions.STORKSAMLEngineRuntimeException;
+
+/**
+ * The Class InstanceCreator.
+ * 
+ * @author fjquevedo
+ */
+public final class ConfigurationSingleton {
+
+    /** The instance of every engine SAML. */
+    private static Map<String, InstanceEngine> instanceConfigs;
+
+    /** The instances of SAML engine. */
+    private static Map<String, Map<String, Object>> instances;
+
+    /** The Constant LOGGER. */
+    private static final Logger LOGGER = LoggerFactory
+	    .getLogger(ConfigurationSingleton.class.getName());
+
+    static {
+	LOGGER.debug("Read all file configurations. (instances of SAMLEngine)");
+	try {
+	    instanceConfigs = ConfigurationReader.readConfiguration();
+	} catch (SAMLEngineException e) {
+	    LOGGER.error("Error read configuration file.");
+	    throw new STORKSAMLEngineRuntimeException(e);
+	}
+    }
+
+    /**
+     * Gets the new instance.
+     * 
+     * @param fileName the file name
+     * 
+     * @return the properties from the new instance
+     * 
+     * @throws STORKSAMLEngineException the STORKSAML engine runtime exception
+     */
+    private static Map<String, Map<String, Object>> getInstance(
+	    final String fileName) throws STORKSAMLEngineException {
+	return ConfigurationCreator.createConfiguration(instanceConfigs);
+    }
+
+    /**
+     * Instantiates a new instance creator.
+     */
+    private ConfigurationSingleton() {
+    }
+
+}
\ No newline at end of file
diff --git a/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/InstanceEngine.java b/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/InstanceEngine.java
new file mode 100644
index 000000000..4d9bba8e7
--- /dev/null
+++ b/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/InstanceEngine.java
@@ -0,0 +1,70 @@
+/* 
+ * 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/european-union-public-licence-eupl-v.1.1
+ * 
+ * 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.
+ */
+
+package eu.stork.peps.configuration;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * The Class InstanceConfiguration.
+ * 
+ * @author fjquevedo
+ */
+public class InstanceEngine {
+
+    /** The configuration. */
+    private List<ConfigurationEngine> configuration = new ArrayList<ConfigurationEngine>();
+
+    /** The name. */
+    private String name;
+
+    /**
+     * Gets the parameters.
+     * 
+     * @return the parameters
+     */
+    public final List<ConfigurationEngine> getConfiguration() {
+	return this.configuration;
+    }
+
+    /**
+     * Gets the name.
+     * 
+     * @return the name
+     */
+    public final String getName() {
+	return name;
+    }
+
+    /**
+     * Sets the parameters.
+     * 
+     * @param newConfiguration the new parameters
+     */
+    public final void setConfiguration(final List<ConfigurationEngine> newConfiguration) {
+	this.configuration = newConfiguration;
+    }
+
+    /**
+     * Sets the name.
+     * 
+     * @param newName the new name
+     */
+    public final void setName(final String newName) {
+	this.name = newName;
+    }
+
+}
diff --git a/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/package-info.java b/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/package-info.java
new file mode 100644
index 000000000..344368e03
--- /dev/null
+++ b/id/server/stork2-saml-engine/src/main/java/eu/stork/peps/configuration/package-info.java
@@ -0,0 +1,19 @@
+/*
+ * 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/european-union-public-licence-eupl-v.1.1
+ *
+ * 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.
+ */
+
+/**
+ * Provides the classes necessary to create a SAML message instance.
+ */
+package eu.stork.peps.configuration;