/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.test.remoting.callback.timeout;
import java.lang.reflect.Field;
import java.net.InetAddress;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import javax.management.MBeanServer;
import junit.framework.TestCase;
import org.apache.log4j.ConsoleAppender;
import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.apache.log4j.PatternLayout;
import org.jboss.remoting.Client;
import org.jboss.remoting.InvocationRequest;
import org.jboss.remoting.InvokerLocator;
import org.jboss.remoting.ServerInvocationHandler;
import org.jboss.remoting.ServerInvoker;
import org.jboss.remoting.callback.Callback;
import org.jboss.remoting.callback.HandleCallbackException;
import org.jboss.remoting.callback.InvokerCallbackHandler;
import org.jboss.remoting.callback.ServerInvokerCallbackHandler;
import org.jboss.remoting.transport.Connector;
import org.jboss.remoting.transport.PortUtil;
/**
* Unit test for JBREM-799.
*
* @author <a href="ron.sigal@jboss.com">Ron Sigal</a>
* @version $Revision: 1.1.2.2 $
* <p>
* Copyright Jan 25, 2008
* </p>
*/
abstract public class CallbackTimeoutTestParent extends TestCase
{
public static int port;
private static Logger log = Logger.getLogger(CallbackTimeoutTestParent.class);
private static final String CALLBACK_TEST = "callbackTest";
private static boolean firstTime = true;
// remoting server connector
private Connector connector;
private InvokerLocator serverLocator;
private TestInvocationHandler invocationHandler;
/**
* Sets up target remoting server.
*/
public void setUp() throws Exception
{
if (firstTime)
{
firstTime = false;
Logger.getLogger("org.jboss.remoting").setLevel(Level.INFO);
Logger.getLogger("org.jboss.test.remoting").setLevel(Level.INFO);
String pattern = "[%d{ABSOLUTE}] [%t] %5p (%F:%L) - %m%n";
PatternLayout layout = new PatternLayout(pattern);
ConsoleAppender consoleAppender = new ConsoleAppender(layout);
Logger.getRootLogger().addAppender(consoleAppender);
}
}
public void tearDown()
{
}
/**
* Verifies that "timeout" value is used in absence of "callbackTimeout" value.
*/
public void testNoCallbackTimeout() throws Throwable
{
log.info("entering " + getName());
// Start server.
String host = InetAddress.getLocalHost().getHostAddress();
port = PortUtil.findFreePort(host);
String locatorURI = getTransport() + "://" + host + ":" + port;
serverLocator = new InvokerLocator(locatorURI);
log.info("Starting remoting server with locator uri of: " + locatorURI);
HashMap config = new HashMap();
config.put(InvokerLocator.FORCE_REMOTE, "true");
config.put(ServerInvoker.TIMEOUT, "3000");
addExtraServerConfig(config);
connector = new Connector(serverLocator, config);
connector.create();
invocationHandler = new TestInvocationHandler();
connector.addInvocationHandler("sample", invocationHandler);
connector.start();
// Create client.
HashMap clientConfig = new HashMap();
clientConfig.put(InvokerLocator.FORCE_REMOTE, "true");
addExtraClientConfig(clientConfig);
final Client client = new Client(serverLocator, clientConfig);
client.connect();
assertEquals("abc", client.invoke("abc"));
log.info("client is connected");
// Add callback handler.
TestInvokerCallbackHandler testCallbackHandler = new TestInvokerCallbackHandler();
client.addListener(testCallbackHandler, new HashMap(), null, true);
client.invoke(CALLBACK_TEST);
assertEquals(1, testCallbackHandler.counter);
log.info("callback handler is installed");
// Verify that "timeout" is used correctly.
ServerInvoker serverInvoker = connector.getServerInvoker();
Map configuration = serverInvoker.getConfiguration();
assertEquals("3000", configuration.get(ServerInvoker.TIMEOUT));
// Verify that "timeout" is used in the absence of "callbackTimeout".
Field field = ServerInvoker.class.getDeclaredField("callbackHandlers");
field.setAccessible(true);
Map callbackHandlers = (Map) field.get(serverInvoker);
assertEquals(1, callbackHandlers.size());
Object o = callbackHandlers.values().iterator().next();
ServerInvokerCallbackHandler callbackHandler = (ServerInvokerCallbackHandler) o;
field = ServerInvokerCallbackHandler.class.getDeclaredField("callBackClient");
field.setAccessible(true);
Client callBackClient = (Client) field.get(callbackHandler);
configuration = callBackClient.getConfiguration();
assertEquals("3000", configuration.get(ServerInvoker.TIMEOUT));
client.removeListener(testCallbackHandler);
client.disconnect();
connector.stop();
}
/**
* Verifies that "callbackTimeout" value overrides "timeout" value.
* Values are specified in configuration map.
*/
public void testDistinctCallbackTimeoutConfigMap() throws Throwable
{
log.info("entering " + getName());
// Start server.
String host = InetAddress.getLocalHost().getHostAddress();
port = PortUtil.findFreePort(host);
String locatorURI = getTransport() + "://" + host + ":" + port;
serverLocator = new InvokerLocator(locatorURI);
log.info("Starting remoting server with locator uri of: " + locatorURI);
HashMap config = new HashMap();
config.put(InvokerLocator.FORCE_REMOTE, "true");
config.put(ServerInvoker.TIMEOUT, "3000");
config.put(ServerInvokerCallbackHandler.CALLBACK_TIMEOUT, "7000");
addExtraServerConfig(config);
connector = new Connector(serverLocator, config);
connector.create();
invocationHandler = new TestInvocationHandler();
connector.addInvocationHandler("sample", invocationHandler);
connector.start();
// Create client.
HashMap clientConfig = new HashMap();
clientConfig.put(InvokerLocator.FORCE_REMOTE, "true");
addExtraClientConfig(clientConfig);
final Client client = new Client(serverLocator, clientConfig);
client.connect();
assertEquals("abc", client.invoke("abc"));
log.info("client is connected");
// Add callback handler.
TestInvokerCallbackHandler testCallbackHandler = new TestInvokerCallbackHandler();
client.addListener(testCallbackHandler, new HashMap(), null, true);
client.invoke(CALLBACK_TEST);
assertEquals(1, testCallbackHandler.counter);
log.info("callback handler is installed");
// Verify that "timeout" is used correctly.
ServerInvoker serverInvoker = connector.getServerInvoker();
Map configuration = serverInvoker.getConfiguration();
assertEquals("3000", configuration.get(ServerInvoker.TIMEOUT));
// Verify that "callbackTimeout" is used correctly.
Field field = ServerInvoker.class.getDeclaredField("callbackHandlers");
field.setAccessible(true);
Map callbackHandlers = (Map) field.get(serverInvoker);
assertEquals(1, callbackHandlers.size());
Object o = callbackHandlers.values().iterator().next();
ServerInvokerCallbackHandler callbackHandler = (ServerInvokerCallbackHandler) o;
field = ServerInvokerCallbackHandler.class.getDeclaredField("callBackClient");
field.setAccessible(true);
Client callBackClient = (Client) field.get(callbackHandler);
configuration = callBackClient.getConfiguration();
assertEquals("7000", configuration.get(ServerInvoker.TIMEOUT));
client.removeListener(testCallbackHandler);
client.disconnect();
connector.stop();
}
/**
* Verifies that "callbackTimeout" value overrides "timeout" value.
* Values are specified in InvokerLocator.
*/
public void testDistinctCallbackTimeoutLocator() throws Throwable
{
log.info("entering " + getName());
// Start server.
String host = InetAddress.getLocalHost().getHostAddress();
port = PortUtil.findFreePort(host);
String locatorURI = getTransport() + "://" + host + ":" + port;
locatorURI += "/?timeout=3000&callbackTimeout=7000";
serverLocator = new InvokerLocator(locatorURI);
log.info("Starting remoting server with locator uri of: " + locatorURI);
HashMap config = new HashMap();
config.put(InvokerLocator.FORCE_REMOTE, "true");
addExtraServerConfig(config);
connector = new Connector(serverLocator, config);
connector.create();
invocationHandler = new TestInvocationHandler();
connector.addInvocationHandler("sample", invocationHandler);
connector.start();
// Create client.
HashMap clientConfig = new HashMap();
clientConfig.put(InvokerLocator.FORCE_REMOTE, "true");
addExtraClientConfig(clientConfig);
final Client client = new Client(serverLocator, clientConfig);
client.connect();
assertEquals("abc", client.invoke("abc"));
log.info("client is connected");
// Add callback handler.
TestInvokerCallbackHandler testCallbackHandler = new TestInvokerCallbackHandler();
client.addListener(testCallbackHandler, new HashMap(), null, true);
client.invoke(CALLBACK_TEST);
assertEquals(1, testCallbackHandler.counter);
log.info("callback handler is installed");
// Verify that "timeout" is used correctly.
ServerInvoker serverInvoker = connector.getServerInvoker();
Map configuration = serverInvoker.getConfiguration();
assertEquals("3000", configuration.get(ServerInvoker.TIMEOUT));
// Verify that "callbackTimeout" is used correctly.
Field field = ServerInvoker.class.getDeclaredField("callbackHandlers");
field.setAccessible(true);
Map callbackHandlers = (Map) field.get(serverInvoker);
assertEquals(1, callbackHandlers.size());
Object o = callbackHandlers.values().iterator().next();
ServerInvokerCallbackHandler callbackHandler = (ServerInvokerCallbackHandler) o;
field = ServerInvokerCallbackHandler.class.getDeclaredField("callBackClient");
field.setAccessible(true);
Client callBackClient = (Client) field.get(callbackHandler);
configuration = callBackClient.getConfiguration();
assertEquals("7000", configuration.get(ServerInvoker.TIMEOUT));
client.removeListener(testCallbackHandler);
client.disconnect();
connector.stop();
}
/**
* Verifies that "timeout" value is used in absense of "callbackTimeout".
* "timeout" value is specified in Client.addListener() metadata map.
*/
public void testNoCallbackTimeoutMetadata() throws Throwable
{
log.info("entering " + getName());
// Start server.
String host = InetAddress.getLocalHost().getHostAddress();
port = PortUtil.findFreePort(host);
String locatorURI = getTransport() + "://" + host + ":" + port;
serverLocator = new InvokerLocator(locatorURI);
log.info("Starting remoting server with locator uri of: " + locatorURI);
HashMap config = new HashMap();
config.put(InvokerLocator.FORCE_REMOTE, "true");
addExtraServerConfig(config);
connector = new Connector(serverLocator, config);
connector.create();
invocationHandler = new TestInvocationHandler();
connector.addInvocationHandler("sample", invocationHandler);
connector.start();
// Create client.
HashMap clientConfig = new HashMap();
clientConfig.put(InvokerLocator.FORCE_REMOTE, "true");
addExtraClientConfig(clientConfig);
final Client client = new Client(serverLocator, clientConfig);
client.connect();
assertEquals("abc", client.invoke("abc"));
log.info("client is connected");
// Add callback handler.
TestInvokerCallbackHandler testCallbackHandler = new TestInvokerCallbackHandler();
Map metadata = new HashMap();
metadata.put(ServerInvoker.TIMEOUT, "3000");
client.addListener(testCallbackHandler, metadata, null, true);
client.invoke(CALLBACK_TEST);
assertEquals(1, testCallbackHandler.counter);
log.info("callback handler is installed");
// Verify that "timeout" is used in the absence of "callbackTimeout".
ServerInvoker serverInvoker = connector.getServerInvoker();
Field field = ServerInvoker.class.getDeclaredField("callbackHandlers");
field.setAccessible(true);
Map callbackHandlers = (Map) field.get(serverInvoker);
assertEquals(1, callbackHandlers.size());
Object o = callbackHandlers.values().iterator().next();
ServerInvokerCallbackHandler callbackHandler = (ServerInvokerCallbackHandler) o;
field = ServerInvokerCallbackHandler.class.getDeclaredField("callBackClient");
field.setAccessible(true);
Client callBackClient = (Client) field.get(callbackHandler);
Map configuration = callBackClient.getConfiguration();
assertEquals("3000", configuration.get(ServerInvoker.TIMEOUT));
client.removeListener(testCallbackHandler);
client.disconnect();
connector.stop();
}
/**
* Verifies that "callbackTimeout" value overrides "timeout" value.
* "callbackTimeout" is specified in Client.addListener() metadata map.
*/
public void testDistinctCallbackTimeoutMetadata() throws Throwable
{
log.info("entering " + getName());
// Start server.
String host = InetAddress.getLocalHost().getHostAddress();
port = PortUtil.findFreePort(host);
String locatorURI = getTransport() + "://" + host + ":" + port;
serverLocator = new InvokerLocator(locatorURI);
log.info("Starting remoting server with locator uri of: " + locatorURI);
HashMap config = new HashMap();
config.put(InvokerLocator.FORCE_REMOTE, "true");
addExtraServerConfig(config);
connector = new Connector(serverLocator, config);
connector.create();
invocationHandler = new TestInvocationHandler();
connector.addInvocationHandler("sample", invocationHandler);
connector.start();
// Create client.
HashMap clientConfig = new HashMap();
clientConfig.put(InvokerLocator.FORCE_REMOTE, "true");
addExtraClientConfig(clientConfig);
final Client client = new Client(serverLocator, clientConfig);
client.connect();
assertEquals("abc", client.invoke("abc"));
log.info("client is connected");
// Add callback handler.
TestInvokerCallbackHandler testCallbackHandler = new TestInvokerCallbackHandler();
Map metadata = new HashMap();
metadata.put(ServerInvokerCallbackHandler.CALLBACK_TIMEOUT, "7000");
client.addListener(testCallbackHandler, metadata, null, true);
client.invoke(CALLBACK_TEST);
assertEquals(1, testCallbackHandler.counter);
log.info("callback handler is installed");
// Verify that "callbackTimeout" is used correctly.
ServerInvoker serverInvoker = connector.getServerInvoker();
Field field = ServerInvoker.class.getDeclaredField("callbackHandlers");
field.setAccessible(true);
Map callbackHandlers = (Map) field.get(serverInvoker);
assertEquals(1, callbackHandlers.size());
Object o = callbackHandlers.values().iterator().next();
ServerInvokerCallbackHandler callbackHandler = (ServerInvokerCallbackHandler) o;
field = ServerInvokerCallbackHandler.class.getDeclaredField("callBackClient");
field.setAccessible(true);
Client callBackClient = (Client) field.get(callbackHandler);
Map configuration = callBackClient.getConfiguration();
assertEquals("7000", configuration.get(ServerInvoker.TIMEOUT));
client.removeListener(testCallbackHandler);
client.disconnect();
connector.stop();
}
/**
* Verifies that "callbackTimeout" specified in Client.addListener() metadata
* map overrides values in server InvokerLocator and server configuration map.
*/
public void testMetadataOverridesLocatorAndConfigMap() throws Throwable
{
log.info("entering " + getName());
// Start server.
String host = InetAddress.getLocalHost().getHostAddress();
port = PortUtil.findFreePort(host);
String locatorURI = getTransport() + "://" + host + ":" + port;
locatorURI += "/?callbackTimeout=3000";
serverLocator = new InvokerLocator(locatorURI);
log.info("Starting remoting server with locator uri of: " + locatorURI);
HashMap config = new HashMap();
config.put(InvokerLocator.FORCE_REMOTE, "true");
config.put(ServerInvokerCallbackHandler.CALLBACK_TIMEOUT, "7000");
addExtraServerConfig(config);
connector = new Connector(serverLocator, config);
connector.create();
invocationHandler = new TestInvocationHandler();
connector.addInvocationHandler("sample", invocationHandler);
connector.start();
// Create client.
HashMap clientConfig = new HashMap();
clientConfig.put(InvokerLocator.FORCE_REMOTE, "true");
addExtraClientConfig(clientConfig);
final Client client = new Client(serverLocator, clientConfig);
client.connect();
assertEquals("abc", client.invoke("abc"));
log.info("client is connected");
// Add callback handler.
TestInvokerCallbackHandler testCallbackHandler = new TestInvokerCallbackHandler();
Map metadata = new HashMap();
metadata.put(ServerInvokerCallbackHandler.CALLBACK_TIMEOUT, "11000");
client.addListener(testCallbackHandler, metadata, null, true);
client.invoke(CALLBACK_TEST);
assertEquals(1, testCallbackHandler.counter);
log.info("callback handler is installed");
// Verify that "callbackTimeout" from Client.addListener() metadata
// has precedence.
ServerInvoker serverInvoker = connector.getServerInvoker();
Field field = ServerInvoker.class.getDeclaredField("callbackHandlers");
field.setAccessible(true);
Map callbackHandlers = (Map) field.get(serverInvoker);
assertEquals(1, callbackHandlers.size());
Object o = callbackHandlers.values().iterator().next();
ServerInvokerCallbackHandler callbackHandler = (ServerInvokerCallbackHandler) o;
field = ServerInvokerCallbackHandler.class.getDeclaredField("callBackClient");
field.setAccessible(true);
Client callBackClient = (Client) field.get(callbackHandler);
Map configuration = callBackClient.getConfiguration();
assertEquals("11000", configuration.get(ServerInvoker.TIMEOUT));
client.removeListener(testCallbackHandler);
client.disconnect();
connector.stop();
}
/**
* Verifies that "callbackTimeout" specified in server InvokerLocator
* overrides value specified in server configuration map.
*/
public void testLocatorOverridesConfigMap() throws Throwable
{
log.info("entering " + getName());
// Start server.
String host = InetAddress.getLocalHost().getHostAddress();
port = PortUtil.findFreePort(host);
String locatorURI = getTransport() + "://" + host + ":" + port;
locatorURI += "/?callbackTimeout=3000";
serverLocator = new InvokerLocator(locatorURI);
log.info("Starting remoting server with locator uri of: " + locatorURI);
HashMap config = new HashMap();
config.put(InvokerLocator.FORCE_REMOTE, "true");
config.put(ServerInvokerCallbackHandler.CALLBACK_TIMEOUT, "7000");
addExtraServerConfig(config);
connector = new Connector(serverLocator, config);
connector.create();
invocationHandler = new TestInvocationHandler();
connector.addInvocationHandler("sample", invocationHandler);
connector.start();
// Create client.
HashMap clientConfig = new HashMap();
clientConfig.put(InvokerLocator.FORCE_REMOTE, "true");
addExtraClientConfig(clientConfig);
final Client client = new Client(serverLocator, clientConfig);
client.connect();
assertEquals("abc", client.invoke("abc"));
log.info("client is connected");
// Add callback handler.
TestInvokerCallbackHandler testCallbackHandler = new TestInvokerCallbackHandler();
client.addListener(testCallbackHandler, new HashMap(), null, true);
client.invoke(CALLBACK_TEST);
assertEquals(1, testCallbackHandler.counter);
log.info("callback handler is installed");
// Verify that "callbackTimeout" from InvokerLocator overrides value
// in configuration map.
ServerInvoker serverInvoker = connector.getServerInvoker();
Field field = ServerInvoker.class.getDeclaredField("callbackHandlers");
field.setAccessible(true);
Map callbackHandlers = (Map) field.get(serverInvoker);
assertEquals(1, callbackHandlers.size());
Object o = callbackHandlers.values().iterator().next();
ServerInvokerCallbackHandler callbackHandler = (ServerInvokerCallbackHandler) o;
field = ServerInvokerCallbackHandler.class.getDeclaredField("callBackClient");
field.setAccessible(true);
Client callBackClient = (Client) field.get(callbackHandler);
Map configuration = callBackClient.getConfiguration();
assertEquals("3000", configuration.get(ServerInvoker.TIMEOUT));
client.removeListener(testCallbackHandler);
client.disconnect();
connector.stop();
}
abstract protected String getTransport();
protected void addExtraClientConfig(Map config) {}
protected void addExtraServerConfig(Map config) {}
static class TestInvocationHandler implements ServerInvocationHandler
{
public Set listeners = new HashSet();
public void addListener(InvokerCallbackHandler callbackHandler)
{
listeners.add(callbackHandler);
}
public Object invoke(final InvocationRequest invocation) throws Throwable
{
if (CALLBACK_TEST.equals(invocation.getParameter()))
{
Iterator it = listeners.iterator();
while (it.hasNext())
{
InvokerCallbackHandler handler = (InvokerCallbackHandler) it.next();
handler.handleCallback(new Callback("test"));
}
}
return invocation.getParameter();
}
public void removeListener(InvokerCallbackHandler callbackHandler) {}
public void setMBeanServer(MBeanServer server) {}
public void setInvoker(ServerInvoker invoker) {}
}
static class TestInvokerCallbackHandler implements InvokerCallbackHandler
{
public int counter;
public void handleCallback(Callback callback) throws HandleCallbackException
{
counter++;
}
}
}