/** * * 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.muc.packet; import java.io.IOException; import javax.xml.namespace.QName; import org.jivesoftware.smack.packet.ExtensionElement; import org.jivesoftware.smack.packet.Stanza; import org.jivesoftware.smack.packet.XmlEnvironment; import org.jivesoftware.smack.provider.ExtensionElementProvider; import org.jivesoftware.smack.util.XmlStringBuilder; import org.jivesoftware.smack.xml.XmlPullParser; import org.jivesoftware.smack.xml.XmlPullParserException; /** * A group chat invitation stanza extension, which is used to invite other * users to a group chat room. To invite a user to a group chat room, address * a new message to the user and set the room name appropriately, as in the * following code example: * *
* Message message = new Message("user@chat.example.com"); * message.setBody("Join me for a group chat!"); * message.addExtension(new GroupChatInvitation("room@chat.example.com");); * con.sendStanza(message); ** * To listen for group chat invitations, use a StanzaExtensionFilter for the *
x
element name and jabber:x:conference
namespace, as in the
* following code example:
*
* * PacketFilter filter = new StanzaExtensionFilter("x", "jabber:x:conference"); * // Create a stanza collector or stanza listeners using the filter... ** * Note: this protocol is outdated now that the Multi-User Chat (MUC) XEP is available * (XEP-45). However, most * existing clients still use this older protocol. Once MUC support becomes more * widespread, this API may be deprecated. * * @author Matt Tucker */ public class GroupChatInvitation implements ExtensionElement { /** * Element name of the stanza extension. */ public static final String ELEMENT = "x"; /** * Namespace of the stanza extension. */ public static final String NAMESPACE = "jabber:x:conference"; public static final QName QNAME = new QName(NAMESPACE, ELEMENT); private final String roomAddress; /** * Creates a new group chat invitation to the specified room address. * GroupChat room addresses are in the form
room@service
,
* where service
is the name of group chat server, such as
* chat.example.com
.
*
* @param roomAddress the address of the group chat room.
*/
public GroupChatInvitation(String roomAddress) {
this.roomAddress = roomAddress;
}
/**
* Returns the address of the group chat room. GroupChat room addresses
* are in the form room@service
, where service
is
* the name of group chat server, such as chat.example.com
.
*
* @return the address of the group chat room.
*/
public String getRoomAddress() {
return roomAddress;
}
@Override
public String getElementName() {
return ELEMENT;
}
@Override
public String getNamespace() {
return NAMESPACE;
}
@Override
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder(this);
xml.attribute("jid", getRoomAddress());
xml.closeEmptyElement();
return xml;
}
/**
* Get the group chat invitation from the given stanza.
* @param packet TODO javadoc me please
* @return the GroupChatInvitation or null
*/
public static GroupChatInvitation from(Stanza packet) {
return packet.getExtension(GroupChatInvitation.class);
}
public static class Provider extends ExtensionElementProvider