1
0
Fork 0
mirror of https://codeberg.org/Mercury-IM/Smack synced 2025-09-09 18:29:45 +02:00

Make ExtensionElement marker interface wrt. QNAME field

ExtensionElement is now a marker interface that requires all
implementation non-abstract classes to carry a static final QNAME
field (of type QName). This is verified by a new unit test.

Also FullyQualifiedElement is renamed to simply XmlElement. XmlElement
is used over ExtensionElement when implementing classes do not
statically know the qualified name of the XML elements they
represent. In general, XmlElement should be used sparingly, and every
XML element should be modeled by its own Java class (implementing
ExtensionElement).
This commit is contained in:
Florian Schmaus 2021-04-18 18:58:50 +02:00
parent 5493a22e44
commit 3d4e7938a7
146 changed files with 600 additions and 344 deletions

View file

@ -20,6 +20,8 @@ package org.jivesoftware.smackx.workgroup;
import java.util.List;
import java.util.Map;
import javax.xml.namespace.QName;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smackx.workgroup.util.MetaDataUtils;
@ -39,6 +41,8 @@ public class MetaData implements ExtensionElement {
*/
public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup";
public static final QName QNAME = new QName(NAMESPACE, ELEMENT_NAME);
private final Map<String, List<String>> metaData;
public MetaData(Map<String, List<String>> metaData) {

View file

@ -26,6 +26,8 @@ import java.util.Iterator;
import java.util.List;
import java.util.TimeZone;
import javax.xml.namespace.QName;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.provider.ExtensionElementProvider;
@ -59,6 +61,8 @@ public class AgentStatus implements ExtensionElement {
*/
public static final String NAMESPACE = "http://jabber.org/protocol/workgroup";
public static final QName QNAME = new QName(NAMESPACE, ELEMENT_NAME);
private EntityBareJid workgroupJID;
private final List<ChatInfo> currentChats = new ArrayList<>();
private int maxChats = -1;

View file

@ -26,6 +26,8 @@ import java.util.Iterator;
import java.util.Set;
import java.util.logging.Logger;
import javax.xml.namespace.QName;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.provider.ExtensionElementProvider;
@ -50,6 +52,7 @@ public final class QueueDetails implements ExtensionElement {
* Namespace of the stanza extension.
*/
public static final String NAMESPACE = "http://jabber.org/protocol/workgroup";
public static final QName QNAME = new QName(NAMESPACE, ELEMENT_NAME);
private static final String DATE_FORMAT = "yyyyMMdd'T'HH:mm:ss";

View file

@ -22,6 +22,8 @@ import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import javax.xml.namespace.QName;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.provider.ExtensionElementProvider;
@ -41,6 +43,7 @@ public class QueueOverview implements ExtensionElement {
* Namespace of the stanza extension.
*/
public static String NAMESPACE = "http://jabber.org/protocol/workgroup";
public static final QName QNAME = new QName(NAMESPACE, ELEMENT_NAME);
private static final String DATE_FORMAT = "yyyyMMdd'T'HH:mm:ss";
private final SimpleDateFormat dateFormat = new SimpleDateFormat(DATE_FORMAT);

View file

@ -19,6 +19,8 @@ package org.jivesoftware.smackx.workgroup.packet;
import java.io.IOException;
import javax.xml.namespace.QName;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.provider.ExtensionElementProvider;
@ -42,6 +44,8 @@ public class QueueUpdate implements ExtensionElement {
*/
public static final String NAMESPACE = "http://jabber.org/protocol/workgroup";
public static final QName QNAME = new QName(NAMESPACE, ELEMENT_NAME);
private final int position;
private final int remainingTime;

View file

@ -19,6 +19,8 @@ package org.jivesoftware.smackx.workgroup.packet;
import java.io.IOException;
import javax.xml.namespace.QName;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.IQ;
import org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder;
@ -50,6 +52,8 @@ public class RoomInvitation implements ExtensionElement {
*/
public static final String NAMESPACE = "http://jabber.org/protocol/workgroup";
public static final QName QNAME = new QName(NAMESPACE, ELEMENT_NAME);
/**
* Type of entity being invited to a groupchat support session.
*/

View file

@ -19,6 +19,8 @@ package org.jivesoftware.smackx.workgroup.packet;
import java.io.IOException;
import javax.xml.namespace.QName;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.IQ;
import org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder;
@ -45,6 +47,8 @@ public class RoomTransfer implements ExtensionElement {
*/
public static final String NAMESPACE = "http://jabber.org/protocol/workgroup";
public static final QName QNAME = new QName(NAMESPACE, ELEMENT_NAME);
/**
* Type of entity being invited to a groupchat support session.
*/

View file

@ -19,6 +19,8 @@ package org.jivesoftware.smackx.workgroup.packet;
import java.io.IOException;
import javax.xml.namespace.QName;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.provider.ExtensionElementProvider;
@ -37,6 +39,8 @@ public class SessionID implements ExtensionElement {
*/
public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup";
public static final QName QNAME = new QName(NAMESPACE, ELEMENT_NAME);
private final String sessionID;
public SessionID(String sessionID) {

View file

@ -19,6 +19,8 @@ package org.jivesoftware.smackx.workgroup.packet;
import java.io.IOException;
import javax.xml.namespace.QName;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.provider.ExtensionElementProvider;
@ -40,6 +42,8 @@ public class UserID implements ExtensionElement {
*/
public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup";
public static final QName QNAME = new QName(NAMESPACE, ELEMENT_NAME);
private final Jid userID;
public UserID(Jid userID) {

View file

@ -19,6 +19,8 @@ package org.jivesoftware.smackx.workgroup.packet;
import java.io.IOException;
import javax.xml.namespace.QName;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.XmlEnvironment;
import org.jivesoftware.smack.provider.ExtensionElementProvider;
@ -44,6 +46,8 @@ public class WorkgroupInformation implements ExtensionElement {
*/
public static final String NAMESPACE = "http://jabber.org/protocol/workgroup";
public static final QName QNAME = new QName(NAMESPACE, ELEMENT_NAME);
private final EntityBareJid workgroupJID;
public WorkgroupInformation(EntityBareJid workgroupJID) {

View file

@ -33,11 +33,11 @@ import org.jivesoftware.smack.filter.AndFilter;
import org.jivesoftware.smack.filter.FromMatchesFilter;
import org.jivesoftware.smack.filter.StanzaFilter;
import org.jivesoftware.smack.filter.StanzaTypeFilter;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.packet.IQ;
import org.jivesoftware.smack.packet.Message;
import org.jivesoftware.smack.packet.Presence;
import org.jivesoftware.smack.packet.Stanza;
import org.jivesoftware.smack.packet.XmlElement;
import org.jivesoftware.smackx.disco.ServiceDiscoveryManager;
import org.jivesoftware.smackx.disco.packet.DiscoverInfo;
@ -516,8 +516,8 @@ public class Workgroup {
if (packet instanceof Message) {
Message msg = (Message) packet;
// Check to see if the user left the queue.
ExtensionElement pe = msg.getExtensionElement("depart-queue", "http://jabber.org/protocol/workgroup");
ExtensionElement queueStatus = msg.getExtensionElement("queue-status", "http://jabber.org/protocol/workgroup");
XmlElement pe = msg.getExtensionElement("depart-queue", "http://jabber.org/protocol/workgroup");
XmlElement queueStatus = msg.getExtensionElement("queue-status", "http://jabber.org/protocol/workgroup");
if (pe != null) {
fireQueueDepartedEvent();

View file

@ -22,6 +22,8 @@ import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import javax.xml.namespace.QName;
import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.roster.Roster;
import org.jivesoftware.smack.roster.RosterEntry;
@ -51,6 +53,8 @@ import org.jivesoftware.smackx.xroster.RosterExchangeManager;
*/
public class RosterExchange implements ExtensionElement {
public static final QName QNAME = new QName(RosterExchangeManager.NAMESPACE, RosterExchangeManager.ELEMENT);
private final List<RemoteRosterEntry> remoteRosterEntries = new ArrayList<>();
/**
@ -113,7 +117,7 @@ public class RosterExchange implements ExtensionElement {
*/
@Override
public String getElementName() {
return RosterExchangeManager.ELEMENT;
return QNAME.getLocalPart();
}
/**
@ -125,7 +129,7 @@ public class RosterExchange implements ExtensionElement {
*/
@Override
public String getNamespace() {
return RosterExchangeManager.NAMESPACE;
return QNAME.getNamespaceURI();
}
/**