You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by cz...@apache.org on 2015/05/12 08:13:11 UTC
svn commit: r1678871 - in /felix/trunk/configadmin: changelog.txt
src/main/java/org/apache/felix/cm/file/ConfigurationHandler.java
src/test/java/org/apache/felix/cm/file/FilePersistenceManagerTest.java
Author: cziegeler
Date: Tue May 12 06:13:11 2015
New Revision: 1678871
URL: http://svn.apache.org/r1678871
Log:
FELIX-4844 : Store configuration data in a diff-tool friendly way
Modified:
felix/trunk/configadmin/changelog.txt
felix/trunk/configadmin/src/main/java/org/apache/felix/cm/file/ConfigurationHandler.java
felix/trunk/configadmin/src/test/java/org/apache/felix/cm/file/FilePersistenceManagerTest.java
Modified: felix/trunk/configadmin/changelog.txt
URL: http://svn.apache.org/viewvc/felix/trunk/configadmin/changelog.txt?rev=1678871&r1=1678870&r2=1678871&view=diff
==============================================================================
--- felix/trunk/configadmin/changelog.txt (original)
+++ felix/trunk/configadmin/changelog.txt Tue May 12 06:13:11 2015
@@ -4,6 +4,9 @@ Changes from 1.8.4 to 1.8.6
** Bug
* [FELIX-4884] - listConfigurations should return null if no configuration is found
+** Improvement
+ * [FELIX-4844] - Store configuration data in a diff-tool friendly way
+
Changes from 1.8.2 to 1.8.4
---------------------------
Modified: felix/trunk/configadmin/src/main/java/org/apache/felix/cm/file/ConfigurationHandler.java
URL: http://svn.apache.org/viewvc/felix/trunk/configadmin/src/main/java/org/apache/felix/cm/file/ConfigurationHandler.java?rev=1678871&r1=1678870&r2=1678871&view=diff
==============================================================================
--- felix/trunk/configadmin/src/main/java/org/apache/felix/cm/file/ConfigurationHandler.java (original)
+++ felix/trunk/configadmin/src/main/java/org/apache/felix/cm/file/ConfigurationHandler.java Tue May 12 06:13:11 2015
@@ -30,8 +30,10 @@ import java.io.PushbackReader;
import java.io.Writer;
import java.lang.reflect.Array;
import java.util.ArrayList;
+import java.util.Arrays;
import java.util.BitSet;
import java.util.Collection;
+import java.util.Collections;
import java.util.Dictionary;
import java.util.Enumeration;
import java.util.HashMap;
@@ -95,6 +97,8 @@ public class ConfigurationHandler
protected static final int TOKEN_PRIMITIVE_BOOLEAN = 'b';
protected static final String CRLF = "\r\n";
+ protected static final String INDENT = " ";
+ protected static final String COLLECTION_LINE_BREAK = " \\\r\n";
protected static final Map code2Type;
protected static final Map type2Code;
@@ -200,7 +204,7 @@ public class ConfigurationHandler
{
BufferedWriter bw = new BufferedWriter( new OutputStreamWriter( out, ENCODING ) );
- for ( Enumeration ce = properties.keys(); ce.hasMoreElements(); )
+ for ( Enumeration ce = orderedKeys(properties); ce.hasMoreElements(); )
{
String key = ( String ) ce.nextElement();
@@ -214,6 +218,28 @@ public class ConfigurationHandler
bw.flush();
}
+ /**
+ * Generates an <code>Enumeration</code> for the given
+ * <code>Dictionary</code> where the keys of the <code>Dictionary</code>
+ * are provided in sorted order.
+ *
+ * @param properties
+ * The <code>Dictionary</code> that keys are sorted.
+ * @return An <code>Enumeration</code> that provides the keys of
+ * properties in an ordered manner.
+ */
+ private static Enumeration orderedKeys(Dictionary properties) {
+ String[] keyArray = new String[properties.size()];
+ int i = 0;
+ for ( Enumeration ce = properties.keys(); ce.hasMoreElements(); )
+ {
+ keyArray[i] = ( String ) ce.nextElement();
+ i++;
+ }
+ Arrays.sort(keyArray);
+ return Collections.enumeration( Arrays.asList( keyArray ) );
+ }
+
/**
* Reads configuration data from the given <code>InputStream</code> and
@@ -336,7 +362,7 @@ public class ConfigurationHandler
List list = new ArrayList();
for ( ;; )
{
- int c = read(pr);
+ int c = ignorablePageBreakAndWhiteSpace( pr );
if ( c == TOKEN_VAL_OPEN )
{
Object value = readSimple( typeCode, pr );
@@ -350,7 +376,7 @@ public class ConfigurationHandler
list.add( value );
- c = read( pr );
+ c = ignorablePageBreakAndWhiteSpace( pr );
}
if ( c == TOKEN_ARR_CLOS )
@@ -380,7 +406,7 @@ public class ConfigurationHandler
Collection collection = new ArrayList();
for ( ;; )
{
- int c = read( pr );
+ int c = ignorablePageBreakAndWhiteSpace( pr );
if ( c == TOKEN_VAL_OPEN )
{
Object value = readSimple( typeCode, pr );
@@ -394,7 +420,7 @@ public class ConfigurationHandler
collection.add( value );
- c = read( pr );
+ c = ignorablePageBreakAndWhiteSpace( pr );
}
if ( c == TOKEN_VEC_CLOS )
@@ -480,23 +506,6 @@ public class ConfigurationHandler
}
- private boolean checkNext( PushbackReader pr, int expected ) throws IOException
- {
- int next = read( pr );
- if ( next < 0 )
- {
- return false;
- }
-
- if ( next == expected )
- {
- return true;
- }
-
- return false;
- }
-
-
private String readQuoted( PushbackReader pr ) throws IOException
{
StringBuffer buf = new StringBuffer();
@@ -599,6 +608,28 @@ public class ConfigurationHandler
}
+ private int ignorablePageBreakAndWhiteSpace( PushbackReader pr ) throws IOException
+ {
+ int c = ignorableWhiteSpace( pr );
+ for ( ;; )
+ {
+ if ( c != '\\' )
+ {
+ break;
+ }
+ int c1 = pr.read();
+ if ( c1 == '\r' || c1 == '\n' )
+ {
+ c = ignorableWhiteSpace( pr );
+ } else {
+ pr.unread(c1);
+ break;
+ }
+ }
+ return c;
+ }
+
+
private int read( PushbackReader pr ) throws IOException
{
int c = pr.read();
@@ -678,12 +709,12 @@ public class ConfigurationHandler
int size = Array.getLength( arrayValue );
writeType( out, arrayValue.getClass().getComponentType() );
out.write( TOKEN_ARR_OPEN );
+ out.write( COLLECTION_LINE_BREAK );
for ( int i = 0; i < size; i++ )
{
- if ( i > 0 )
- out.write( TOKEN_COMMA );
- writeSimple( out, Array.get( arrayValue, i ) );
+ writeCollectionElement(out, Array.get( arrayValue, i ));
}
+ out.write( INDENT );
out.write( TOKEN_ARR_CLOS );
}
@@ -693,6 +724,7 @@ public class ConfigurationHandler
if ( collection.isEmpty() )
{
out.write( TOKEN_VEC_OPEN );
+ out.write( COLLECTION_LINE_BREAK );
out.write( TOKEN_VEC_CLOS );
}
else
@@ -702,18 +734,27 @@ public class ConfigurationHandler
writeType( out, firstElement.getClass() );
out.write( TOKEN_VEC_OPEN );
- writeSimple( out, firstElement );
+ out.write( COLLECTION_LINE_BREAK );
+
+ writeCollectionElement( out, firstElement );
while ( ci.hasNext() )
{
- out.write( TOKEN_COMMA );
- writeSimple( out, ci.next() );
+ writeCollectionElement( out, ci.next() );
}
out.write( TOKEN_VEC_CLOS );
}
}
+ private static void writeCollectionElement(Writer out, Object element) throws IOException {
+ out.write( INDENT );
+ writeSimple( out, element );
+ out.write( TOKEN_COMMA );
+ out.write(COLLECTION_LINE_BREAK);
+ }
+
+
private static void writeType( Writer out, Class valueType ) throws IOException
{
Integer code = ( Integer ) type2Code.get( valueType );
Modified: felix/trunk/configadmin/src/test/java/org/apache/felix/cm/file/FilePersistenceManagerTest.java
URL: http://svn.apache.org/viewvc/felix/trunk/configadmin/src/test/java/org/apache/felix/cm/file/FilePersistenceManagerTest.java?rev=1678871&r1=1678870&r2=1678871&view=diff
==============================================================================
--- felix/trunk/configadmin/src/test/java/org/apache/felix/cm/file/FilePersistenceManagerTest.java (original)
+++ felix/trunk/configadmin/src/test/java/org/apache/felix/cm/file/FilePersistenceManagerTest.java Tue May 12 06:13:11 2015
@@ -19,7 +19,9 @@
package org.apache.felix.cm.file;
+import java.io.BufferedReader;
import java.io.File;
+import java.io.FileReader;
import java.io.IOException;
import java.lang.reflect.Array;
import java.util.ArrayList;
@@ -29,6 +31,7 @@ import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Vector;
+import junit.framework.Assert;
import junit.framework.TestCase;
@@ -253,6 +256,37 @@ public class FilePersistenceManagerTest
check( "LPT1", "lpt1" );
}
+ public void testKeyOrderInFile() throws IOException
+ {
+ Dictionary props = new Hashtable();
+ // The following keys are stored as "c, a, b" in HashTable based
+ // due to their hash code
+ props.put( "a_first", "a" );
+ props.put( "b_second", "b" );
+ props.put( "c_third", "c" );
+
+ String pid = "keyOrderInFile";
+ fpm.store( pid, props );
+ File configFile = new File( file, fpm.encodePid( pid ) + ".config" );
+ FileReader reader = new FileReader( configFile );
+ BufferedReader breader = new BufferedReader(reader);
+ try
+ {
+ String previousLine = breader.readLine();
+ while ( previousLine != null)
+ {
+ String line = breader.readLine();
+ if (line != null) {
+ Assert.assertTrue( previousLine.compareTo( line ) < 0 );
+ }
+ previousLine = line;
+ }
+ }
+ finally
+ {
+ breader.close();
+ }
+ }
private void check( String name, Object value ) throws IOException
{