mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-06-25 21:04:50 +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).
88 lines
3.1 KiB
Java
88 lines
3.1 KiB
Java
/**
|
|
*
|
|
* Copyright the original author or authors
|
|
*
|
|
* 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.pubsub.packet;
|
|
|
|
import org.jivesoftware.smack.packet.IQ;
|
|
import org.jivesoftware.smack.packet.XmlElement;
|
|
|
|
import org.jivesoftware.smackx.pubsub.NodeExtension;
|
|
import org.jivesoftware.smackx.pubsub.PubSubElementType;
|
|
|
|
import org.jxmpp.jid.Jid;
|
|
|
|
/**
|
|
* The standard PubSub extension of an {@link IQ} packet. This is the topmost
|
|
* element of all pubsub requests and replies as defined in the <a href="http://xmpp.org/extensions/xep-0060">Publish-Subscribe</a>
|
|
* specification.
|
|
*
|
|
* @author Robin Collier
|
|
*/
|
|
public class PubSub extends IQ {
|
|
public static final String ELEMENT = "pubsub";
|
|
public static final String NAMESPACE = "http://jabber.org/protocol/pubsub";
|
|
|
|
public PubSub() {
|
|
super(ELEMENT, NAMESPACE);
|
|
}
|
|
|
|
public PubSub(PubSubNamespace ns) {
|
|
super(ELEMENT, ns.getXmlns());
|
|
}
|
|
|
|
public PubSub(Jid to, Type type, PubSubNamespace ns) {
|
|
super(ELEMENT, (ns == null ? PubSubNamespace.basic : ns).getXmlns());
|
|
setTo(to);
|
|
setType(type);
|
|
}
|
|
|
|
@SuppressWarnings("unchecked")
|
|
public <PE extends XmlElement> PE getExtension(PubSubElementType elem) {
|
|
return (PE) getExtensionElement(elem.getElementName(), elem.getNamespace().getXmlns());
|
|
}
|
|
|
|
/**
|
|
* Returns the XML representation of a pubsub element according the specification.
|
|
*
|
|
* The XML representation will be inside of an iq stanza like
|
|
* in the following example:
|
|
* <pre>
|
|
* <iq type='set' id="MlIpV-4" to="pubsub.gato.home" from="gato3@gato.home/Smack">
|
|
* <pubsub xmlns="http://jabber.org/protocol/pubsub">
|
|
* :
|
|
* Specific request extension
|
|
* :
|
|
* </pubsub>
|
|
* </iq>
|
|
* </pre>
|
|
*
|
|
*/
|
|
@Override
|
|
protected IQChildElementXmlStringBuilder getIQChildElementBuilder(IQChildElementXmlStringBuilder xml) {
|
|
// N.B. We could use SimpleIQ here, but PubSub IQs will nearly *always* have packet extensions, which means that
|
|
// SimpleIQs xml.setEmptyElement() is counter-productive in this case and we use xml.rightAngleBracket()
|
|
// instead, as there are likely sub-elements to follow.
|
|
xml.rightAngleBracket();
|
|
return xml;
|
|
}
|
|
|
|
public static PubSub createPubsubPacket(Jid to, Type type, NodeExtension extension) {
|
|
PubSub pubSub = new PubSub(to, type, extension.getPubSubNamespace());
|
|
pubSub.addExtension(extension);
|
|
return pubSub;
|
|
}
|
|
}
|