- The org.jivesoftware.smack.XMPPConnection class manages your connection to an XMPP - server. Two constructors are available. The first, XMPPConnection(String) takes + The org.jivesoftware.smack.Connection class manages your connection to an XMPP + server. The default implementation is the org.jivesoftware.smack.XMPPConnection + class. Two constructors are mainly used. The first, XMPPConnection(String) takes the server name you'd like to connect to as an argument. All default connection settings will be used:
- XMPPConnection.DEBUG_ENABLED = true;
+ Connection.DEBUG_ENABLED = true;
@@ -39,7 +39,7 @@ add the following line to your application before opening new connections:
-XMPPConnection.DEBUG_ENABLED = false; +Connection.DEBUG_ENABLED = false;
diff --git a/documentation/extensions/disco.html b/documentation/extensions/disco.html index 6f8058dd9..35f2f0056 100644 --- a/documentation/extensions/disco.html +++ b/documentation/extensions/disco.html @@ -34,9 +34,9 @@ discovery request with the information that you previously configured.
Usage
In order to configure the supported features by your client you should first obtain the
-ServiceDiscoveryManager associated with your XMPPConnection. To get your ServiceDiscoveryManager
+ServiceDiscoveryManager associated with your Connection. To get your ServiceDiscoveryManager
send getInstanceFor(connection) to the class ServiceDiscoveryManager where
-connection is your XMPPConnection.
Once you have your ServiceDiscoveryManager you will be able to manage the supported features. To register a new feature send addFeature(feature) to your ServiceDiscoveryManager @@ -48,7 +48,7 @@ String that represents the feature to remove.
In this example we can see how to add and remove supported features:-// Obtain the ServiceDiscoveryManager associated with my XMPPConnection +// Obtain the ServiceDiscoveryManager associated with my Connection ServiceDiscoveryManager discoManager = ServiceDiscoveryManager.getInstanceFor(connection); // Register that a new feature is supported by this XMPP entity @@ -74,7 +74,7 @@ to configure the information providers associated to the items/nodes within the In order to configure the associated nodes within the Smack client you will need to create a NodeInformationProvider and register it with the ServiceDiscoveryManager. To get your ServiceDiscoveryManager send getInstanceFor(connection) to the class ServiceDiscoveryManager -where connection is your XMPPConnection.
+where connection is your Connection.
Once you have your ServiceDiscoveryManager you will be able to register information providers for the XMPP entity's nodes. To register a new node information provider send setNodeInformationProvider(String node, NodeInformationProvider listener) @@ -126,7 +126,7 @@ the discovered items.
In this example we can see how to discover the items associated with an online catalog service:
-// Obtain the ServiceDiscoveryManager associated with my XMPPConnection +// Obtain the ServiceDiscoveryManager associated with my Connection ServiceDiscoveryManager discoManager = ServiceDiscoveryManager.getInstanceFor(connection); // Get the items of a given XMPP entity @@ -171,7 +171,7 @@ the discovered information. In this example we can see how to discover the information of a conference room:
-// Obtain the ServiceDiscoveryManager associated with my XMPPConnection +// Obtain the ServiceDiscoveryManager associated with my Connection ServiceDiscoveryManager discoManager = ServiceDiscoveryManager.getInstanceFor(connection); // Get the information of a given XMPP entity @@ -216,7 +216,7 @@ to publish. In this example we can see how to publish new items:
-// Obtain the ServiceDiscoveryManager associated with my XMPPConnection +// Obtain the ServiceDiscoveryManager associated with my Connection ServiceDiscoveryManager discoManager = ServiceDiscoveryManager.getInstanceFor(connection); // Create a DiscoverItems with the items to publish diff --git a/documentation/extensions/filetransfer.html b/documentation/extensions/filetransfer.html index f71fcc5df..13bb3281e 100644 --- a/documentation/extensions/filetransfer.html +++ b/documentation/extensions/filetransfer.html @@ -34,7 +34,7 @@ to enable the user to easily send a file. UsageIn order to send a file you must first construct an instance of the FileTransferManager -class. This class has one constructor with one parameter which is your XMPPConnection. +class. This class has one constructor with one parameter which is your Connection. In order to instantiate the manager you should call new FileTransferManager(connection)
Once you have your FileTransferManager you will need to create an outgoing @@ -86,7 +86,7 @@ manager.
UsageIn order to recieve a file you must first construct an instance of the FileTransferManager -class. This class has one constructor with one parameter which is your XMPPConnection. +class. This class has one constructor with one parameter which is your Connection. In order to instantiate the manager you should call new FileTransferManager(connection)
Once you have your FileTransferManager you will need to register a listener diff --git a/documentation/extensions/messageevents.html b/documentation/extensions/messageevents.html index d91492b3f..474c07247 100644 --- a/documentation/extensions/messageevents.html +++ b/documentation/extensions/messageevents.html @@ -75,14 +75,14 @@ You can receive notification requests for the following events: delivered, displ The general idea is to create a new DefaultMessageEventRequestListener that will listen to the event notifications requests and react with custom logic. Then you will have to add the listener to the MessageEventManager that works on -the desired XMPPConnection. +the desired Connection.
Note that DefaultMessageEventRequestListener is a default implementation of the MessageEventRequestListener interface. The class DefaultMessageEventRequestListener automatically sends a delivered notification to the sender of the message if the sender has requested to be notified when the message is delivered. If you decide to create a new class that implements the MessageEventRequestListener interface, please remember to send the delivered notification.
-
- To create a new MessageEventManager use the MessageEventManager(XMPPConnection) constructor. +
- To create a new MessageEventManager use the MessageEventManager(Connection) constructor.
- To create an event notification requests listener create a subclass of DefaultMessageEventRequestListener or create a class that implements the MessageEventRequestListener interface. @@ -178,9 +178,9 @@ will probably want to react to some or all of these events. The general idea is to create a new MessageEventNotificationListener that will listen to the event notifications and react with custom logic. Then you will have to add the listener to the MessageEventManager that works on -the desired XMPPConnection. +the desired Connection.
-
- To create a new MessageEventManager use the MessageEventManager(XMPPConnection) constructor. +
- To create a new MessageEventManager use the MessageEventManager(Connection) constructor.
- To create an event notifications listener create a class that implements the MessageEventNotificationListener interface. diff --git a/documentation/extensions/muc.html b/documentation/extensions/muc.html index ead69564a..961c1017d 100644 --- a/documentation/extensions/muc.html +++ b/documentation/extensions/muc.html @@ -51,7 +51,7 @@ the form and finally send it back to the server. In this example we can see how to create an instant room:
-// Create a MultiUserChat using an XMPPConnection for a room +// Create a MultiUserChat using a Connection for a room MultiUserChat muc = new MultiUserChat(conn1, "myroom@conference.jabber.org"); // Create the room @@ -65,7 +65,7 @@ In this example we can see how to create an instant room:
In this example we can see how to create a reserved room. The form is completed with default values:
-// Create a MultiUserChat using an XMPPConnection for a room +// Create a MultiUserChat using a Connection for a room MultiUserChat muc = new MultiUserChat(conn1, "myroom@conference.jabber.org"); // Create the room @@ -121,7 +121,7 @@ for a response from the server. In this example we can see how to join a room with a given nickname:
-// Create a MultiUserChat using an XMPPConnection for a room +// Create a MultiUserChat using a Connection for a room MultiUserChat muc2 = new MultiUserChat(conn1, "myroom@conference.jabber.org"); // User2 joins the new room @@ -132,7 +132,7 @@ In this example we can see how to join a room with a given nickname:
In this example we can see how to join a room with a given nickname and password:
-// Create a MultiUserChat using an XMPPConnection for a room +// Create a MultiUserChat using a Connection for a room MultiUserChat muc2 = new MultiUserChat(conn1, "myroom@conference.jabber.org"); // User2 joins the new room using a password @@ -144,7 +144,7 @@ In this example we can see how to join a room with a given nickname and password In this example we can see how to join a room with a given nickname specifying the amount of history to receive:
-// Create a MultiUserChat using an XMPPConnection for a room +// Create a MultiUserChat using a Connection for a room MultiUserChat muc2 = new MultiUserChat(conn1, "myroom@conference.jabber.org"); // User2 joins the new room using a password and specifying @@ -205,7 +205,7 @@ In this example we can see how to listen for room invitations and decline invita// User3 listens for MUC invitations MultiUserChat.addInvitationListener(conn3, new InvitationListener() { - public void invitationReceived(XMPPConnection conn, String room, String inviter, String reason, String password) { + public void invitationReceived(Connection conn, String room, String inviter, String reason, String password) { // Reject the invitation MultiUserChat.decline(conn, room, inviter, "I'm busy right now"); } @@ -224,7 +224,7 @@ A user may want to discover if one of the user's contacts supports the Multi-Use UsageIn order to discover if one of the user's contacts supports MUC just send -isServiceEnabled(XMPPConnection connection, String user) to the MultiUserChat +isServiceEnabled(Connection connection, String user) to the MultiUserChat class where user is a fully qualified XMPP ID, e.g. jdoe@example.com. You will receive a boolean indicating whether the user supports MUC or not.
@@ -248,7 +248,7 @@ A user may also want to query a contact regarding which rooms the contact is in. UsageIn order to get the rooms where a user is in just send -getJoinedRooms(XMPPConnection connection, String user) to the MultiUserChat +getJoinedRooms(Connection connection, String user) to the MultiUserChat class where user is a fully qualified XMPP ID, e.g. jdoe@example.com. You will get an Iterator of Strings as an answer where each String represents a room name.
@@ -272,7 +272,7 @@ will provide information only for public rooms. Usage-In order to discover information about a room just send getRoomInfo(XMPPConnection connection, String room) +In order to discover information about a room just send getRoomInfo(Connection connection, String room) to the MultiUserChat class where room is the XMPP ID of the room, e.g. roomName@conference.myserver. You will get a RoomInfo object that contains the discovered room information.
diff --git a/documentation/extensions/pubsub.html b/documentation/extensions/pubsub.html index 114737f8f..5279650dc 100644 --- a/documentation/extensions/pubsub.html +++ b/documentation/extensions/pubsub.html @@ -47,7 +47,7 @@ a fully configured node.Create an instant node:
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); // Create the node @@ -58,7 +58,7 @@ Create an instant node:
Create a node with default configuration and then configure it:
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); // Create the node @@ -77,7 +77,7 @@ Create a node with default configuration and then configure it:
Create and configure a node:
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); // Create the node @@ -117,7 +117,7 @@ will be dependent on its configuration. In this example we publish an item to a node that does not take payload:
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); // Get the node @@ -133,7 +133,7 @@ In this example we publish an item to a node that does not take payload:
In this example we publish an item to a node that does take payload:
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); // Get the node @@ -174,7 +174,7 @@ In this example we can see how to create a listener and register it and then sub messages.
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); // Get the node @@ -212,7 +212,7 @@ In this example we can see how to create a listener, register it and then subscr item deletion messages.
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); // Get the node @@ -250,7 +250,7 @@ In this example we can see how to create a listener, register it and then subscr node configuration messages.
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); // Get the node @@ -315,7 +315,7 @@ of a LeafNode and call one of the retrieve methods. In this example we can see how to retrieve the existing items from a node:
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); // Get the node @@ -329,7 +329,7 @@ In this example we can see how to retrieve the existing items from a node:
In this example we can see how to retrieve the last N existing items:
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); // Get the node @@ -343,7 +343,7 @@ In this example we can see how to retrieve the specified existing items:
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); // Get the node @@ -375,7 +375,7 @@ or Node classes depending on what type of information is required. In this example we can see how to get pubsub capabilities:
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); // Get the pubsub features that are supported @@ -386,7 +386,7 @@ In this example we can see how to get pubsub capabilities:
In this example we can see how to get pubsub subscriptions for all nodes:
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); // Get all the subscriptions in the pubsub service @@ -397,7 +397,7 @@ In this example we can see how to get pubsub subscriptions for all nodes:
In this example we can see how to get all affiliations for the users bare JID on the pubsub service:
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); // Get the affiliations for the users bare JID @@ -408,7 +408,7 @@ In this example we can see how to get all affiliations for the users bare JID on In this example we can see how to get information about the node:
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); Node node = mgr.getNode("testNode"); @@ -420,7 +420,7 @@ In this example we can see how to get information about the node:
In this example we can see how to discover the node items:
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); Node node = mgr.getNode("testNode"); @@ -432,7 +432,7 @@ In this example we can see how to discover the node items:
In this example we can see how to get node subscriptions:
- // Create a pubsub manager using an existing XMPPConnection + // Create a pubsub manager using an existing Connection PubSubManager mgr = new PubSubManager(con); Node node = mgr.getNode("testNode"); diff --git a/documentation/extensions/rosterexchange.html b/documentation/extensions/rosterexchange.html index e014da111..eea23d773 100644 --- a/documentation/extensions/rosterexchange.html +++ b/documentation/extensions/rosterexchange.html @@ -126,7 +126,7 @@ received.- Create a class that implements the RosterExchangeListener interface.
- Implement the method entriesReceived(String, Iterator) that will be called when new entries are received with custom logic.
-- Add the listener to the RosterExchangeManager that works on the desired XMPPConnection.
+- Add the listener to the RosterExchangeManager that works on the desired Connection.
diff --git a/documentation/extensions/xhtml.html b/documentation/extensions/xhtml.html index f283f57ba..938d74e3e 100644 --- a/documentation/extensions/xhtml.html +++ b/documentation/extensions/xhtml.html @@ -97,7 +97,7 @@ the message as you do with any other message.
An XHTML message is like any regular message, therefore to send the message you can follow the usual steps you do in order to send a message. For example, to send a message as part of a chat just use the message #send(Message) of Chat or you can use -the message #send(Packet) of XMPPConnection. +the message #send(Packet) of Connection. Example@@ -170,7 +170,7 @@ section explains how to explicitly discover for XHTML support.
Usage-In order to discover if a remote user supports XHTML messages send #isServiceEnabled(XMPPConnection +In order to discover if a remote user supports XHTML messages send #isServiceEnabled(Connection connection, String userID) to the class XHTMLManager where connection is the connection to use to perform the service discovery and userID is the user to check (A fully qualified xmpp ID, e.g. jdoe@example.com). This message will return true if the specified user handles XHTML messages.
diff --git a/documentation/gettingstarted.html b/documentation/gettingstarted.html index b797e9487..c6dd7d670 100644 --- a/documentation/gettingstarted.html +++ b/documentation/gettingstarted.html @@ -50,12 +50,12 @@ XMPP server. Below are code examples for making a connection:
// Create a connection to the jabber.org server.
-XMPPConnection conn1 = new XMPPConnection("jabber.org");
+Connection conn1 = new XMPPConnection("jabber.org");
conn1.connect();
// Create a connection to the jabber.org server on a specific port.
ConnectionConfiguration config = new ConnectionConfiguration("jabber.org", 5222);
-XMPPConnection conn2 = new XMPPConnection(config);
+Connection conn2 = new XMPPConnection(config);
conn2.connect();
Once you've created a connection, you should login using a username and password -with the XMPPConnection.login(String username, String password) method. +with the Connection.login(String username, String password) method. Once you've logged in, you can being chatting with other users by creating new Chat or GroupChat objects. @@ -76,7 +76,7 @@ The roster lets you keep track of the availability (presence) of other users. Us can be organized into groups such as "Friends" and "Co-workers", and then you discover whether each user is online or offline.
-Retrieve the roster using the XMPPConnection.getRoster() method. The roster +Retrieve the roster using the Connection.getRoster() method. The roster class allows you to find all the roster entries, the groups they belong to, and the current presence status of each entry. @@ -98,7 +98,7 @@ and "out fishing":
// Create a new presence. Pass in false to indicate we're unavailable. Presence presence = new Presence(Presence.Type.unavailable); presence.setStatus("Gone fishing"); -// Send the packet (assume we have a XMPPConnection instance called "con"). +// Send the packet (assume we have a Connection instance called "con"). con.sendPacket(presence);
@@ -111,7 +111,7 @@ polling and blocking operations on. So, a packet listener is useful when you want to take some action whenever a packet happens to come in, while a packet collector is useful when you want to wait for a specific packet to arrive. Packet collectors and listeners can be created using an -XMPPConnection instance. +Connection instance.
-