| /** |
| * $RCSfile: PEPEvent.java,v $ |
| * $Revision: 1.1 $ |
| * $Date: 2007/11/03 00:14:32 $ |
| * |
| * 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 class PEPEvent implements PacketExtension { |
| |
| PEPItem item; |
| |
| /** |
| * Creates a new empty roster exchange package. |
| * |
| */ |
| public PEPEvent() { |
| super(); |
| } |
| |
| /** |
| * Creates a new empty roster exchange package. |
| * |
| */ |
| public PEPEvent(PEPItem item) { |
| super(); |
| |
| this.item = item; |
| } |
| |
| public void addPEPItem(PEPItem item) { |
| this.item = item; |
| } |
| |
| /** |
| * 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 "event"; |
| } |
| |
| /** |
| * 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 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(" xmlns=\"").append(getNamespace()).append("\">"); |
| buf.append(item.toXML()); |
| buf.append("</").append(getElementName()).append(">"); |
| return buf.toString(); |
| } |
| |
| } |