gemfire-core/src/test/java/com/gemstone/gemfire/internal/cache/tier/sockets/DataSerializerPropogationDUnitTest.java

/*=========================================================================
 * Copyright (c) 2010-2014 Pivotal Software, Inc. All Rights Reserved.
 * This product is protected by U.S. and international copyright
 * and intellectual property laws. Pivotal products are covered by
 * one or more patents listed at http://www.pivotal.io/patents.
 *=========================================================================
 */
package com.gemstone.gemfire.internal.cache.tier.sockets;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.util.Iterator;
import java.util.Map.Entry;
import java.util.Properties;

import com.gemstone.gemfire.DataSerializer;
import com.gemstone.gemfire.TestDataSerializer;
import com.gemstone.gemfire.cache.AttributesFactory;
import com.gemstone.gemfire.cache.Cache;
import com.gemstone.gemfire.cache.CacheException;
import com.gemstone.gemfire.cache.CacheFactory;
import com.gemstone.gemfire.cache.MirrorType;
import com.gemstone.gemfire.cache.Region;
import com.gemstone.gemfire.cache.RegionAttributes;
import com.gemstone.gemfire.cache.Scope;
import com.gemstone.gemfire.cache.client.Pool;
import com.gemstone.gemfire.cache.client.PoolManager;
import com.gemstone.gemfire.cache.client.internal.PoolImpl;
import com.gemstone.gemfire.cache.util.BridgeServer;
import com.gemstone.gemfire.cache30.CacheSerializableRunnable;
import com.gemstone.gemfire.distributed.DistributedSystem;
import com.gemstone.gemfire.distributed.internal.DistributionConfig;
import com.gemstone.gemfire.internal.AvailablePort;
import com.gemstone.gemfire.internal.InternalDataSerializer;
import com.gemstone.gemfire.internal.InternalDataSerializer.SerializerAttributesHolder;
import com.gemstone.gemfire.internal.cache.BridgeObserverAdapter;
import com.gemstone.gemfire.internal.cache.BridgeObserverHolder;
import com.gemstone.gemfire.internal.cache.BridgeServerImpl;
import com.gemstone.gemfire.internal.cache.EventID;

import dunit.DistributedTestCase;
import dunit.Host;
import dunit.VM;

public class DataSerializerPropogationDUnitTest extends DistributedTestCase {

  private static final long serialVersionUID = 0L;

  private static Cache cache = null;

  private static VM client1 = null;

  private static VM client2 = null;

  private static VM server1 = null;

  private static VM server2 = null;

  private static int PORT1 = -1;

  private static int PORT2 = -1;

  private static int instanceCountWithAllPuts = 3;

  private static int instanceCountWithOnePut = 1;

  private static final String REGION_NAME = "ClientServerDataSerializersRegistrationDUnitTest";

  protected static EventID eventId;

  static boolean testEventIDResult = false;

  public static boolean successfullyLoadedTestDataSerializer = false;

  public DataSerializerPropogationDUnitTest(String name) {
    super(name);
    // TODO Auto-generated constructor stub
  }

  @Override
  public void setUp() throws Exception {
    super.setUp();
    final Host host = Host.getHost(0);
    client1 = host.getVM(0);
    client2 = host.getVM(1);
    server1 = host.getVM(2);
    server2 = host.getVM(3);
  }

  private void createCache(Properties props) throws Exception {
    DistributedSystem ds = getSystem(props);
    ds.disconnect();
    ds = getSystem(props);
    assertNotNull(ds);
    cache = CacheFactory.create(ds);
    assertNotNull(cache);
  }

  public static void createClientCache(String host, Integer port1)
      throws Exception {
    Properties props = new Properties();
    props.setProperty(DistributionConfig.MCAST_PORT_NAME, "0");
    props.setProperty(DistributionConfig.LOCATORS_NAME, "");
    new DataSerializerPropogationDUnitTest("temp").createCache(props);
    Pool p = PoolManager.createFactory().addServer(host, port1.intValue())
        .setMinConnections(1).setSubscriptionEnabled(true).setPingInterval(200)
        .create("ClientServerDataSerializersRegistrationDUnitTestPool");
    AttributesFactory factory = new AttributesFactory();
    factory.setScope(Scope.DISTRIBUTED_ACK);
    factory.setPoolName(p.getName());
    Region r = cache.createRegion(REGION_NAME, factory.create());
    r.registerInterest("ALL_KEYS");
  }

  protected int getMaxThreads() {
    return 0;
  }

