org.settings4j.objectresolver

Class SpringConfigObjectResolver

java.lang.Object

org.settings4j.objectresolver.AbstractObjectResolver

org.settings4j.objectresolver.SpringConfigObjectResolver

All Implemented Interfaces:

ObjectResolver

public class SpringConfigObjectResolver
extends AbstractObjectResolver

This implementation parses a Spring-Beans XML File and returns the Object from the generated Spring Application Context.

Per Default the bean with id = key.replace('/', '.') will be returned. But you can configure a key "bean-ref" in the Properties-File for the given Object.

Example: The following code should return a DataSource Object:
Settings4j.getObject("com/myCompany/myApp/MyDatasource");

In normal Cases the DataSource comes from the JNDI-Context (available in most Servlet Containers).
But in some environments there are no JNDI-Context (Commandline-Clients, UnitTests).

With Settings4j (default configuration) you can also place two Files into your Classpath:

1. "com/myCompany/myApp/MyDatasource": The File which defines the DataSource
2. "com/myCompany/myApp/MyDatasource.properties": Some Properties, like which ObjectResolver should be use.

The File Content whould be the following:

• objectResolverKey: A unique identifier for the Object Resolver Implementation.
• bean-ref: The bean name/id from the Spring-Context.

 Classpath File "com/myCompany/myApp/MyDatasource.properties":
 

 objectResolverKey=org.settings4j.objectresolver.SpringConfigObjectResolver
 bean-ref=SpringBeanReferneceId
 
 

 Classpath File "com/myCompany/myApp/MyDatasource":
 

 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">
 <beans>
   <!-- HSQLDB -->
   <bean id="SpringBeanReferneceId" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
     <property name="driverClassName"><value>org.hsqldb.jdbcDriver</value></property>
     <property name="url"><value>jdbc:hsqldb:mem:test</value></property>
     <property name="username"><value>sa</value></property>
     <property name="password"><value></value></property>
   </bean>
 </beans>
 
 

Author:

Harald.Brabenetz

Field Summary

Fields inherited from class org.settings4j.objectresolver.AbstractObjectResolver

PROP_CACHED, PROP_OBJECT_RESOLVER_KEY

Constructor Summary

Constructors

Constructor and Description
SpringConfigObjectResolver()

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	contentToObject(String key, Properties properties, byte[] content, ContentResolver contentResolver) Method to convert the given content-File to an Object must be implemented by SubClasses.

Methods inherited from class org.settings4j.objectresolver.AbstractObjectResolver

addObjectResolver, getObject, getObjectProperties, getObjectResolverKey, getPropertySuffix, isCached, setCached, setPropertySuffix

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpringConfigObjectResolver

public SpringConfigObjectResolver()

Method Detail

contentToObject

protected Object contentToObject(String key,
                     Properties properties,
                     byte[] content,
                     ContentResolver contentResolver)

Method to convert the given content-File to an Object must be implemented by SubClasses.

Specified by:

contentToObject in class AbstractObjectResolver

Parameters:

key - The Original Key of the Object

properties - The Property-File which where Found under key + ".properties"

content - The byte[] Content to convert.

contentResolver - the contentResolver to get possible additional content Files.

Returns:

the parsed Object from the byte[] Content.