mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-09-27 18:19:33 +02:00
3d4e7938a7
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).
188 lines
6.5 KiB
Java
188 lines
6.5 KiB
Java
/**
|
|
*
|
|
* Copyright 2003-2007 Jive Software.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
package org.jivesoftware.smackx.xroster.packet;
|
|
|
|
import java.util.ArrayList;
|
|
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;
|
|
import org.jivesoftware.smack.roster.RosterGroup;
|
|
|
|
import org.jivesoftware.smackx.xroster.RemoteRosterEntry;
|
|
import org.jivesoftware.smackx.xroster.RosterExchangeManager;
|
|
|
|
/**
|
|
* Represents XMPP Roster Item Exchange packets.<p>
|
|
*
|
|
* The 'jabber:x:roster' namespace (which is not to be confused with the 'jabber:iq:roster'
|
|
* namespace) is used to send roster items from one client to another. A roster item is sent by
|
|
* adding to the <message/> element an <x/> child scoped by the 'jabber:x:roster' namespace. This
|
|
* <x/> element may contain one or more <item/> children (one for each roster item to be sent).<p>
|
|
*
|
|
* Each <item/> element may possess the following attributes:<p>
|
|
*
|
|
* <jid/> -- The id of the contact being sent. This attribute is required.<br>
|
|
* <name/> -- A natural-language nickname for the contact. This attribute is optional.<p>
|
|
*
|
|
* Each <item/> element may also contain one or more <group/> children specifying the
|
|
* natural-language name of a user-specified group, for the purpose of categorizing this contact
|
|
* into one or more roster groups.
|
|
*
|
|
* @author Gaston Dombiak
|
|
*/
|
|
public class RosterExchange implements ExtensionElement {
|
|
|
|
public static final QName QNAME = new QName(RosterExchangeManager.NAMESPACE, RosterExchangeManager.ELEMENT);
|
|
|
|
private final List<RemoteRosterEntry> remoteRosterEntries = new ArrayList<>();
|
|
|
|
/**
|
|
* Creates a new empty roster exchange package.
|
|
*
|
|
*/
|
|
public RosterExchange() {
|
|
super();
|
|
}
|
|
|
|
/**
|
|
* Creates a new roster exchange package with the entries specified in roster.
|
|
*
|
|
* @param roster the roster to send to other XMPP entity.
|
|
*/
|
|
public RosterExchange(Roster roster) {
|
|
// Add all the roster entries to the new RosterExchange
|
|
for (RosterEntry rosterEntry : roster.getEntries()) {
|
|
this.addRosterEntry(rosterEntry);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds a roster entry to the packet.
|
|
*
|
|
* @param rosterEntry a roster entry to add.
|
|
*/
|
|
public void addRosterEntry(RosterEntry rosterEntry) {
|
|
// Obtain a String[] from the roster entry groups name
|
|
List<String> groupNamesList = new ArrayList<>();
|
|
String[] groupNames;
|
|
for (RosterGroup group : rosterEntry.getGroups()) {
|
|
groupNamesList.add(group.getName());
|
|
}
|
|
groupNames = groupNamesList.toArray(new String[groupNamesList.size()]);
|
|
|
|
// Create a new Entry based on the rosterEntry and add it to the packet
|
|
RemoteRosterEntry remoteRosterEntry = new RemoteRosterEntry(rosterEntry.getJid(),
|
|
rosterEntry.getName(), groupNames);
|
|
|
|
addRosterEntry(remoteRosterEntry);
|
|
}
|
|
|
|
/**
|
|
* Adds a remote roster entry to the packet.
|
|
*
|
|
* @param remoteRosterEntry a remote roster entry to add.
|
|
*/
|
|
public void addRosterEntry(RemoteRosterEntry remoteRosterEntry) {
|
|
synchronized (remoteRosterEntries) {
|
|
remoteRosterEntries.add(remoteRosterEntry);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the XML element name of the extension sub-packet root element.
|
|
* Always returns "x"
|
|
*
|
|
* @return the XML element name of the stanza extension.
|
|
*/
|
|
@Override
|
|
public String getElementName() {
|
|
return QNAME.getLocalPart();
|
|
}
|
|
|
|
/**
|
|
* Returns the XML namespace of the extension sub-packet root element.
|
|
* According the specification the namespace is always "jabber:x:roster"
|
|
* (which is not to be confused with the 'jabber:iq:roster' namespace
|
|
*
|
|
* @return the XML namespace of the stanza extension.
|
|
*/
|
|
@Override
|
|
public String getNamespace() {
|
|
return QNAME.getNamespaceURI();
|
|
}
|
|
|
|
/**
|
|
* Returns an Iterator for the roster entries in the packet.
|
|
*
|
|
* @return an Iterator for the roster entries in the packet.
|
|
*/
|
|
public Iterator<RemoteRosterEntry> getRosterEntries() {
|
|
synchronized (remoteRosterEntries) {
|
|
List<RemoteRosterEntry> entries = Collections.unmodifiableList(new ArrayList<>(remoteRosterEntries));
|
|
return entries.iterator();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns a count of the entries in the roster exchange.
|
|
*
|
|
* @return the number of entries in the roster exchange.
|
|
*/
|
|
public int getEntryCount() {
|
|
return remoteRosterEntries.size();
|
|
}
|
|
|
|
/**
|
|
* Returns the XML representation of a Roster Item Exchange according the specification.
|
|
*
|
|
* Usually the XML representation will be inside of a Message XML representation like
|
|
* in the following example:
|
|
* <pre>
|
|
* <message id="MlIpV-4" to="gato1@gato.home" from="gato3@gato.home/Smack">
|
|
* <subject>Any subject you want</subject>
|
|
* <body>This message contains roster items.</body>
|
|
* <x xmlns="jabber:x:roster">
|
|
* <item jid="gato1@gato.home"/>
|
|
* <item jid="gato2@gato.home"/>
|
|
* </x>
|
|
* </message>
|
|
* </pre>
|
|
*
|
|
*/
|
|
@Override
|
|
public String toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
|
|
StringBuilder buf = new StringBuilder();
|
|
buf.append('<').append(getElementName()).append(" xmlns=\"").append(getNamespace()).append(
|
|
"\">");
|
|
// Loop through all roster entries and append them to the string buffer
|
|
for (Iterator<RemoteRosterEntry> i = getRosterEntries(); i.hasNext();) {
|
|
RemoteRosterEntry remoteRosterEntry = i.next();
|
|
buf.append(remoteRosterEntry.toXML());
|
|
}
|
|
buf.append("</").append(getElementName()).append('>');
|
|
return buf.toString();
|
|
}
|
|
|
|
}
|