  private int initServerCache(VM server) {
    Object[] args = new Object[] { new Integer(getMaxThreads()) };
    return ((Integer)server.invoke(DataSerializerPropogationDUnitTest.class,
        "createServerCache", args)).intValue();
  }

  public static Integer createServerCache(Integer maxThreads) throws Exception {
    new DataSerializerPropogationDUnitTest("temp")
        .createCache(new Properties());
    AttributesFactory factory = new AttributesFactory();
    factory.setScope(Scope.DISTRIBUTED_ACK);
    factory.setMirrorType(MirrorType.KEYS_VALUES);
    RegionAttributes attrs = factory.create();
    cache.createRegion(REGION_NAME, attrs);
    int port = AvailablePort.getRandomAvailablePort(AvailablePort.SOCKET);
    BridgeServer server1 = cache.addBridgeServer();
    server1.setPort(port);
    server1.setMaxThreads(maxThreads.intValue());
    server1.setNotifyBySubscription(true);
    server1.start();
    return new Integer(port);
  }

  @Override
  public void tearDown2() throws Exception {
    try {
      // close the clients first
      client1.invoke(DataSerializerPropogationDUnitTest.class, "closeCache");
      client2.invoke(DataSerializerPropogationDUnitTest.class, "closeCache");
      closeCache();

      server1.invoke(DataSerializerPropogationDUnitTest.class, "closeCache");
      server2.invoke(DataSerializerPropogationDUnitTest.class, "closeCache");

      super.tearDown2();

      client1 = null;
      client2 = null;
      server1 = null;

    }
    finally {
      unregisterAllDataSerializersFromAllVms();
    }
  }

  public static void closeCache() {
    if (cache != null && !cache.isClosed()) {
      cache.close();
      cache.getDistributedSystem().disconnect();
    }
  }

  public static void verifyDataSerializers(final int numOfDataSerializers) {
    verifyDataSerializers(numOfDataSerializers, false);
  }
  public static void verifyDataSerializers(final int numOfDataSerializers, final boolean allowNonLocal) {
    WaitCriterion wc = new WaitCriterion2() {
      String excuse;

      private DataSerializer[] getSerializers() {
        allowNonLocalTL.set(allowNonLocal);
        try {
          return InternalDataSerializer.getSerializers();
        } finally {
          allowNonLocalTL.remove();
        }
      }
      public boolean done() {
         return getSerializers().length == numOfDataSerializers;
      }

      public String description() {
        return "expected " + numOfDataSerializers + " but got this "
            + InternalDataSerializer.getSerializers().length
          + " serializers=" + java.util.Arrays.toString(getSerializers());
      }
      public boolean stopWaiting() {
        return getSerializers().length > numOfDataSerializers;
      }
    };
    DistributedTestCase.waitForCriterion(wc, 60 * 1000, 1000, true);
  }

  public static final ThreadLocal<Boolean> allowNonLocalTL = new ThreadLocal<Boolean>();
  
  public static void registerDSObject1() throws Exception {

    try {
      InternalDataSerializer.register(DSObject1.class, true);
    }
    catch (Exception e) {
      fail("Test failed due to exception in DSObject1", e);
    }
  }

  public static void registerDSObject2() throws Exception {

    try {
      InternalDataSerializer.register(DSObject2.class, true);
    }
    catch (Exception e) {
      fail("Test failed due to exception in DSObject2", e);
    }
  }

  public static void registerDSObject3() throws Exception {

    try {
      InternalDataSerializer.register(DSObject3.class, true);
    }
    catch (Exception e) {
      fail("Test failed due to exception in DSObject2", e);
    }
  }

  public static void registerDSObject4() throws Exception {

    try {
      InternalDataSerializer.register(DSObject4.class, true);
    }
    catch (Exception e) {
      fail("Test failed due to exception in DSObject4", e);
    }
  }

  public static void registerDSObject5() throws Exception {

    try {
      InternalDataSerializer.register(DSObject5.class, true);
    }
    catch (Exception e) {
      fail("Test failed due to exception in DSObject5", e);
    }
  }

  public static void registerDSObject6() throws Exception {

    try {
      InternalDataSerializer.register(DSObject6.class, true);
    }
    catch (Exception e) {
      fail("Test failed due to exception in DSObject6", e);
    }
  }

  public static void registerDSObject7() throws Exception {

    try {
      InternalDataSerializer.register(DSObject7.class, true);
    }
    catch (Exception e) {
      fail("Test failed due to exception in DSObject7", e);
    }
  }

