aboutsummaryrefslogtreecommitdiff
path: root/src/org/jivesoftware/smackx/packet/PEPItem.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/org/jivesoftware/smackx/packet/PEPItem.java')
-rw-r--r--src/org/jivesoftware/smackx/packet/PEPItem.java92
1 files changed, 92 insertions, 0 deletions
diff --git a/src/org/jivesoftware/smackx/packet/PEPItem.java b/src/org/jivesoftware/smackx/packet/PEPItem.java
new file mode 100644
index 0000000..c3ff6f4
--- /dev/null
+++ b/src/org/jivesoftware/smackx/packet/PEPItem.java
@@ -0,0 +1,92 @@
+/**
+ * $RCSfile: PEPItem.java,v $
+ * $Revision: 1.2 $
+ * $Date: 2007/11/06 02:05:09 $
+ *
+ * Copyright 2003-2007 Jive Software.
+ *
+ * All rights reserved. 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.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
+ */
+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>
+ * &lt;message id="MlIpV-4" to="gato1@gato.home" from="gato3@gato.home/Smack"&gt;
+ * &lt;subject&gt;Any subject you want&lt;/subject&gt;
+ * &lt;body&gt;This message contains roster items.&lt;/body&gt;
+ * &lt;x xmlns="jabber:x:roster"&gt;
+ * &lt;item jid="gato1@gato.home"/&gt;
+ * &lt;item jid="gato2@gato.home"/&gt;
+ * &lt;/x&gt;
+ * &lt;/message&gt;
+ * </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();
+ }
+
+}