Java based configuration

[ssm-user]

From cemalettin.koc@gmail.com on January 22, 2014 14:22:43

It would be nice to have java based configuration like "org.springframework.cache.annotation.EnableCaching".

Original issue: http://code.google.com/p/simple-spring-memcached/issues/detail?id=25

[ssm-user]

From ragno...@gmail.com on January 22, 2014 23:31:25

Yes it will be a nice and useful feature. I'll will think how it can be implemented. Do you have an idea what exactly should be configured and how using java based configuration? My concern is how to distinguish between spymemcached and xmemcached providers without merging everything to one module.

[ssm-user]

From cemalettin.koc@gmail.com on January 23, 2014 01:10:39

I am not familiar with your library very much but there are good example about this java configuration. For example, you can look at Spring Security Project. They have extensive java configuration support. If you need some more help, I would give a try a basic example.

Yesterday I tried to use your library for a hello world cache example and It was working nice. Here is the gist for the configuration: https://gist.github.com/cemo/45f3988825aa752872a9

[ssm-user]

From ragno...@gmail.com on January 24, 2014 01:03:53

Thanks! So basically java based configuration works for SSM, right? The only thing that I should get rid of is the required import statement: then SSM can be configured using java. Am I right or miss something?
Can I use your example in documentation?

[ssm-user]

From cemalettin.koc@gmail.com on January 24, 2014 01:32:40

Yes, this is a very basic working example for Spring annotations. But there is a MemcacheConfiguration which is our internal class. It must be changed to according to needs. Of course you can use this but as I said it needs to be a little bid polished.

Also simplesm-context.xml can be provided with @ImportResource(value = "simplesm-context.xml"). A hybrid solution will also work nicely.

But your libary has great potential with java configuration more than this. Java configuration can reveal hidden gems easily. I will try to provide a comprehensive configuration after learning your library.

I think that a maven javaconfig module might be added as spring-security project. Spring-security had such a module then It was merged with core module. But I need some time to learn your library before giving a try. :)

[rodol-fo]

I managed to set up SSM working with Elasticache in an xml-less project by using the examples provided here before (thanks!) and doing some debugging... This is the working code:

@Configuration
@EnableAspectJAutoProxy
@ImportResource("simplesm-context.xml")
public class CacheConfig {

    @Autowired
    private CacheBase cacheBase;

    @Bean
    public CacheFactory cacheFactory() {

        CacheFactory cacheFactory = new CacheFactory();
        cacheFactory.setCacheName("defaultCache");
        cacheFactory.setCacheClientFactory(new MemcacheClientFactoryImpl());
        cacheFactory.setAddressProvider(new DefaultAddressProvider("localhost:11211"));
        cacheFactory.setConfiguration(cacheConfiguration());

        return cacheFactory;
    }

    @Bean
    public CacheManager cacheManager(Cache cache) {

        SSMCache ssmCache = new SSMCache(cache, 300, false);
        SSMCacheManager ssmCacheManager = new SSMCacheManager();
        ssmCacheManager.setCaches(Collections.singleton(ssmCache));

        return ssmCacheManager;
    }

    private CacheConfiguration cacheConfiguration() {

        ElastiCacheConfiguration elastiCacheConfiguration = new ElastiCacheConfiguration();
        elastiCacheConfiguration.setConsistentHashing(true);
        elastiCacheConfiguration.setClientMode(ClientMode.Static);

        return elastiCacheConfiguration;
    }
}

[avanathan]

Thanks @rodol-fo . After few experiments, figured this too works

@Configuration
public class CacheConfig {

    @Bean
    public CacheFactory cacheFactory() {

        CacheFactory cacheFactory = new CacheFactory();
        cacheFactory.setCacheName("defaultCache"); 
        cacheFactory.setCacheClientFactory(new MemcacheClientFactoryImpl());
        cacheFactory.setAddressProvider(new DefaultAddressProvider("localhost:11211"));
        cacheFactory.setConfiguration(cacheConfiguration());

        return cacheFactory;
    }

    @Bean
    public CacheManager cacheManager(Cache cache) {

        SSMCache ssmCache = new SSMCache(cache, 300, false);
        SSMCacheManager ssmCacheManager = new SSMCacheManager();
        ssmCacheManager.setCaches(Collections.singleton(ssmCache));

        return ssmCacheManager;
    }

    private CacheConfiguration cacheConfiguration() {

        ElastiCacheConfiguration elastiCacheConfiguration = new ElastiCacheConfiguration();
        elastiCacheConfiguration.setConsistentHashing(true);
        elastiCacheConfiguration.setClientMode(ClientMode.Static); // change this to ClientMode.Dynamic if you are using ElastiCache cluster

        return elastiCacheConfiguration;
    }
}

[ragnor]

New classes com.google.code.ssm.config.AbstractSSMConfiguration allows to easily configure SSM (with SSM annotations) using only Java based configuration.

As described by @avanathan if SSM is used only through Spring Cache annotations then AbstractSSMConfiguration can be skipped as only two beans are required CacheManager and CacheFactory.
However, if AbstractSSMConfiguration isn't configured then cache disabling feature doesn't work.