  public static void registerDSObject8() throws Exception {

    try {
      InternalDataSerializer.register(DSObject8.class, true);
    }
    catch (Exception e) {
      fail("Test failed due to exception in DSObject8", e);
    }
  }

  public static void registerDSObject9() throws Exception {

    try {
      InternalDataSerializer.register(DSObject9.class, true);
    }
    catch (Exception e) {
      fail("Test failed due to exception in DSObject9", e);
    }
  }

  public static void registerDSObject10() throws Exception {

    try {
      InternalDataSerializer.register(DSObject10.class, true);
    }
    catch (Exception e) {
      fail("Test failed due to exception in DSObject10", e);
    }
  }

  public static void registerDSObject11() throws Exception {

    try {
      InternalDataSerializer.register(DSObject11.class, true);
    }
    catch (Exception e) {
      fail("Test failed due to exception in DSObject11", e);
    }
  }

  public static void registerDSObject12() throws Exception {

    try {
      InternalDataSerializer.register(DSObject12.class, true);
    }
    catch (Exception e) {
      fail("Test failed due to exception in DSObject12", e);
    }
  }

  public static void registerDSObject13() throws Exception {

    try {
      InternalDataSerializer.register(DSObject13.class, true);
    }
    catch (Exception e) {
      fail("Test failed due to exception in DSObject13", e);
    }
  }

  public static void registerDSObjectLocalOnly() throws Exception {

    try {
      InternalDataSerializer._register(new DSObjectLocalOnly(79), true);
    }
    catch (Exception e) {
      fail("Test failed due to exception in DSObjectLocalOnly", e);
    }
  }
  
  public static void registerTestDataSerializer() throws Exception {
    try {
      InternalDataSerializer.register(TestDataSerializer.class, true);
    } catch (Exception e) {
      fail("Test failed due to exception in TestDataSerializer", e);
    }
  }

  public static void stopServer() {
    try {
      assertEquals("Expected exactly one BridgeServer", 1, cache
          .getBridgeServers().size());
      BridgeServerImpl bs = (BridgeServerImpl)cache.getBridgeServers()
          .iterator().next();
      assertNotNull(bs);
      bs.stop();
    }
    catch (Exception ex) {
      fail("while setting stopServer  " + ex);
    }
  }

  public static void startServer() {
    try {
      Cache c = CacheFactory.getAnyInstance();
      assertEquals("Expected exactly one BridgeServer", 1, c.getBridgeServers()
          .size());
      BridgeServerImpl bs = (BridgeServerImpl)c.getBridgeServers().iterator()
          .next();
      assertNotNull(bs);
      bs.start();
    }
    catch (Exception ex) {
      fail("while startServer()  " + ex);
    }
  }

