[exo-jcr-commits] exo-jcr SVN: r1580 - in jcr/trunk/exo.jcr.component.core/src: test/java/org/exoplatform/services/jcr and 1 other directories.
do-not-reply at jboss.org
do-not-reply at jboss.org
Tue Jan 26 10:01:36 EST 2010
Author: nzamosenchuk
Date: 2010-01-26 10:01:35 -0500 (Tue, 26 Jan 2010)
New Revision: 1580
Added:
jcr/trunk/exo.jcr.component.core/src/main/java/org/exoplatform/services/jcr/config/TemplateConfigurationHelper.java
jcr/trunk/exo.jcr.component.core/src/test/java/org/exoplatform/services/jcr/config/
jcr/trunk/exo.jcr.component.core/src/test/java/org/exoplatform/services/jcr/config/TestTemplateConfigurationHelper.java
Log:
EXOJCR-439: Helper for building configuration files from templates and it's test added.
Added: jcr/trunk/exo.jcr.component.core/src/main/java/org/exoplatform/services/jcr/config/TemplateConfigurationHelper.java
===================================================================
--- jcr/trunk/exo.jcr.component.core/src/main/java/org/exoplatform/services/jcr/config/TemplateConfigurationHelper.java (rev 0)
+++ jcr/trunk/exo.jcr.component.core/src/main/java/org/exoplatform/services/jcr/config/TemplateConfigurationHelper.java 2010-01-26 15:01:35 UTC (rev 1580)
@@ -0,0 +1,179 @@
+/*
+ * Copyright (C) 2010 eXo Platform SAS.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package org.exoplatform.services.jcr.config;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.regex.Pattern;
+
+/**
+ * Builds configuration from template using map of template-variables <--> value.
+ * Class provides extra functionality for filtering parameters by pattern, excluding
+ * unnecessary parameters.
+ *
+ * @author <a href="mailto:nikolazius at gmail.com">Nikolay Zamosenchuk</a>
+ * @version $Id: TemplateConfigurationHelper.java 34360 2009-07-22 23:58:59Z nzamosenchuk $
+ *
+ */
+public class TemplateConfigurationHelper
+{
+ // list with include-patterns
+ private List<Pattern> includes = new ArrayList<Pattern>();
+
+ // list with exclude-patterns
+ private List<Pattern> excludes = new ArrayList<Pattern>();
+
+ /**
+ * Creates instance of template configuration helper with given lists of filtering
+ * patterns. Parameter will be included only if it matches any include-pattern and
+ * doesn't match any exclude-pattern. I.e. You can include "extended-*" and exclude
+ * "extended-type". Please refer to Java regexp documentation. Filtering for this
+ * example, should be defined as following:
+ * include: "^extended-.*"
+ * exclude: "^extended-type"
+ *
+ * @param includes Array with string representation of include reg-exp patterns
+ * @param excludes Array with string representation of exclude reg-exp patterns
+ */
+ public TemplateConfigurationHelper(String[] includes, String[] excludes)
+ {
+ super();
+ // compile include patterns
+ for (String regex : includes)
+ {
+ this.includes.add(Pattern.compile(regex));
+ }
+ // compile exclude patterns
+ for (String regex : excludes)
+ {
+ this.excludes.add(Pattern.compile(regex));
+ }
+ }
+
+ /**
+ * Creates instance of TemplateConfigurationHelper pre-configured for JBossCache parameters,<br>
+ * including: "jbosscache-*" and "jgroups-configuration", and excluding "jbosscache-configuration"
+ *
+ * @return
+ */
+ public static TemplateConfigurationHelper createJBossCacheHelper()
+ {
+ return new TemplateConfigurationHelper(new String[]{"^jbosscache-.*", "^jgroups-configuration"},
+ new String[]{"^jbosscache-configuration"});
+ }
+
+ /**
+ * Reads configuration file from a stream and replaces all the occurrences of template-variables
+ * (like : "${parameter.name}") with values provided in the map.
+ *
+ * @param inputStream
+ * @param parameters
+ * @return
+ * @throws IOException
+ */
+ public InputStream fillTemplate(InputStream inputStream, Map<String, String> parameters) throws IOException
+ {
+ // parameters filtering
+ Map<String, String> preparedParams = prepareParameters(parameters);
+ // read stream
+ String configuration = readStream(inputStream);
+ for (Entry<String, String> entry : preparedParams.entrySet())
+ {
+ configuration = configuration.replace(entry.getKey(), entry.getValue());
+ }
+ // create new stream
+ InputStream configurationStream = new ByteArrayInputStream(configuration.getBytes());
+ return configurationStream;
+ }
+
+ /**
+ * Checks if String mathes to any pattern from the list
+ *
+ * @param patterns
+ * @param parameter
+ * @return
+ */
+ private boolean matches(List<Pattern> patterns, String parameter)
+ {
+ for (Pattern pattern : patterns)
+ {
+ if (pattern.matcher(parameter).matches())
+ {
+ // string matched
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Filters the map of parameters, leaving only those than matches filtering regular expressions.
+ * Also adds "${}" to the parameter key: <br>
+ * I.e. such map provided on input:
+ *
+ * "jbosscache-cache.loader":"org.exoplatform"
+ * "jbosscache-configuration":"/conf/test.xml"
+ * "max-volatile-size":"100Kb"
+ *
+ * the output will be like:
+ *
+ * "${jbosscache-cache.loader}":"org.exoplatform"
+ *
+ * Other will be ignored (depending on includes/excludes lists provided in constructor).
+ *
+ * @param parameters
+ * @return
+ */
+ protected Map<String, String> prepareParameters(Map<String, String> parameters)
+ {
+ Map<String, String> map = new HashMap<String, String>();
+ for (Entry<String, String> entry : parameters.entrySet())
+ {
+ if (matches(includes, entry.getKey()) && !matches(excludes, entry.getKey()))
+ {
+ map.put("${" + entry.getKey() + "}", entry.getValue());
+ }
+ }
+ return map;
+ }
+
+ /**
+ * Reads bytes from input stream and builds a string from them
+ *
+ * @param inputStream
+ * @return
+ * @throws IOException
+ */
+ protected String readStream(InputStream inputStream) throws IOException
+ {
+ StringBuffer out = new StringBuffer();
+ byte[] b = new byte[4096];
+ for (int n; (n = inputStream.read(b)) != -1;)
+ {
+ out.append(new String(b, 0, n));
+ }
+ return out.toString();
+ }
+}
Property changes on: jcr/trunk/exo.jcr.component.core/src/main/java/org/exoplatform/services/jcr/config/TemplateConfigurationHelper.java
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Added: jcr/trunk/exo.jcr.component.core/src/test/java/org/exoplatform/services/jcr/config/TestTemplateConfigurationHelper.java
===================================================================
--- jcr/trunk/exo.jcr.component.core/src/test/java/org/exoplatform/services/jcr/config/TestTemplateConfigurationHelper.java (rev 0)
+++ jcr/trunk/exo.jcr.component.core/src/test/java/org/exoplatform/services/jcr/config/TestTemplateConfigurationHelper.java 2010-01-26 15:01:35 UTC (rev 1580)
@@ -0,0 +1,81 @@
+/*
+ * Copyright (C) 2010 eXo Platform SAS.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package org.exoplatform.services.jcr.config;
+
+import junit.framework.TestCase;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * @author <a href="mailto:nikolazius at gmail.com">Nikolay Zamosenchuk</a>
+ * @version $Id: TestTemplateHelper.java 34360 2009-07-22 23:58:59Z nzamosenchuk $
+ *
+ */
+public class TestTemplateConfigurationHelper extends TestCase
+{
+
+ public void testFilters()
+ {
+ // create helper with predefined include and exclude patterns
+ TemplateConfigurationHelper helper = TemplateConfigurationHelper.createJBossCacheHelper();
+ Map<String, String> parameters = new HashMap<String, String>();
+ parameters.put("jbosscache-configuration", "");
+ parameters.put("jbosscache-cache.loader", "");
+ parameters.put("jbosscache-clustername", "");
+ parameters.put("max-volatile-size", "");
+ Map<String, String> preparedParameters = helper.prepareParameters(parameters);
+ assertEquals(2, preparedParameters.size());
+ // "jbosscache-configuration" and "max-volatile-size" should be excluded
+ assertFalse(preparedParameters.containsKey("${jbosscache-configuration}"));
+ assertFalse(preparedParameters.containsKey("${max-volatile-size}"));
+ assertTrue(preparedParameters.containsKey("${jbosscache-cache.loader}"));
+ assertTrue(preparedParameters.containsKey("${jbosscache-clustername}"));
+ }
+
+ public void testTemplating() throws IOException
+ {
+ TemplateConfigurationHelper helper = TemplateConfigurationHelper.createJBossCacheHelper();
+ String template = "configuration in any format, containing ${jbosscache-template-variable} and many others";
+ String expectedConfig = "configuration in any format, containing pretty good parameter and many others";
+
+ InputStream templateStream = new ByteArrayInputStream(template.getBytes());
+
+ Map<String, String> parameters = new HashMap<String, String>();
+ parameters.put("jbosscache-template-variable", "pretty good parameter");
+
+ InputStream configStream = helper.fillTemplate(templateStream, parameters);
+ String config = readStream(configStream);
+ assertTrue(expectedConfig.equals(config));
+ }
+
+ private String readStream(InputStream inputStream) throws IOException
+ {
+ StringBuffer out = new StringBuffer();
+ byte[] b = new byte[4096];
+ for (int n; (n = inputStream.read(b)) != -1;)
+ {
+ out.append(new String(b, 0, n));
+ }
+ return out.toString();
+ }
+}
Property changes on: jcr/trunk/exo.jcr.component.core/src/test/java/org/exoplatform/services/jcr/config/TestTemplateConfigurationHelper.java
___________________________________________________________________
Name: svn:mime-type
+ text/plain
More information about the exo-jcr-commits
mailing list