mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-06-30 23:26:42 +02:00
1e57f1c659
Delete also all "All rights reserved" statements, as they are unnecessary and conflict with checkstyle's header check. Delete unused imports.
91 lines
2.7 KiB
Java
91 lines
2.7 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.pep.packet;
|
|
|
|
import org.jivesoftware.smack.packet.PacketExtension;
|
|
|
|
/**
|
|
* Represents XMPP Personal Event Protocol packets.<p>
|
|
*
|
|
* The 'http://jabber.org/protocol/pubsub#event' namespace is used to publish personal events items from one client
|
|
* to subscribed clients (See XEP-163).
|
|
*
|
|
* @author Jeff Williams
|
|
*/
|
|
@Deprecated
|
|
public abstract class PEPItem implements PacketExtension {
|
|
|
|
String id;
|
|
abstract String getNode();
|
|
abstract String getItemDetailsXML();
|
|
|
|
/**
|
|
* Creates a new PEPItem.
|
|
*
|
|
*/
|
|
public PEPItem(String id) {
|
|
super();
|
|
this.id = id;
|
|
}
|
|
|
|
/**
|
|
* Returns the XML element name of the extension sub-packet root element.
|
|
* Always returns "x"
|
|
*
|
|
* @return the XML element name of the packet extension.
|
|
*/
|
|
public String getElementName() {
|
|
return "item";
|
|
}
|
|
|
|
/**
|
|
* Returns the XML namespace of the extension sub-packet root element.
|
|
*
|
|
* @return the XML namespace of the packet extension.
|
|
*/
|
|
public String getNamespace() {
|
|
return "http://jabber.org/protocol/pubsub";
|
|
}
|
|
|
|
/**
|
|
* Returns the XML representation of a Personal Event Publish 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>
|
|
*
|
|
*/
|
|
public String toXML() {
|
|
StringBuilder buf = new StringBuilder();
|
|
buf.append("<").append(getElementName()).append(" id=\"").append(id).append("\">");
|
|
buf.append(getItemDetailsXML());
|
|
buf.append("</").append(getElementName()).append(">");
|
|
return buf.toString();
|
|
}
|
|
|
|
}
|