  /**
   * In this test the server is up first.2 DataSerializers are registered on it.
   * Verified if the 2 DataSerializers get propogated to client when client gets
   * connected.
   */
  public void testServerUpFirstClientLater() throws Exception {
    PORT1 = initServerCache(server1);

    pause(3000);

    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "registerDSObject1");
    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "registerDSObject2");

    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(2) });

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server1.getHost()), new Integer(PORT1) });

    // wait for client2 to come online
    pause(3000);

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(2) });

    // Put some entries from the client
    client1.invoke(new CacheSerializableRunnable("Put entries from client") {
      @Override
      public void run2() throws CacheException {
        Region region = cache.getRegion(REGION_NAME);
        for (int i = 1; i <= 10; i++) {
          region.put(i, i);
        }
      }
    });

    // Run getAll
    client1
        .invoke(new CacheSerializableRunnable("Get all entries from server") {
          @Override
          public void run2() throws CacheException {
            // Invoke getAll
            Region region = cache.getRegion(REGION_NAME);
            // Verify result size is correct
            assertEquals(1, region.get(1));
          }
        });

    server1.invoke(new CacheSerializableRunnable("Put entry from client") {
      @Override
      public void run2() throws CacheException {
        Region region = cache.getRegion(REGION_NAME);
        region.put(1, 20);
      }
    });

    pause(3000);
    // Run getAll
    client1.invoke(new CacheSerializableRunnable("Get entry from client") {
      @Override
      public void run2() throws CacheException {
        // Invoke getAll
        Region region = cache.getRegion(REGION_NAME);
        // Verify result size is correct
        assertEquals(20, region.get(1));
      }
    });
  }

  public void testDataSerializersWith2ClientsN2Servers() throws Exception {
    PORT1 = initServerCache(server1);
    PORT2 = initServerCache(server2);

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server1.getHost()), new Integer(PORT1) });
    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server2.getHost()), new Integer(PORT2) });

    // wait for client2 to come online
    pause(2000);

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "registerDSObject3");
    pause(4000);

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(1) });

    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(1) });

    server2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(1) });

    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(1) });
  }

  // this test is for bug 44112
  public void testLocalOnlyDS() throws Exception {
    PORT1 = initServerCache(server1);
    PORT2 = initServerCache(server2);

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server1.getHost()), new Integer(PORT1) });
    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server2.getHost()), new Integer(PORT2) });

    // wait for client2 to come online
    pause(2000);

    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "registerDSObjectLocalOnly", new Object[] { });

    pause(4000);

    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(1) });

    server2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(0) });

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(1), Boolean.TRUE });

    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(0) });
  }

  public void testDataSerializersWithServerKill() throws Exception {
    PORT1 = initServerCache(server1);
    PORT2 = initServerCache(server2);

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server1.getHost()), new Integer(PORT1) });
    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server2.getHost()), new Integer(PORT2) });

    // wait for client2 to come online
    pause(2000);

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "registerDSObject4");

    // wait for successful registration

    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { Integer.valueOf(1) });

    server2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { Integer.valueOf(1) });

    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { Integer.valueOf(1) });

    // can get server connectivity exception
    final ExpectedException expectedEx = addExpectedException(
        "Server unreachable", client1);

    // stop the cache server

    server1.invoke(DataSerializerPropogationDUnitTest.class, "stopServer");

    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "registerDSObject5");
    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "registerDSObject6");

    server2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(3) });

    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(3) });

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(
            instanceCountWithOnePut) });

    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(3) });

    expectedEx.remove();
  }

  public void testDataSerializers() throws Exception {
    PORT1 = initServerCache(server1);
    PORT2 = initServerCache(server2);

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server1.getHost()), new Integer(PORT1) });
    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server2.getHost()), new Integer(PORT2) });

    // wait for client2 to come online
    pause(2000);

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "registerDSObject10");

    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "registerDSObject11");
    pause(4000);

    server2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(2) });

    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(2) });

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(2) });

    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(2) });
  }

  public void testDataSerializersWithServerKillAndReInvoked() throws Exception {
    PORT1 = initServerCache(server1);
    PORT2 = initServerCache(server2);
    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server1.getHost()), new Integer(PORT1) });
    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server2.getHost()), new Integer(PORT2) });

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "registerDSObject7");
    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(
            instanceCountWithOnePut) });

    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(
            instanceCountWithOnePut) });

    server2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(
            instanceCountWithOnePut) });

    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(
            instanceCountWithOnePut) });

    // can get server connectivity exception
    final ExpectedException expectedEx = addExpectedException(
        "Server unreachable", client1);

    server1.invoke(DataSerializerPropogationDUnitTest.class, "stopServer");

    try {
      client1.invoke(DataSerializerPropogationDUnitTest.class,
          "registerDSObject8");
    }
    catch (Exception e) {// we are putting in a client whose server is dead

    }
    try {
      client1.invoke(DataSerializerPropogationDUnitTest.class,
          "registerDSObject9");
    }
    catch (Exception e) {// we are putting in a client whose server is
      // dead
    }
    server1.invoke(DataSerializerPropogationDUnitTest.class, "startServer");

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(
            instanceCountWithAllPuts) });

    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(
            instanceCountWithAllPuts) });

    server2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(
            instanceCountWithAllPuts) });

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(
            instanceCountWithAllPuts) });

    expectedEx.remove();
  }

  public void testDataSerializerCount() throws Exception {
    PORT1 = initServerCache(server1);
    PORT2 = initServerCache(server2);

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server1.getHost()), new Integer(PORT1) });
    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server1.getHost()), new Integer(PORT1) });
    createClientCache(getServerHostName(server2.getHost()), new Integer(PORT2));

    // wait for client2 to come online
    pause(2000);

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "registerDSObject12");
    pause(4000);

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(1) });

    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(1) });

    server2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(1) });

    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(1) });

    verifyDataSerializers(1);
  }

  /**
   * Test's same eventId being same for the dataserializers at all clients &
   * servers
   * 
   */
  public void testDataSerializersEventIdVerificationClientsAndServers()
      throws Exception {
    PORT1 = initServerCache(server1, 1);
    PORT2 = initServerCache(server2, 2);

    createClientCache(getServerHostName(server1.getHost()),
        new Integer(PORT1));

    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server2.getHost()), new Integer(PORT2) });
    setBridgeObserver1();
    client2
        .invoke(DataSerializerPropogationDUnitTest.class, "setBridgeObserver2");

    registerDSObject13();

    pause(10000);

    Boolean pass = (Boolean)client2.invoke(
        DataSerializerPropogationDUnitTest.class, "verifyResult");
    assertTrue("EventId found Different", pass.booleanValue());

    PoolImpl.IS_INSTANTIATOR_CALLBACK = false;

  }

  public void testLazyLoadingOfDataSerializersWith2ClientsN2Servers() throws Exception {
    PORT1 = initServerCache(server1);
    PORT2 = initServerCache(server2);

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server1.getHost()), new Integer(PORT1) });
    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "createClientCache", new Object[] {
            getServerHostName(server1.getHost()), new Integer(PORT2) });

    // wait for client2 to come online
    pause(2000);

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "registerTestDataSerializer");
    pause(4000);

    client1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(1) });

    // Verify through InternalDataSerializer's map entries
    client1.invoke(DataSerializerPropogationDUnitTest.class, "verifyLoadedDataSerializers", new Object[] { new Integer(1) });
    client1.invoke(DataSerializerPropogationDUnitTest.class, "verifyDataSerializerClassNamesMap", new Object[] { new Integer(0) });
    client1.invoke(DataSerializerPropogationDUnitTest.class, "verifyDataSerializerIDMap", new Object[] { new Integer(0) });
    client1.invoke(DataSerializerPropogationDUnitTest.class, "verifyDataSerializerSupportedClassNamesMap", new Object[] { new Integer(0) });

    server1.invoke(DataSerializerPropogationDUnitTest.class, "verifyLoadedDataSerializers", new Object[] { new Integer(1) });
    server1.invoke(DataSerializerPropogationDUnitTest.class, "verifyDataSerializerClassNamesMap", new Object[] { new Integer(0) });
    server1.invoke(DataSerializerPropogationDUnitTest.class, "verifyDataSerializerIDMap", new Object[] { new Integer(0) });
    server1.invoke(DataSerializerPropogationDUnitTest.class, "verifyDataSerializerSupportedClassNamesMap", new Object[] { new Integer(0) });

    server2.invoke(DataSerializerPropogationDUnitTest.class, "verifyLoadedDataSerializers", new Object[] { new Integer(1) });
    server2.invoke(DataSerializerPropogationDUnitTest.class, "verifyDataSerializerClassNamesMap", new Object[] { new Integer(0) });
    server2.invoke(DataSerializerPropogationDUnitTest.class, "verifyDataSerializerIDMap", new Object[] { new Integer(0) });
    server2.invoke(DataSerializerPropogationDUnitTest.class, "verifyDataSerializerSupportedClassNamesMap", new Object[] { new Integer(0) });

    // Verify by boolean flag in static initializer.
    server1.invoke(DataSerializerPropogationDUnitTest.class, "verifyTestDataSerializerLoaded");
    server2.invoke(DataSerializerPropogationDUnitTest.class, "verifyTestDataSerializerLoaded");
    client2.invoke(DataSerializerPropogationDUnitTest.class, "verifyTestDataSerializerNotLoaded");

    // Verify through InternalDataSerializer.getSerializers()
    server1.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(1) });
    server2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(1) });

    // Verify through InternalDataSerializer's map entries
    client2.invoke(DataSerializerPropogationDUnitTest.class, "verifyLoadedDataSerializers", new Object[] { new Integer(0) });
    client2.invoke(DataSerializerPropogationDUnitTest.class, "verifyDataSerializerClassNamesMap", new Object[] { new Integer(1) });
    client2.invoke(DataSerializerPropogationDUnitTest.class, "verifyDataSerializerIDMap", new Object[] { new Integer(1) });
    client2.invoke(DataSerializerPropogationDUnitTest.class, "verifyDataSerializerSupportedClassNamesMap", new Object[] { new Integer(3) });

    // Force TestDataSerializer to be loaded into vm by invoking InternalDataSerialier.getSerializers()
    client2.invoke(DataSerializerPropogationDUnitTest.class,
        "verifyDataSerializers", new Object[] { new Integer(1) });

    // Verify by boolean flag in static initializer.
    client2.invoke(DataSerializerPropogationDUnitTest.class, "verifyTestDataSerializerLoaded");
    // Verify through InternalDataSerializer's map entries
    client2.invoke(DataSerializerPropogationDUnitTest.class, "verifyLoadedDataSerializers", new Object[] { new Integer(1) });
    client2.invoke(DataSerializerPropogationDUnitTest.class, "verifyDataSerializerClassNamesMap", new Object[] { new Integer(0) });
    client2.invoke(DataSerializerPropogationDUnitTest.class, "verifyDataSerializerIDMap", new Object[] { new Integer(0) });
    client2.invoke(DataSerializerPropogationDUnitTest.class, "verifyDataSerializerSupportedClassNamesMap", new Object[] { new Integer(0) });
  }

  public static void verifyTestDataSerializerNotLoaded() {
    assertFalse("TestDataSerializer should not have been loaded in this vm.", successfullyLoadedTestDataSerializer);
  }

  public static void verifyTestDataSerializerLoaded() {
    assertTrue("TestDataSerializer should have been loaded in this vm.", successfullyLoadedTestDataSerializer);
  }

  public static void verifyLoadedDataSerializers(Integer expected) {
    int actual = InternalDataSerializer.getLoadedDataSerializers();
    assertTrue("Number of loaded data serializers, expected: " + expected + ", actual: " + actual, actual == expected);
  }

  public static void verifyDataSerializerClassNamesMap(Integer expected) {
    int actual = InternalDataSerializer.getDsClassesToHoldersMap().size();
    assertTrue("Number of data serializer classnames, expected: " + expected + ", actual: " + actual, actual == expected);
  }

  public static void verifyDataSerializerIDMap(Integer expected) {
    int actual = InternalDataSerializer.getIdsToHoldersMap().size();
    assertTrue("Number of ids, expected: " + expected + ", actual: " + actual, actual == expected);
  }

  public static void verifyDataSerializerSupportedClassNamesMap(Integer expected) {
    int actual = InternalDataSerializer.getSupportedClassesToHoldersMap().size();
    assertTrue("Number of supported classnames, expected: " + expected + ", actual: " + actual, actual == expected);
  }

  public static Boolean verifyResult() {
    boolean temp = testEventIDResult;
    testEventIDResult = false;
    return new Boolean(temp);
  }

  private int initServerCache(VM server, int serverNo) {
    Object[] args = new Object[] { new Integer(getMaxThreads()) };
    if (serverNo == 1) {
      return ((Integer)server.invoke(DataSerializerPropogationDUnitTest.class,
          "createServerCacheOne", args)).intValue();
    }
    else {
      return ((Integer)server.invoke(DataSerializerPropogationDUnitTest.class,
          "createServerCacheTwo", args)).intValue();
    }
  }

  /**
   * This method creates the server cache
   * 
   * @param maxThreads
   * @return
   * @throws Exception
   */
  public static Integer createServerCacheTwo(Integer maxThreads)
      throws Exception {
    new DataSerializerPropogationDUnitTest("temp")
        .createCache(new Properties());
    AttributesFactory factory = new AttributesFactory();
    factory.setScope(Scope.DISTRIBUTED_ACK);
    factory.setMirrorType(MirrorType.KEYS_VALUES);

    RegionAttributes attrs = factory.create();
    cache.createRegion(REGION_NAME, attrs);
    int port = AvailablePort.getRandomAvailablePort(AvailablePort.SOCKET);
    BridgeServer server1 = cache.addBridgeServer();
    server1.setPort(port);
    server1.setMaxThreads(maxThreads.intValue());
    server1.setNotifyBySubscription(true);
    server1.start();
    return new Integer(port);
  }

  /**
   * This method creates the server cache
   * 
   * @param maxThreads
   * @return
   * @throws Exception
   */
  public static Integer createServerCacheOne(Integer maxThreads)
      throws Exception {
    new DataSerializerPropogationDUnitTest("temp").createCache(new Properties());
    AttributesFactory factory = new AttributesFactory();
    factory.setScope(Scope.DISTRIBUTED_ACK);
    factory.setMirrorType(MirrorType.KEYS_VALUES);
    RegionAttributes attrs = factory.create();
    cache.createRegion(REGION_NAME, attrs);
    int port = AvailablePort.getRandomAvailablePort(AvailablePort.SOCKET);
    BridgeServer server1 = cache.addBridgeServer();
    server1.setPort(port);
    server1.setMaxThreads(maxThreads.intValue());
    server1.setNotifyBySubscription(true);
    server1.start();
    return new Integer(port);
  }

  public static void setBridgeObserver1() {
    PoolImpl.IS_INSTANTIATOR_CALLBACK = true;
    BridgeObserverHolder.setInstance(new BridgeObserverAdapter() {
      @Override
      public void beforeSendingToServer(EventID eventID) {
        eventId = eventID;
        client2.invoke(DataSerializerPropogationDUnitTest.class, "setEventId",
            new Object[] { eventId });

      }

    });
  }

  /**
   * sets the EventId value in the VM
   * 
   * @param eventID
   */
  public static void setEventId(EventID eventID) {
    eventId = eventID;
  }

  public static void setBridgeObserver2() {
    PoolImpl.IS_INSTANTIATOR_CALLBACK = true;
    BridgeObserverHolder.setInstance(new BridgeObserverAdapter() {
      @Override
      public void afterReceivingFromServer(EventID eventID) {
        testEventIDResult = eventID.equals(eventId);
      }

    });
  }
}

