/*------------------------------------------------------------------------------
Name: TestSub.java
Project: xmlBlaster.org
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
Comment: Demo code for a client using xmlBlaster
Version: $Id: TestSub.java 14833 2006-03-06 21:38:58Z laghi $
------------------------------------------------------------------------------*/
package org.xmlBlaster.test.qos;
import java.util.logging.Logger;
import java.util.logging.Level;
import org.xmlBlaster.util.Global;
import org.xmlBlaster.util.XmlBlasterException;
import org.xmlBlaster.client.qos.ConnectQos;
import org.xmlBlaster.util.Timestamp;
import org.xmlBlaster.client.I_XmlBlasterAccess;
import org.xmlBlaster.client.I_Callback;
import org.xmlBlaster.client.key.UpdateKey;
import org.xmlBlaster.client.qos.UpdateQos;
import org.xmlBlaster.client.qos.PublishReturnQos;
import org.xmlBlaster.client.qos.SubscribeReturnQos;
import org.xmlBlaster.client.qos.EraseReturnQos;
import org.xmlBlaster.util.MsgUnit;
import org.xmlBlaster.util.qos.address.CallbackAddress;
import junit.framework.*;
/**
* This client tests the method subscribe() with a later publish() with XPath query.
* <br />
* The subscribe() should be recognized for this later arriving publish()
* <p>
* This client may be invoked multiple time on the same xmlBlaster server,
* as it cleans up everything after his tests are done.
* <p>
* Invoke examples:<br />
* <pre>
* java junit.textui.TestRunner org.xmlBlaster.test.qos.TestSub
* java junit.swingui.TestRunner org.xmlBlaster.test.qos.TestSub
* </pre>
*/
public class TestSub extends TestCase implements I_Callback
{
private static String ME = "TestSub";
private final Global glob;
private static Logger log = Logger.getLogger(TestSub.class.getName());
private boolean messageArrived = false;
private String subscribeOid;
private String publishOid = "dummyTestSub";
private I_XmlBlasterAccess senderConnection;
private String senderName;
private String senderContent;
private String receiverName; // sender/receiver is here the same client
private Timestamp sentTimestamp;
private String cbSessionId = "0fxrc83plP";
private int numReceived = 0; // error checking
private final String contentMime = "text/xml";
private final String contentMimeExtended = "1.0";
private UpdateQos updateQos = null;
/**
* Constructs the TestSub object.
* <p />
* @param testName The name used in the test suite
* @param loginName The name to login to the xmlBlaster
*/
public TestSub(Global glob, String testName, String loginName)
{
super(testName);
this.glob = glob;
this.senderName = loginName;
this.receiverName = loginName;
}
/**
* Sets up the fixture.
* <p />
* Connect to xmlBlaster and login
*/
protected void setUp()
{
try {
senderConnection = glob.getXmlBlasterAccess(); // Find orb
String passwd = "secret";
ConnectQos qos = new ConnectQos(glob, senderName, passwd);
if (log.isLoggable(Level.FINE))
log.fine("the connect qos is: " + qos.toXml());
CallbackAddress cbAddress = new CallbackAddress(this.glob);
cbAddress.setSecretSessionId(cbSessionId); // to protect our callback server - see method update()
qos.addCallbackAddress(cbAddress);
senderConnection.connect(qos, this); // Login to xmlBlaster
}
catch (Exception e) {
log.severe("Login failed: " + e.toString());
e.printStackTrace();
assertTrue("Login failed: " + e.toString(), false);
}
}
/**
* Tears down the fixture.
* <p />
* cleaning up .... erase() the previous message OID and logout
*/
protected void tearDown()
{
String xmlKey = "<?xml version='1.0' encoding='ISO-8859-1' ?>\n" +
"<key oid='" + publishOid + "' queryType='EXACT'>\n" +
"</key>";
String qos = "<qos></qos>";
try {
EraseReturnQos[] arr = senderConnection.erase(xmlKey, qos);
assertEquals("Erase", 1, arr.length);
} catch(XmlBlasterException e) { fail("Erase XmlBlasterException: " + e.getMessage()); }
senderConnection.disconnect(null);
}
/**
* TEST: Subscribe to messages with XPATH.
* <p />
* The returned subscribeOid is checked
*/
public void testSubscribeXPath()
{
if (log.isLoggable(Level.FINE)) log.fine("Subscribing using XPath syntax ...");
String xmlKey = "<?xml version='1.0' encoding='ISO-8859-1' ?>\n" +
"<key oid='' queryType='XPATH'>\n" +
" //TestSub-AGENT" +
"</key>";
numReceived = 0;
subscribeOid = null;
try {
SubscribeReturnQos subscribeReturnQos = senderConnection.subscribe(xmlKey, null);
subscribeOid = subscribeReturnQos.getSubscriptionId();
log.info("Success: Subscribe subscription-id=" + subscribeOid + " done: " + subscribeReturnQos.toXml());
} catch(XmlBlasterException e) {
log.warning("XmlBlasterException: " + e.getMessage());
assertTrue("subscribe - XmlBlasterException: " + e.getMessage(), false);
}
assertTrue("returned null subscribeOid", subscribeOid != null);
assertTrue("returned subscribeOid is empty", 0 != subscribeOid.length());
}
/**
* TEST: Construct a message and publish it.
* <p />
* The returned publishOid is checked
*/
public void testPublish()
{
if (log.isLoggable(Level.FINE)) log.fine("Publishing a message ...");
numReceived = 0;
String xmlKey = "<?xml version='1.0' encoding='ISO-8859-1' ?>\n" +
"<key oid='" + publishOid + "' contentMime='" + contentMime + "' contentMimeExtended='" + contentMimeExtended + "'>\n" +
" <TestSub-AGENT id='192.168.124.10' subId='1' type='generic'>" +
" <TestSub-DRIVER id='FileProof' pollingFreq='10'>" +
" </TestSub-DRIVER>"+
" </TestSub-AGENT>" +
"</key>";
senderContent = "Yeahh, i'm the new content";
try {
MsgUnit msgUnit = new MsgUnit(xmlKey, senderContent.getBytes(), "<qos></qos>");
sentTimestamp = new Timestamp();
PublishReturnQos tmp = senderConnection.publish(msgUnit);
assertEquals("Wrong publishOid", publishOid, tmp.getKeyOid());
log.info("Success: Publishing done, returned oid=" + publishOid);
} catch(XmlBlasterException e) {
log.warning("XmlBlasterException: " + e.getMessage());
assertTrue("publish - XmlBlasterException: " + e.getMessage(), false);
}
}
/**
* TEST: Construct a message and publish it,<br />
* the previous XPath subscription should match and send an update.
*/
public void testPublishAfterSubscribeXPath()
{
testSubscribeXPath();
try { Thread.sleep(1000L); } catch( InterruptedException i) {} // Wait some time for callback to arrive ...
assertEquals("numReceived after subscribe", 0, numReceived); // there should be no Callback
testPublish();
waitOnUpdate(5000L);
assertEquals("numReceived after publishing", 1, numReceived); // message arrived?
}
/**
* This is the callback method invoked from xmlBlaster
* delivering us a new asynchronous message.
* @see org.xmlBlaster.client.I_Callback#update(String, UpdateKey, byte[], UpdateQos)
*/
public String update(String cbSessionId_, UpdateKey updateKey, byte[] content, UpdateQos updateQos)
{
log.info("Receiving update of message oid=" + updateKey.getOid() + "...");
log.info("subscribeOid=" + subscribeOid + ":" + updateQos.toXml());
numReceived += 1;
if (updateQos.isErased()) {
return "";
}
// wait that the subscribe() has returned as well
for (int ii=0; ii<5; ii++) {
if (subscribeOid != null)
break;
try { Thread.sleep(1000L); } catch( InterruptedException i) {}
log.info("waiting ...");
}
assertEquals("Wrong cbSessionId", this.cbSessionId, cbSessionId_);
assertEquals("Wrong sender", senderName, updateQos.getSender().getLoginName());
assertEquals("engine.qos.update.subscriptionId: Wrong subscriptionId", subscribeOid, updateQos.getSubscriptionId());
assertEquals("Wrong oid of message returned", publishOid, updateKey.getOid());
assertEquals("Message content is corrupted", new String(senderContent), new String(content));
assertEquals("Message contentMime is corrupted", contentMime, updateKey.getContentMime());
assertEquals("Message contentMimeExtended is corrupted", contentMimeExtended, updateKey.getContentMimeExtended());
// Test requirement "engine.qos.update.rcvTimestamp":
assertTrue("sentTimestamp="+sentTimestamp+" not in hamony with rcvTimestamp="+updateQos.getRcvTimestamp(),
sentTimestamp.getMillis() < updateQos.getRcvTimestamp().getMillis() &&
(sentTimestamp.getMillis()+1000) > updateQos.getRcvTimestamp().getMillis());
messageArrived = true;
return "";
}
/**
* Little helper, waits until the variable 'messageArrive' is set
* to true, or returns when the given timeout occurs.
* @param timeout in milliseconds
*/
private void waitOnUpdate(final long timeout)
{
long pollingInterval = 50L; // check every 0.05 seconds
if (timeout < 50) pollingInterval = timeout / 10L;
long sum = 0L;
while (!messageArrived) {
try {
Thread.sleep(pollingInterval);
}
catch( InterruptedException i)
{}
sum += pollingInterval;
if (sum > timeout) {
log.warning("Timeout of " + timeout + " occurred");
break;
}
}
messageArrived = false;
}
/**
* Method is used by TestRunner to load these tests
*/
public static Test suite()
{
TestSuite suite= new TestSuite();
String loginName = "Tim";
suite.addTest(new TestSub(new Global(), "testPublishAfterSubscribeXPath", loginName));
return suite;
}
/**
* Invoke: java org.xmlBlaster.test.qos.TestSub
* @deprecated Use the TestRunner from the testsuite to run it:<p />
* <pre> java -Djava.compiler= junit.textui.TestRunner org.xmlBlaster.test.qos.TestSub</pre>
*/
public static void main(String args[])
{
Global glob = new Global();
if (glob.init(args) != 0) {
System.err.println(ME + ": Init failed");
System.exit(1);
}
TestSub testSub = new TestSub(glob, "TestSub", "Tim");
testSub.setUp();
testSub.testPublishAfterSubscribeXPath();
testSub.tearDown();
}
}