1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-09-10 01:29:38 +02:00

Rename 'Packet' class to 'Stanza'

Smack still uses the term 'Packet' in some places. This is just the
first step towards using correct XMPP terms in Smack.
This commit is contained in:
Florian Schmaus 2015-02-05 11:17:27 +01:00
parent 9fc26f1d83
commit 4698805a34
142 changed files with 595 additions and 572 deletions

View file

@ -24,7 +24,7 @@ import java.util.concurrent.BlockingQueue;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.TimeUnit;
import org.jivesoftware.smack.packet.Packet;
import org.jivesoftware.smack.packet.Stanza;
import org.jivesoftware.smack.packet.PlainStreamElement;
import org.jivesoftware.smack.packet.TopLevelStreamElement;
@ -33,12 +33,12 @@ import org.jivesoftware.smack.packet.TopLevelStreamElement;
* unit tests.
*
* Instances store any packets that are delivered to be send using the
* {@link #sendPacket(Packet)} method in a blocking queue. The content of this queue
* {@link #sendPacket(Stanza)} method in a blocking queue. The content of this queue
* can be inspected using {@link #getSentPacket()}. Typically these queues are
* used to retrieve a message that was generated by the client.
*
* Packets that should be processed by the client to simulate a received stanza
* can be delivered using the {@linkplain #processPacket(Packet)} method.
* can be delivered using the {@linkplain #processPacket(Stanza)} method.
* It invokes the registered packet interceptors and listeners.
*
* @see XMPPConnection
@ -132,7 +132,7 @@ public class DummyConnection extends AbstractXMPPConnection {
}
@Override
protected void sendPacketInternal(Packet packet) {
protected void sendPacketInternal(Stanza packet) {
if (SmackConfiguration.DEBUG) {
System.out.println("[SEND]: " + packet.toXML());
}
@ -140,7 +140,7 @@ public class DummyConnection extends AbstractXMPPConnection {
}
/**
* Returns the number of packets that's sent through {@link #sendPacket(Packet)} and
* Returns the number of packets that's sent through {@link #sendPacket(Stanza)} and
* that has not been returned by {@link #getSentPacket()}.
*
* @return the number of packets which are in the queue.
@ -150,7 +150,7 @@ public class DummyConnection extends AbstractXMPPConnection {
}
/**
* Returns the first packet that's sent through {@link #sendPacket(Packet)}
* Returns the first packet that's sent through {@link #sendPacket(Stanza)}
* and that has not been returned by earlier calls to this method.
*
* @return a sent packet.
@ -160,7 +160,7 @@ public class DummyConnection extends AbstractXMPPConnection {
}
/**
* Returns the first packet that's sent through {@link #sendPacket(Packet)}
* Returns the first packet that's sent through {@link #sendPacket(Stanza)}
* and that has not been returned by earlier calls to this method. This
* method will block for up to the specified number of seconds if no packets
* have been sent yet.
@ -184,7 +184,7 @@ public class DummyConnection extends AbstractXMPPConnection {
*
* @param packet the packet to process.
*/
public void processPacket(Packet packet) {
public void processPacket(Stanza packet) {
if (SmackConfiguration.DEBUG) {
System.out.println("[RECV]: " + packet.toXML());
}

View file

@ -20,7 +20,7 @@ import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import org.jivesoftware.smack.filter.PacketFilter;
import org.jivesoftware.smack.packet.Packet;
import org.jivesoftware.smack.packet.Stanza;
import org.junit.Test;
public class PacketCollectorTest
@ -33,29 +33,29 @@ public class PacketCollectorTest
for (int i=0; i<6; i++)
{
Packet testPacket = new TestPacket(i);
Stanza testPacket = new TestPacket(i);
collector.processPacket(testPacket);
}
// Assert that '0' has rolled off
assertEquals("1", collector.nextResultBlockForever().getPacketID());
assertEquals("2", collector.nextResultBlockForever().getPacketID());
assertEquals("3", collector.nextResultBlockForever().getPacketID());
assertEquals("4", collector.nextResultBlockForever().getPacketID());
assertEquals("5", collector.pollResult().getPacketID());
assertEquals("1", collector.nextResultBlockForever().getStanzaId());
assertEquals("2", collector.nextResultBlockForever().getStanzaId());
assertEquals("3", collector.nextResultBlockForever().getStanzaId());
assertEquals("4", collector.nextResultBlockForever().getStanzaId());
assertEquals("5", collector.pollResult().getStanzaId());
assertNull(collector.pollResult());
for (int i=10; i<15; i++)
{
Packet testPacket = new TestPacket(i);
Stanza testPacket = new TestPacket(i);
collector.processPacket(testPacket);
}
assertEquals("10", collector.nextResultBlockForever().getPacketID());
assertEquals("11", collector.nextResultBlockForever().getPacketID());
assertEquals("12", collector.nextResultBlockForever().getPacketID());
assertEquals("13", collector.nextResultBlockForever().getPacketID());
assertEquals("14", collector.pollResult().getPacketID());
assertEquals("10", collector.nextResultBlockForever().getStanzaId());
assertEquals("11", collector.nextResultBlockForever().getStanzaId());
assertEquals("12", collector.nextResultBlockForever().getStanzaId());
assertEquals("13", collector.nextResultBlockForever().getStanzaId());
assertEquals("14", collector.pollResult().getStanzaId());
assertNull(collector.pollResult());
assertNull(collector.nextResult(1000));
@ -88,7 +88,7 @@ public class PacketCollectorTest
{
}
@SuppressWarnings("unused")
Packet packet = collector.nextResultBlockForever();
Stanza packet = collector.nextResultBlockForever();
// System.out.println(Thread.currentThread().getName() + " packet: " + packet);
}
}
@ -108,7 +108,7 @@ public class PacketCollectorTest
@Override
public void run()
{
Packet p = null;
Stanza p = null;
do
{
@ -132,7 +132,7 @@ public class PacketCollectorTest
@Override
public void run()
{
Packet p = null;
Stanza p = null;
do
{
@ -178,7 +178,7 @@ public class PacketCollectorTest
class OKEverything implements PacketFilter
{
@Override
public boolean accept(Packet packet)
public boolean accept(Stanza packet)
{
return true;
}
@ -193,17 +193,17 @@ public class PacketCollectorTest
}
}
class TestPacket extends Packet
class TestPacket extends Stanza
{
public TestPacket(int i)
{
setPacketID(String.valueOf(i));
setStanzaId(String.valueOf(i));
}
@Override
public String toXML()
{
return "<packetId>" + getPacketID() + "</packetId>";
return "<packetId>" + getStanzaId() + "</packetId>";
}
}
}

View file

@ -29,11 +29,11 @@ public class StanzaIdTest {
@Test
public void testIqId() {
IQ iq1 = new TestIQ();
String iq1Id = iq1.getPacketID();
String iq1Id = iq1.getStanzaId();
assertTrue(StringUtils.isNotEmpty(iq1Id));
IQ iq2 = new TestIQ();
String iq2Id = iq2.getPacketID();
String iq2Id = iq2.getStanzaId();
assertTrue(StringUtils.isNotEmpty(iq2Id));
assertFalse(iq1Id.equals(iq2Id));

View file

@ -24,7 +24,7 @@ import java.util.concurrent.LinkedBlockingQueue;
import org.jivesoftware.smack.SmackException.NotConnectedException;
import org.jivesoftware.smack.packet.IQ;
import org.jivesoftware.smack.packet.Message;
import org.jivesoftware.smack.packet.Packet;
import org.jivesoftware.smack.packet.Stanza;
import org.jivesoftware.smack.packet.IQ.Type;
/**
@ -34,11 +34,11 @@ import org.jivesoftware.smack.packet.IQ.Type;
*/
public class ThreadedDummyConnection extends DummyConnection {
private BlockingQueue<IQ> replyQ = new ArrayBlockingQueue<IQ>(1);
private BlockingQueue<Packet> messageQ = new LinkedBlockingQueue<Packet>(5);
private BlockingQueue<Stanza> messageQ = new LinkedBlockingQueue<Stanza>(5);
private volatile boolean timeout = false;
@Override
public void sendPacket(Packet packet) throws NotConnectedException {
public void sendPacket(Stanza packet) throws NotConnectedException {
super.sendPacket(packet);
if (packet instanceof IQ && !timeout) {
@ -52,7 +52,7 @@ public class ThreadedDummyConnection extends DummyConnection {
replyPacket = IQ.createResultIQ((IQ) packet);
replyQ.add(replyPacket);
}
replyPacket.setPacketID(packet.getPacketID());
replyPacket.setStanzaId(packet.getStanzaId());
replyPacket.setFrom(packet.getTo());
replyPacket.setTo(packet.getFrom());
replyPacket.setType(Type.result);
@ -64,7 +64,7 @@ public class ThreadedDummyConnection extends DummyConnection {
/**
* Calling this method will cause the next sendPacket call with an IQ packet to timeout.
* This is accomplished by simply stopping the auto creating of the reply packet
* or processing one that was entered via {@link #processPacket(Packet)}.
* or processing one that was entered via {@link #processPacket(Stanza)}.
*/
public void setTimeout() {
timeout = true;
@ -86,9 +86,9 @@ public class ThreadedDummyConnection extends DummyConnection {
}
class ProcessQueue extends Thread {
private BlockingQueue<? extends Packet> processQ;
private BlockingQueue<? extends Stanza> processQ;
ProcessQueue(BlockingQueue<? extends Packet> queue) {
ProcessQueue(BlockingQueue<? extends Stanza> queue) {
processQ = queue;
}

View file

@ -20,7 +20,7 @@ import static org.junit.Assert.assertTrue;
import static org.junit.Assert.assertFalse;
import org.jivesoftware.smack.filter.FromMatchesFilter;
import org.jivesoftware.smack.packet.Packet;
import org.jivesoftware.smack.packet.Stanza;
import org.junit.Test;
/**
@ -44,7 +44,7 @@ public class FromMatchesFilterTest {
public void autoCompareMatchingFullJid()
{
FromMatchesFilter filter = FromMatchesFilter.create(FULL_JID1_R1);
Packet packet = new Packet() {
Stanza packet = new Stanza() {
@Override
public String toXML() { return null; }
};
@ -72,7 +72,7 @@ public class FromMatchesFilterTest {
public void autoCompareMatchingBaseJid()
{
FromMatchesFilter filter = FromMatchesFilter.create(BASE_JID1);
Packet packet = new Packet() {
Stanza packet = new Stanza() {
@Override
public String toXML() { return null; }
};
@ -100,7 +100,7 @@ public class FromMatchesFilterTest {
public void autoCompareMatchingServiceJid()
{
FromMatchesFilter filter = FromMatchesFilter.create(SERVICE_JID1);
Packet packet = new Packet() {
Stanza packet = new Stanza() {
@Override
public String toXML() { return null; }
};
@ -125,7 +125,7 @@ public class FromMatchesFilterTest {
public void bareCompareMatchingFullJid()
{
FromMatchesFilter filter = FromMatchesFilter.createBare(FULL_JID1_R1);
Packet packet = new Packet() {
Stanza packet = new Stanza() {
@Override
public String toXML() { return null; }
};
@ -153,7 +153,7 @@ public class FromMatchesFilterTest {
public void bareCompareMatchingBaseJid()
{
FromMatchesFilter filter = FromMatchesFilter.createBare(BASE_JID1);
Packet packet = new Packet() {
Stanza packet = new Stanza() {
@Override
public String toXML() { return null; }
};
@ -181,7 +181,7 @@ public class FromMatchesFilterTest {
public void bareCompareMatchingServiceJid()
{
FromMatchesFilter filter = FromMatchesFilter.createBare(SERVICE_JID1);
Packet packet = new Packet() {
Stanza packet = new Stanza() {
@Override
public String toXML() { return null; }
};
@ -206,7 +206,7 @@ public class FromMatchesFilterTest {
public void fullCompareMatchingFullJid()
{
FromMatchesFilter filter = FromMatchesFilter.createFull(FULL_JID1_R1);
Packet packet = new Packet() {
Stanza packet = new Stanza() {
@Override
public String toXML() { return null; }
};
@ -234,7 +234,7 @@ public class FromMatchesFilterTest {
public void fullCompareMatchingBaseJid()
{
FromMatchesFilter filter = FromMatchesFilter.createFull(BASE_JID1);
Packet packet = new Packet() {
Stanza packet = new Stanza() {
@Override
public String toXML() { return null; }
};
@ -262,7 +262,7 @@ public class FromMatchesFilterTest {
public void fullCompareMatchingServiceJid()
{
FromMatchesFilter filter = FromMatchesFilter.createFull(SERVICE_JID1);
Packet packet = new Packet() {
Stanza packet = new Stanza() {
@Override
public String toXML() { return null; }
};

View file

@ -46,8 +46,8 @@ public class IQResponseTest {
final IQ result = IQ.createResultIQ(request);
assertEquals(IQ.Type.result, result.getType());
assertNotNull(result.getPacketID());
assertEquals(request.getPacketID(), result.getPacketID());
assertNotNull(result.getStanzaId());
assertEquals(request.getStanzaId(), result.getStanzaId());
assertEquals(request.getFrom(), result.getTo());
assertEquals(request.getTo(), result.getFrom());
assertEquals("", result.getChildElementXML().toString());
@ -68,8 +68,8 @@ public class IQResponseTest {
final IQ result = IQ.createErrorResponse(request, error);
assertEquals(IQ.Type.error, result.getType());
assertNotNull(result.getPacketID());
assertEquals(request.getPacketID(), result.getPacketID());
assertNotNull(result.getStanzaId());
assertEquals(request.getStanzaId(), result.getStanzaId());
assertEquals(request.getFrom(), result.getTo());
assertEquals(error, result.getError());
// TODO this test was never valid

View file

@ -51,7 +51,7 @@ public class MessageTest {
String control = controlBuilder.toString();
Message messageTypeInConstructor = new Message(null, Message.Type.chat);
messageTypeInConstructor.setPacketID(null);
messageTypeInConstructor.setStanzaId(null);
assertEquals(type, messageTypeInConstructor.getType());
assertXMLEqual(control, messageTypeInConstructor.toXML().toString());
@ -210,7 +210,7 @@ public class MessageTest {
private static Message getNewMessage() {
Message message = new Message();
message.setPacketID(null);
message.setStanzaId(null);
return message;
}
}

View file

@ -47,7 +47,7 @@ public class PresenceTest {
String control = controlBuilder.toString();
Presence presenceTypeInConstructor = new Presence(type);
presenceTypeInConstructor.setPacketID(null);
presenceTypeInConstructor.setStanzaId(null);
assertEquals(type, presenceTypeInConstructor.getType());
assertXMLEqual(control, presenceTypeInConstructor.toXML().toString());
@ -146,7 +146,7 @@ public class PresenceTest {
Presence presenceModeInConstructor = new Presence(Presence.Type.available, status, priority,
mode1);
presenceModeInConstructor.setPacketID(null);
presenceModeInConstructor.setStanzaId(null);
assertEquals(mode1, presenceModeInConstructor.getMode());
assertXMLEqual(control, presenceModeInConstructor.toXML().toString());
@ -194,7 +194,7 @@ public class PresenceTest {
private static Presence getNewPresence() {
Presence presence = new Presence(Presence.Type.available);
presence.setPacketID(null);
presence.setStanzaId(null);
return presence;
}
}

View file

@ -21,14 +21,14 @@ import java.util.concurrent.TimeUnit;
import org.jivesoftware.smack.PacketListener;
import org.jivesoftware.smack.SmackException.NotConnectedException;
import org.jivesoftware.smack.packet.Packet;
import org.jivesoftware.smack.packet.Stanza;
public class WaitForPacketListener implements PacketListener {
private CountDownLatch latch = new CountDownLatch(1);
@Override
public void processPacket(Packet packet) throws NotConnectedException {
public void processPacket(Stanza packet) throws NotConnectedException {
reportInvoked();
}

View file

@ -33,7 +33,7 @@ import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.TransformerException;
import org.jivesoftware.smack.packet.Message;
import org.jivesoftware.smack.packet.Packet;
import org.jivesoftware.smack.packet.Stanza;
import org.jivesoftware.smack.packet.Presence;
import org.jivesoftware.smack.sasl.SASLError;
import org.jivesoftware.smack.sasl.packet.SaslStreamElements;
@ -59,7 +59,7 @@ public class PacketParserUtilsTest {
@Test
public void singleMessageBodyTest() throws Exception {
String defaultLanguage = Packet.getDefaultLanguage();
String defaultLanguage = Stanza.getDefaultLanguage();
String otherLanguage = determineNonDefaultLanguage();
String control;
@ -208,7 +208,7 @@ public class PacketParserUtilsTest {
@Test
public void singleMessageSubjectTest() throws Exception {
String defaultLanguage = Packet.getDefaultLanguage();
String defaultLanguage = Stanza.getDefaultLanguage();
String otherLanguage = determineNonDefaultLanguage();
String control;
@ -357,7 +357,7 @@ public class PacketParserUtilsTest {
@Test
public void multipleMessageBodiesTest() throws Exception {
String defaultLanguage = Packet.getDefaultLanguage();
String defaultLanguage = Stanza.getDefaultLanguage();
String otherLanguage = determineNonDefaultLanguage();
String control;
@ -510,7 +510,7 @@ public class PacketParserUtilsTest {
@Test
public void multipleMessageSubjectsTest() throws Exception {
String defaultLanguage = Packet.getDefaultLanguage();
String defaultLanguage = Stanza.getDefaultLanguage();
String otherLanguage = determineNonDefaultLanguage();
String control;
@ -748,7 +748,7 @@ public class PacketParserUtilsTest {
.t("This is a test of the emergency broadcast system, 3.")
.asString(outputProperties);
Packet message = PacketParserUtils.parseStanza(control);
Stanza message = PacketParserUtils.parseStanza(control);
XmlUnitUtils.assertSimilar(control, message.toXML());
}