class DSObject1 extends DataSerializer {
  int tempField = 5;

  public DSObject1() {

  }

  @Override
  public int getId() {
    return 1;
  }

  @Override
  public Class[] getSupportedClasses() {
    return new Class[] { this.getClass() };
  }

  @Override
  public boolean toData(Object o, DataOutput out) throws IOException {
    out.write(tempField);
    return false;
  }

  @Override
  public Object fromData(DataInput in) throws IOException,
      ClassNotFoundException {
    readInteger(in);
    return null;
  }
}

class DSObject2 extends DataSerializer {
  int tempField = 15;

  public DSObject2() {
  }

  @Override
  public int getId() {
    return 2;
  }

  @Override
  public Class[] getSupportedClasses() {
    return new Class[] { this.getClass() };
  }

  @Override
  public boolean toData(Object o, DataOutput out) throws IOException {
    out.write(tempField);
    return false;
  }

  @Override
  public Object fromData(DataInput in) throws IOException,
      ClassNotFoundException {
    readInteger(in);
    return null;
  }
}

class DSObject3 extends DataSerializer {
  int tempField = 25;

  public DSObject3() {
  }

  @Override
  public int getId() {
    return 3;
  }

  @Override
  public Class[] getSupportedClasses() {
    return new Class[] { this.getClass() };
  }

