CacheModule.java

/* 
 * Copyright 2010 The Ganshane Team.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package corner.cache;


import java.util.Iterator;
import java.util.Map;

import org.apache.tapestry5.ioc.MappedConfiguration;
import org.apache.tapestry5.ioc.ObjectLocator;
import org.apache.tapestry5.ioc.Resource;
import org.apache.tapestry5.ioc.ServiceBinder;
import org.apache.tapestry5.ioc.annotations.Marker;
import org.apache.tapestry5.ioc.internal.util.ClasspathResource;
import org.apache.tapestry5.services.ValueEncoderSource;

import corner.cache.annotations.LocalCache;
import corner.cache.config.LocalCacheConfig;
import corner.cache.services.CacheManager;
import corner.cache.services.CacheProcessor;
import corner.cache.services.CacheProcessorSource;
import corner.cache.services.CacheStrategy;
import corner.cache.services.CacheStrategySource;
import corner.cache.services.CacheableAdvisor;
import corner.cache.services.CacheableDefinitionParser;
import corner.cache.services.NamespaceProcessor;
import corner.cache.services.impl.CacheProcessorSourceImpl;
import corner.cache.services.impl.CacheStrategySourceImpl;
import corner.cache.services.impl.CacheableAdvisorImpl;
import corner.cache.services.impl.CacheableDefinitionParserImpl;
import corner.cache.services.impl.DefaultListCacheStrategyImpl;
import corner.cache.services.impl.IteratorCacheProcessor;
import corner.cache.services.impl.NamespaceProcessorImpl;
import corner.cache.services.impl.PaginationListCacheProcessor;
import corner.cache.services.impl.local.LocalCacheManagerImpl;
import corner.config.services.ConfigurationSource;
import corner.orm.model.PaginationList;
import corner.orm.services.EntityService;

/**
 * Cache的配置,目前提供Memcache和LocalCache的配置:
 * <ul>
 * <li>Memcache memcache-config.xml </li>
 * <li>LocalCache localcache-config.xml </li>
 * </ul>
 * 
 * @author dong
 * @version $Revision$
 * @since 0.0.2
 */
public class CacheModule {
	public static void bind(ServiceBinder binder) {
		binder.bind(CacheProcessorSource.class,CacheProcessorSourceImpl.class);
		binder.bind(NamespaceProcessor.class,NamespaceProcessorImpl.class);
	}
	public static void contributeFactoryDefaults(
			MappedConfiguration<String, String> configuration) {
		//默认不开启缓存
		configuration.add(CacheSymbols.ENABLE_CACHE,"false");
		//默认不启动memcache
		configuration.add(CacheSymbols.ENABLE_MEMCACHED,"false");
	}
	public static CacheStrategySource buildCacheStrategySource(
			Map<String,CacheStrategy> configuration,
			@LocalCache CacheManager localcacheManager,
			ObjectLocator locator){
		CacheManager manager = localcacheManager;
		return new CacheStrategySourceImpl(manager, configuration);
	}
	public static CacheableDefinitionParser buildCacheableDefinitionParser(
			@LocalCache CacheManager localcacheManager,
			ValueEncoderSource valueEncoderSource,
			EntityService entityService,
			CacheStrategySource source,
			ObjectLocator locator){
		CacheManager manager = localcacheManager;
		return new CacheableDefinitionParserImpl(valueEncoderSource,manager,source,entityService);
	}
	public static CacheableAdvisor buildCacheableAdvisor(
		ObjectLocator locator
		){
		return locator.autobuild(CacheableAdvisorImpl.class);
	}
	public static void contributeCacheStrategySource(MappedConfiguration<String,CacheStrategy> configuration){
		configuration.addInstance(CacheConstants.COMMON_LIST_STRATEGY, DefaultListCacheStrategyImpl.class);
	}
	public void contributeCacheProcessorSource(MappedConfiguration<Class,CacheProcessor> configruation){
		configruation.addInstance(PaginationList.class,PaginationListCacheProcessor.class);
		configruation.addInstance(Iterator.class,IteratorCacheProcessor.class);
	}
	
	/**
	 * 构造基于JVM本机内存的CacheManager,并启动该Manager
	 * 
	 * @param configSource
	 * @return
	 * @since 0.0.2
	 */
	@Marker(LocalCache.class)
	public CacheManager buildLocalCacheManager(ConfigurationSource configSource) {
		LocalCacheConfig _config = configSource
				.getServiceConfig(LocalCacheConfig.class);
		CacheManager _manager = new LocalCacheManagerImpl(_config);
		_manager.start();
		return _manager;
	}

	/**
	 * 向ServiceConfigSource增加缓存的配置文件,目前增加的配置文件有:
	 * <ul>
	 * <li>memcache-config.xml 对Memcached Cache的配置</li>
	 * <li>localcache-config.xml 对Local Cache的配置</li>
	 * </ul>
	 * 以上配置文件应该位于classpath中
	 * 
	 * @param configuration
	 * @since 0.0.2
	 */
	public void contributeConfigurationSource(
			MappedConfiguration<Class<?>, Resource> configuration) {
		// 增加LocalCache的配置文件
		configuration.add(LocalCacheConfig.class, new ClasspathResource(
				"localcache-config.xml"));
	}
}