/*
* JBoss, Home of Professional Open Source
*
* Distributable under LGPL license.
* See terms of license at gnu.org.
*/
package org.jboss.cache.factories;
import org.jboss.cache.config.CacheLoaderConfig;
import org.jboss.cache.config.Configuration;
import org.jboss.cache.config.Configuration.CacheMode;
import org.jboss.cache.config.ConfigurationException;
import org.jboss.cache.config.EvictionRegionConfig;
import org.jboss.cache.transaction.TransactionSetup;
import org.jboss.cache.xml.XmlHelper;
import org.jboss.cache.eviction.LRUConfiguration;
import org.jgroups.conf.XmlConfigurator;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import java.io.InputStream;
import java.net.URL;
/**
* Cache configuration factory used by unit tests.
*/
public class UnitTestCacheConfigurationFactory
{
public static final String JGROUPS_CHANNEL;
public static final String JGROUPS_STACK_TYPE = "jgroups.stack";
public static final String DEFAULT_CONFIGURATION_FILE = "META-INF/unit-test-cache-service.xml";
static
{
JGROUPS_CHANNEL = System.getProperty(JGROUPS_STACK_TYPE, "udp");
}
public static Configuration createConfiguration(CacheMode mode) throws ConfigurationException
{
return createConfiguration(mode, false, false);
}
public static Configuration createConfiguration(CacheMode mode, boolean useEviction) throws ConfigurationException
{
return createConfiguration(mode, useEviction, false);
}
public static Configuration createConfiguration(CacheMode mode, boolean useEviction, boolean usePassivation) throws ConfigurationException
{
UnitTestXmlConfigurationParser parser = new UnitTestXmlConfigurationParser();
Configuration c = parser.parseFile(DEFAULT_CONFIGURATION_FILE, mode);
if (!useEviction)
{
c.setEvictionConfig(null);
}
if (!usePassivation)
{
c.setCacheLoaderConfig(null);
}
c.setTransactionManagerLookupClass(TransactionSetup.getManagerLookup());
return c;
}
public static CacheLoaderConfig getSingleCacheLoaderConfig(String preload, String cacheloaderClass, String properties, boolean async, boolean fetchPersistentState, boolean shared) throws Exception
{
return getSingleCacheLoaderConfig(preload, cacheloaderClass, properties, async, fetchPersistentState, shared, false);
}
public static CacheLoaderConfig getSingleCacheLoaderConfig(String preload, String cacheloaderClass, String properties, boolean async, boolean fetchPersistentState, boolean shared, boolean purgeOnStartup) throws Exception
{
return getSingleCacheLoaderConfig(false, preload, cacheloaderClass, properties, async, fetchPersistentState, shared, purgeOnStartup);
}
protected static CacheLoaderConfig getSingleCacheLoaderConfig(boolean passivation, String preload, String cacheloaderClass, String properties, boolean async, boolean fetchPersistentState, boolean shared, boolean purgeOnStartup) throws Exception
{
String xml = "<config>\n" +
"<passivation>" + passivation + "</passivation>\n" +
"<preload>" + preload + "</preload>\n" +
"<cacheloader>\n" +
"<class>" + cacheloaderClass + "</class>\n" +
"<properties>" + properties + "</properties>\n" +
"<async>" + async + "</async>\n" +
"<shared>" + shared + "</shared>\n" +
"<fetchPersistentState>" + fetchPersistentState + "</fetchPersistentState>\n" +
"<purgeOnStartup>" + purgeOnStartup + "</purgeOnStartup>\n" +
"</cacheloader>\n" +
"</config>";
Element element = XmlHelper.stringToElement(xml);
return XmlConfigurationParser.parseCacheLoaderConfig(element);
}
/**
* Helper method that takes a <b>JGroups</b> configuration file and creates an old-style JGroups config {@link String} that can be used
* in {@link org.jboss.cache.config.Configuration#setClusterConfig(String)}. Note that expressions
* in the file - such as <tt>${jgroups.udp.mcast_port:45588}</tt> are expanded out accordingly.
* @param url url to the cfg file
* @return a String
*/
public static String getClusterConfigFromFile(URL url)
{
try
{
XmlConfigurator conf = XmlConfigurator.getInstance(url);
String tmp = conf.getProtocolStackString();
// parse this string for ${} substitutions
// Highly crappy approach!!
tmp = tmp.replace("${jgroups.udp.mcast_addr:228.10.10.10}", "228.10.10.10");
tmp = tmp.replace("${jgroups.udp.mcast_port:45588}", "45588");
tmp = tmp.replace("${jgroups.udp.ip_ttl:2}", "2");
System.out.println("config string: " + tmp);
return tmp;
}
catch (Exception e)
{
throw new RuntimeException("Problems with url " + url, e);
}
}
/**
* Takes a JGroups configuration "old-style" String and injects the "DELAY" protcol.
* @param jgroupsConfigString JGroups config string
* @param incomingDelay incoming delay
* @param outgoingDelay outgoing delay
* @return new string
*/
public static String injectDelay(String jgroupsConfigString, int incomingDelay, int outgoingDelay)
{
String delay = ":DELAY(in_delay=" +incomingDelay+ ";out_delay="+outgoingDelay+")";
return jgroupsConfigString.substring(0, jgroupsConfigString.indexOf(":")) + delay + jgroupsConfigString.substring(jgroupsConfigString.indexOf(":"));
}
public static EvictionRegionConfig buildLruEvictionRegionConfig(String regionNaame, int maxNodes, int timeToLive)
{
EvictionRegionConfig erc = new EvictionRegionConfig();
erc.setRegionName(regionNaame);
LRUConfiguration lruConfig = new LRUConfiguration();
lruConfig.setEvictionPolicyClass("org.jboss.cache.eviction.LRUPolicy");
if (maxNodes >= 0) lruConfig.setMaxNodes(maxNodes);
if (timeToLive >= 0) lruConfig.setTimeToLiveSeconds(timeToLive);
erc.setEvictionPolicyConfig(lruConfig);
return erc;
}
private static class UnitTestXmlConfigurationParser extends XmlConfigurationParser
{
public Configuration parseFile(String filename, CacheMode mode)
{
return parseStream(getAsInputStreamFromClassLoader(filename == null ? DEFAULT_CONFIGURATION_FILE : filename), mode);
}
public Configuration parseStream(InputStream stream, CacheMode mode)
{
// loop through all elements in XML.
if (stream == null) throw new ConfigurationException("Input stream for configuration xml is null!");
Element root = XmlHelper.getDocumentRoot(stream);
Element mbeanElement = getMBeanElement(root);
ParsedAttributes attributes = extractAttributes(mbeanElement);
// Deal with rename of the old property that controlled MBean registration
String keepStats = attributes.stringAttribs.remove("UseMbean");
if (keepStats != null && attributes.stringAttribs.get("ExposeManagementStatistics") == null)
{
attributes.stringAttribs.put("ExposeManagementStatistics", keepStats);
}
Configuration c = new Configuration();
setValues(c, attributes.stringAttribs, false);
// Special handling for XML elements -- we hard code the parsing
setXmlValues(c, attributes.xmlAttribs);
Element list = (Element) root.getElementsByTagName("protocol_stacks").item(0);
NodeList stacks = list.getElementsByTagName("stack");
for (int i = 0; i < stacks.getLength(); i++)
{
Element stack = (Element) stacks.item(i);
String stackName = stack.getAttribute("name");
if (stackName.startsWith(JGROUPS_CHANNEL))
{
Element jgroupsStack = (Element) stack.getElementsByTagName("config").item(0);
if (mode == CacheMode.REPL_ASYNC && !stackName.contains("-"))
{
c.setClusterConfig(jgroupsStack);
c.setCacheMode(CacheMode.REPL_ASYNC);
break;
}
else if (mode == CacheMode.REPL_SYNC && stackName.contains("-"))
{
c.setClusterConfig(jgroupsStack);
c.setCacheMode(CacheMode.REPL_SYNC);
break;
}
}
}
// either way, set mode in the config!!
c.setCacheMode(mode);
return c;
}
}
}