  @Override
  public boolean toData(Object o, DataOutput out) throws IOException {
    out.write(tempField);
    return false;
  }

  @Override
  public Object fromData(DataInput in) throws IOException,
      ClassNotFoundException {
    readInteger(in);
    return null;
  }
}

class DSObject4 extends DataSerializer {
  int tempField = 5;

  public DSObject4() {

  }

  @Override
  public int getId() {
    return 4;
  }

  @Override
  public Class[] getSupportedClasses() {
    return new Class[] { this.getClass() };
  }

  @Override
  public boolean toData(Object o, DataOutput out) throws IOException {
    out.write(tempField);
    return false;
  }

  @Override
  public Object fromData(DataInput in) throws IOException,
      ClassNotFoundException {
    readInteger(in);
    return null;
  }
}

class DSObject5 extends DataSerializer {
  int tempField = 15;

  public DSObject5() {
  }

  @Override
  public int getId() {
    return 5;
  }

  @Override
  public Class[] getSupportedClasses() {
    return new Class[] { this.getClass() };
  }

  @Override
  public boolean toData(Object o, DataOutput out) throws IOException {
    out.write(tempField);
    return false;
  }

  @Override
  public Object fromData(DataInput in) throws IOException,
      ClassNotFoundException {
    readInteger(in);
    return null;
  }
}

