2014-02-17 23:58:40 +01:00
|
|
|
/**
|
|
|
|
*
|
|
|
|
* 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;
|
2015-02-26 18:41:17 +01:00
|
|
|
import org.jivesoftware.smack.packet.ExtensionElement;
|
2014-02-17 23:58:40 +01:00
|
|
|
import org.jivesoftware.smackx.pubsub.PubSubElementType;
|
2015-02-14 17:15:02 +01:00
|
|
|
import org.jxmpp.jid.Jid;
|
2014-02-17 23:58:40 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
{
|
2014-07-09 12:57:51 +02:00
|
|
|
public static final String ELEMENT = "pubsub";
|
|
|
|
public static final String NAMESPACE = "http://jabber.org/protocol/pubsub";
|
|
|
|
|
|
|
|
public PubSub() {
|
2014-11-07 21:12:01 +01:00
|
|
|
super(ELEMENT, NAMESPACE);
|
2014-07-09 12:57:51 +02:00
|
|
|
}
|
|
|
|
|
2014-12-17 13:31:22 +01:00
|
|
|
public PubSub(PubSubNamespace ns) {
|
|
|
|
super(ELEMENT, ns.getXmlns());
|
2014-07-09 12:57:51 +02:00
|
|
|
}
|
|
|
|
|
2015-02-14 17:15:02 +01:00
|
|
|
public PubSub(Jid to, Type type, PubSubNamespace ns) {
|
2014-12-17 13:31:22 +01:00
|
|
|
super(ELEMENT, (ns == null ? PubSubNamespace.BASIC : ns).getXmlns());
|
|
|
|
setTo(to);
|
|
|
|
setType(type);
|
2014-07-09 12:57:51 +02:00
|
|
|
}
|
|
|
|
|
2014-09-21 20:49:11 +02:00
|
|
|
@SuppressWarnings("unchecked")
|
2015-02-26 18:41:17 +01:00
|
|
|
public <PE extends ExtensionElement> PE getExtension(PubSubElementType elem)
|
2014-02-17 23:58:40 +01:00
|
|
|
{
|
2014-09-21 20:49:11 +02:00
|
|
|
return (PE) getExtension(elem.getElementName(), elem.getNamespace().getXmlns());
|
2014-02-17 23:58:40 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the XML representation of a pubsub element according the specification.
|
|
|
|
*
|
2015-03-21 09:36:28 +01:00
|
|
|
* The XML representation will be inside of an iq stanza(/packet) like
|
2014-02-17 23:58:40 +01:00
|
|
|
* 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>
|
|
|
|
*
|
|
|
|
*/
|
2014-09-21 20:49:11 +02:00
|
|
|
@Override
|
2014-11-07 21:12:01 +01:00
|
|
|
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();
|
2014-09-21 20:49:11 +02:00
|
|
|
return xml;
|
2014-02-17 23:58:40 +01:00
|
|
|
}
|
|
|
|
|
2015-03-04 22:42:36 +01:00
|
|
|
public static PubSub createPubsubPacket(Jid to, Type type, ExtensionElement extension, PubSubNamespace ns) {
|
2014-07-09 12:57:51 +02:00
|
|
|
PubSub pubSub = new PubSub(to, type, ns);
|
|
|
|
pubSub.addExtension(extension);
|
|
|
|
return pubSub;
|
|
|
|
}
|
2014-02-17 23:58:40 +01:00
|
|
|
}
|