combining inline properties with PropertiesFactoryBean [SPR-1892]

[spring-projects-issues]

Karl Baum opened SPR-1892 and commented

It useful if PropertiesFactoryBean could combine several java.util.Properties instances into one Properties instance. This would allow for combining properties which are listed inline within the spring app context. As of now, combining properties is only possible by combining actual properties files.

Please see: http://forum.springframework.org/showthread.php?t=24075

Thanks.

-karl

---

Affects: 1.2.7, 2.0 M3

Attachments:

• propertiesFactoryBeanTest.xml (785 bytes)
• PropertiesFactoryBeanTests.java (6.18 kB)
• PropertiesLoaderSupport.java (6.88 kB)

[spring-projects-issues]

Karl Baum commented

I have attached a fix for this along with additions to the PropertiesFactoryBeanTest. CVS diffs below.

Index: PropertiesLoaderSupport.java

---

RCS file: /cvsroot/springframework/spring/src/org/springframework/core/io/support/PropertiesLoaderSupport.java,v
retrieving revision 1.4
diff -c -r1.4 PropertiesLoaderSupport.java
*** PropertiesLoaderSupport.java 2 Oct 2005 19:42:41 -0000 1.4
--- PropertiesLoaderSupport.java 15 Apr 2006 14:20:08 -0000

---

*** 46,51 ****
--- 46,53 ----
protected final Log logger = LogFactory.getLog(getClass());

private Properties properties;

• private Properties [] propertiesInstances;

  private Resource[] locations;

---

*** 68,73 ****
--- 70,85 ----
}

/**

• • Set a local array of properties, e.g. via the "props" tag in XML definitions.
• • These can be considered defaults, to be overriden by properties loaded
• • from files.
• • @param propertiesInstances

• */

• public void setPropertiesInstances(Properties[] propertiesInstances) {

  this.propertiesInstances = propertiesInstances;

• }

• /**

  • Set a location of a properties file to be loaded.

  <p>Can point to a classic properties file or to an XML file

  • that follows JDK 1.5's properties XML format.

---

*** 138,149 ****
loadProperties(result);
}

if (this.properties != null) {

! // Use propertyNames enumeration to also catch default properties.
! for (Enumeration en = this.properties.propertyNames(); en.hasMoreElements();) {
! String key = (String) en.nextElement();
! result.setProperty(key, this.properties.getProperty(key));
! }
}

if (!this.localOverride) {

--- 150,163 ----
loadProperties(result);
}

  // add properties reference to result if not null
  if (this.properties != null) {

! addPropertiesToResult(properties, result);
! }
!
! // iterate over array of properties instances and add to result
! for (int i = 0; propertiesInstances!=null && i < propertiesInstances.length; i++) {
! addPropertiesToResult(propertiesInstances[i], result);
}

if (!this.localOverride) {

---

*** 154,159 ****
--- 168,182 ----
return result;
}

• private void addPropertiesToResult(Properties props, Properties result) {

  // Use propertyNames enumeration to also catch default properties.

  for (Enumeration en = props.propertyNames(); en.hasMoreElements();) {

  String key = (String) en.nextElement();

  result.setProperty(key, props.getProperty(key));

  }

• }

• /**

  • Load properties into the given instance.
  • @param props the Properties instance to load into

Index: PropertiesFactoryBeanTests.java

---

RCS file: /cvsroot/springframework/spring/test/org/springframework/beans/factory/config/PropertiesFactoryBeanTests.java,v
retrieving revision 1.9
diff -c -r1.9 PropertiesFactoryBeanTests.java
*** PropertiesFactoryBeanTests.java 24 Jun 2005 17:33:31 -0000 1.9
--- PropertiesFactoryBeanTests.java 15 Apr 2006 14:15:38 -0000

---

*** 20,25 ****
--- 20,27 ----

import junit.framework.TestCase;

• import org.springframework.beans.factory.BeanFactory;
• import org.springframework.context.support.ClassPathXmlApplicationContext;
  import org.springframework.core.JdkVersion;
  import org.springframework.core.io.ClassPathResource;

---

*** 72,77 ****
--- 74,120 ----
assertEquals("99", props.getProperty("tb.array[0].age"));
assertEquals("value2", props.getProperty("key2"));
}
+

• public void testWithPropertiesFileAndLocalPropertiesAndPropertiesInstances () throws Exception {

  PropertiesFactoryBean pfb = new PropertiesFactoryBean();

  pfb.setLocation(new ClassPathResource("/org/springframework/beans/factory/config/test.properties"));

  Properties localProps = new Properties();

  localProps.setProperty("key2", "value2");

  localProps.setProperty("tb.array[0].age", "0");

  pfb.setProperties(localProps);

  Properties propsInstance1 = new Properties();

  propsInstance1.setProperty("spring", "framework");

  propsInstance1.setProperty("Don", "Mattingly");

  Properties propsInstance2 = new Properties();

  propsInstance2.setProperty("spider", "man");

  propsInstance2.setProperty("bat", "man");

  pfb.setPropertiesInstances(new Properties[]{propsInstance1, propsInstance2});

  pfb.afterPropertiesSet();

  Properties props = (Properties) pfb.getObject();

  assertEquals("99", props.getProperty("tb.array[0].age"));

  assertEquals("value2", props.getProperty("key2"));

  assertEquals("framework", props.getProperty("spring"));

  assertEquals("Mattingly", props.getProperty("Don"));

  assertEquals("man", props.getProperty("spider"));

  assertEquals("man", props.getProperty("bat"));

• }

• public void testFromApplicationContext() throws Exception {

  BeanFactory bf = new ClassPathXmlApplicationContext("/org/springframework/beans/factory/config/propertiesFactoryBeanTest.xml");

  Properties props = (Properties) bf.getBean("properties");

  assertEquals("cream", props.getProperty("ice"));

  assertEquals("NY", props.getProperty("NY"));

  assertEquals("CA", props.getProperty("Sanfrancisco"));

  assertEquals("Cash", props.getProperty("Johny"));

  assertEquals("Diniro", props.getProperty("Robert"));

  assertEquals("Park", props.getProperty("Central"));

  assertEquals("Circle", props.getProperty("Columbus"));		

• }

  public void testWithPropertiesFileAndLocalPropertiesAndLocalOverride() throws Exception {
  PropertiesFactoryBean pfb = new PropertiesFactoryBean();

[spring-projects-issues]

Juergen Hoeller commented

Thanks for the suggestion! I've implemented this through a "setPropertiesArray" method on PropertiesFactoryBean, accepting an array of Properties instance (in all other respects treated like local Properties passed into "setProperties").

Juergen