class DSObject6 extends DataSerializer {
  int tempField = 25;

  public DSObject6() {
  }

  @Override
  public int getId() {
    return 6;
  }

  @Override
  public Class[] getSupportedClasses() {
    return new Class[] { this.getClass() };
  }

  @Override
  public boolean toData(Object o, DataOutput out) throws IOException {
    out.write(tempField);
    return false;
  }

  @Override
  public Object fromData(DataInput in) throws IOException,
      ClassNotFoundException {
    readInteger(in);
    return null;
  }
}

class DSObject7 extends DataSerializer {
  int tempField = 5;

  public DSObject7() {

  }

  @Override
  public int getId() {
    return 7;
  }

  @Override
  public Class[] getSupportedClasses() {
    return new Class[] { this.getClass() };
  }

  @Override
  public boolean toData(Object o, DataOutput out) throws IOException {
    out.write(tempField);
    return false;
  }

  @Override
  public Object fromData(DataInput in) throws IOException,
      ClassNotFoundException {
    readInteger(in);
    return null;
  }
}

class DSObject8 extends DataSerializer {
  int tempField = 15;

  public DSObject8() {
  }

  @Override
  public int getId() {
    return 8;
  }

  @Override
  public Class[] getSupportedClasses() {
    return new Class[] { this.getClass() };
  }

