tags:

views:

121

answers:

5

Consider the following scenario. I have a Spring application context with a bean whose properties should be configurable, think DataSource or MailSender. The mutable application configuration is managed by a separate bean, let's call it configuration.

An administrator can now change the configuration values, like email address or database URL, and I would like to re-initialize the configured bean at runtime.

Assume that I can't just simply modify the property of the configurable bean above (e.g. created by FactoryBean or constructor injection) but have to recreate the bean itself.

Any thoughts on how to achieve this? I'd be glad to receive advice on how to organize the whole configuration thing as well. Nothing is fixed. :-)

EDIT

To clarify things a bit: I am not asking how to update the configuration or how to inject static configuration values. I'll try an example:

<beans>
    <util:map id="configuration">
        <!-- initial configuration -->
    </util:map>

    <bean id="constructorInjectedBean" class="Foo">
        <constructor-arg value="#{configuration['foobar']}" />
    </bean>

    <bean id="configurationService" class="ConfigurationService">
        <property name="configuration" ref="configuration" />
    </bean>
</beans>

So there's a bean constructorInjectedBean that uses constructor injection. Imagine the construction of the bean is very expensive so using a prototype scope or a factory proxy is not an option, think DataSource.

What I want to do is that every time the configuration is being updated (via configurationService the bean constructorInjectedBean is being recreated and re-injected into the application context and dependent beans.

We can safely assume that constructorInjectedBean is using an interface so proxy magic is indeed an option.

I hope to have made the question a little bit clearer.

A: 

Option 1 :

  1. Inject the configurable bean into the DataSource or MailSender. Always get the configurable values from the configuration bean from within these beans.
  2. Inside the configurable bean run a thread to read the externally configurable properties (file etc..) periodically. This way the configurable bean will refresh itself after the admin had changed the properties and so the DataSource will get the updated values automatically.

Option 2 (bad, i think, but maybe not - depends on use case) :

  1. Always create new beans for beans of type DataSource / MailSender - using prototype scope. In the init of the bean, read the properties afresh.

Option 3 : I think, @mR_fr0g suggestion on using JMX might not be a bad idea. What you could do is :

  1. expose your configuration bean as a MBean (read http://static.springsource.org/spring/docs/2.5.x/reference/jmx.html)
  2. Ask your admin to change the configuration properties on the MBean (or provide an interface in the bean to trigger property updates from their source)
  3. This MBean (a new piece of java code that you will need to write), MUST keep references of Beans (the ones that you want to change / inject the changed properties into). This should be simple (via setter injection or runtime fetch of bean names / classes)
    1. When the property on the MBean is changed (or triggered), it must call the appropriate setters on the respective beans. That way, your legacy code does not change, you can still manage runtime property changes.

HTH!

madhurtanwani
Also I'm hoping you've read http://stackoverflow.com/questions/2008175/apply-dynamic-properties-to-a-bean-at-runtime
madhurtanwani
Option 1 will probably not work if I have no control over the configured classes. And if I had control over them they would be "polluted" by configuration code which sounds not good to me. Option 2 is not an option in my case because bean lifecycle is expensive. You wouldn't want to apply a prototype scope to a DataSource... please see OP for an edit with clarifications.
Philipp Jardas
The <a href="http://stackoverflow.com/questions/2008175/apply-dynamic-properties-to-a-bean-at-runtime">referenced question</a> does not seem to hold an answer to my problem...
Philipp Jardas
I'm not sure if "polluted" is even correct - you have classes that need externally defined configuration. Now, either you must "inject" the properties (as they change) into these classes (in which case I think the class injecting the prop must know of such classes needing the configuration) OR those classes must pull the changes as they happen - probably via a central config manager
madhurtanwani
+5  A: 

You should have a look at JMX. Spring also provides support for this.

mR_fr0g
Thanks for the edit.
mR_fr0g
Thanks for the suggestion. I have to admit I'm quite a newbie when it comes to JMX. Could you please provide a little hint on how to achieve the behavior I'm looking for?
Philipp Jardas
+1  A: 

Further updated answer to cover scripted bean

Another approach supported by spring 2.5.x+ is that of the scripted bean. You can use a variety of languages for your script - BeanShell is probably the most intuitive given that it has the same syntax as Java, but it does require some external dependencies. However, the examples are in Groovy.

Section 24.3.1.2 of the Spring Documentation covers how to configure this, but here are some salient excerpts illustrating the approach which I've edited to make them more applicable to your situation:

<beans>

    <!-- This bean is now 'refreshable' due to the presence of the 'refresh-check-delay' attribute -->
    <lang:groovy id="messenger"
          refresh-check-delay="5000" <!-- switches refreshing on with 5 seconds between checks -->
          script-source="classpath:Messenger.groovy">
        <lang:property name="message" value="defaultMessage" />
    </lang:groovy>

    <bean id="service" class="org.example.DefaultService">
        <property name="messenger" ref="messenger" />
    </bean>

</beans>

With the Groovy script looking like this:

package org.example

class GroovyMessenger implements Messenger {

    private String message = "anotherProperty";

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message
    }
}

As the system administrator wants to make changes then they (or you) can edit the contents of the script appropriately. The script is not part of the deployed application and can reference a known file location (or one that is configured through a standard PropertyPlaceholderConfigurer during startup).

Although the example uses a Groovy class, you could have the class execute code that reads a simple properties file. In that manner, you never edit the script directly, just touch it to change the timestamp. That action then triggers the reload, which in turn triggers the refresh of properties from the (updated) properties file, which finally updates the values within the Spring context and off you go.

The documentation does point out that this technique doesn't work for constructor-injection, but maybe you can work around that.

Updated answer to cover dynamic property changes

Quoting from this article, which provides full source code, one approach is:

* a factory bean that detects file system changes
* an observer pattern for Properties, so that file system changes can be propagated
* a property placeholder configurer that remembers where which placeholders were used, and updates singleton beans’ properties
* a timer that triggers the regular check for changed files

The observer pattern is implemented by the interfaces and classes ReloadableProperties, ReloadablePropertiesListener, PropertiesReloadedEvent, and ReloadablePropertiesBase. None of them are especially exciting, just normal listener handling. The class DelegatingProperties serves to transparently exchange the current properties when properties are updated. We only update the whole property map at once, so that the application can avoid inconsistent intermediate states (more on this later).

Now the ReloadablePropertiesFactoryBean can be written to create a ReloadableProperties instance (instead of a Properties instance, as the PropertiesFactoryBean does). When prompted to do so, the RPFB checks file modification times, and if necessary, updates its ReloadableProperties. This triggers the observer pattern machinery.

In our case, the only listener is the ReloadingPropertyPlaceholderConfigurer. It behaves just like a standard spring PropertyPlaceholderConfigurer, except that it tracks all usages of placeholders. Now when properties are reloaded, all usages of each modified property are found, and the properties of those singleton beans are assigned again.

Original answer below covering static property changes:

Sounds like you just want to inject external properties into your Spring context. The PropertyPlaceholderConfigurer is designed for this purpose:

  <!-- Property configuration (if required) -->
  <bean id="serverProperties" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
    <property name="locations">
      <list>
        <!-- Identical properties in later files overwrite earlier ones in this list -->
        <value>file:/some/admin/location/application.properties</value>
      </list>
    </property>
  </bean>

you then reference the external properties with Ant syntax placeholders (that can be nested if you want from Spring 2.5.5 onwards)

  <bean id="example" class="org.example.DataSource">
    <property name="password" value="${password}"/>
  </bean>

You then ensure that the application.properties file is only accessible to the admin user and the user running the application.

Example application.properties:

password=Aardvark

Gary Rowe
Thanks for the answer. I'm actually inquiring on how to update the properties at runtime (see edit in OP).
Philipp Jardas
@Philipp OK, in that case this discussion will probably help (it's for an older version of Spring, but could be updated). Read the extensive comments for notes on how to make it work with Map entries and the like: http://www.wuenschenswert.net/wunschdenken/archives/127
Gary Rowe
@Gary, thanks for the reply. I've checked the blog you've mentioned and find that I have already created something like this myself. However, I still have no idea how I could not only update properties of beans but replace the bean instances themselves. Let's assume for discussions's sake that we're talking about a property of a `DataSource` that is created with a `FactoryBean`. The mentioned approach would only update the values of the factory bean, which is no help at all. :-(
Philipp Jardas
@Philipp No problems. As a last gasp attempt at solving your problem you could look at bean scripting (see my edits in the answer for details)
Gary Rowe