  @Override
  public boolean toData(Object o, DataOutput out) throws IOException {
    out.write(tempField);
    return false;
  }

  @Override
  public Object fromData(DataInput in) throws IOException,
      ClassNotFoundException {
    readInteger(in);
    return null;
  }
}

class DSObject9 extends DataSerializer {
  int tempField = 25;

  public DSObject9() {
  }

  @Override
  public int getId() {
    return 9;
  }

  @Override
  public Class[] getSupportedClasses() {
    return new Class[] { this.getClass() };
  }

  @Override
  public boolean toData(Object o, DataOutput out) throws IOException {
    out.write(tempField);
    return false;
  }

  @Override
  public Object fromData(DataInput in) throws IOException,
      ClassNotFoundException {
    readInteger(in);
    return null;
  }
}

class DSObject10 extends DataSerializer {
  int tempField = 5;

  public DSObject10() {

  }

  @Override
  public int getId() {
    return 10;
  }

  @Override
  public Class[] getSupportedClasses() {
    return new Class[] { this.getClass() };
  }

  @Override
  public boolean toData(Object o, DataOutput out) throws IOException {
    out.write(tempField);
    return false;
  }

  @Override
  public Object fromData(DataInput in) throws IOException,
      ClassNotFoundException {
    readInteger(in);
    return null;
  }
}

class DSObject11 extends DataSerializer {
  int tempField = 15;

  public DSObject11() {
  }

  @Override
  public int getId() {
    return 11;
  }

  @Override
  public Class[] getSupportedClasses() {
    return new Class[] { this.getClass() };
  }

  @Override
  public boolean toData(Object o, DataOutput out) throws IOException {
    out.write(tempField);
    return false;
  }

  @Override
  public Object fromData(DataInput in) throws IOException,
      ClassNotFoundException {
    readInteger(in);
    return null;
  }
}

class DSObject12 extends DataSerializer {
  int tempField = 25;

  public DSObject12() {
  }

  @Override
  public int getId() {
    return 12;
  }

  @Override
  public Class[] getSupportedClasses() {
    return new Class[] { this.getClass() };
  }

  @Override
  public boolean toData(Object o, DataOutput out) throws IOException {
    out.write(tempField);
    return false;
  }

  @Override
  public Object fromData(DataInput in) throws IOException,
      ClassNotFoundException {
    readInteger(in);
    return null;
  }
}

class DSObject13 extends DataSerializer {
  int tempField = 25;

  public DSObject13() {
  }

  @Override
  public int getId() {
    return 19;
  }

  @Override
  public Class[] getSupportedClasses() {
    return new Class[] { this.getClass() };
  }

  @Override
  public boolean toData(Object o, DataOutput out) throws IOException {
    out.write(tempField);
    return false;
  }

  @Override
  public Object fromData(DataInput in) throws IOException,
      ClassNotFoundException {
    readInteger(in);
    return null;
  }
}

class Bogus {
}

/**
 * This data serializer can be created locally but remote guys who call
 * the default constructor will fail.
 * @author darrel
 *
 */
class DSObjectLocalOnly extends DataSerializer {
  int tempField;

  public DSObjectLocalOnly(int v) {
    this.tempField = v;
  }
  
  public DSObjectLocalOnly() {
    Boolean b = DataSerializerPropogationDUnitTest.allowNonLocalTL.get();
    if (b == null || !b.booleanValue()) {
      throw new UnsupportedOperationException("DSObjectLocalOnly can not be deserialized");
    }
  }

  @Override
  public int getId() {
    return 20;
  }

  @Override
  public Class[] getSupportedClasses() {
    return new Class[] { Bogus.class };
  }

  @Override
  public boolean toData(Object o, DataOutput out) throws IOException {
    throw new RuntimeException("Did not expect toData to be called");
  }

  @Override
  public Object fromData(DataInput in) throws IOException,
      ClassNotFoundException {
    throw new RuntimeException("Did not expect fromData to be called");
  }
}