* <desc> is used to provide a sender-generated description of the
* file so the receiver can better understand what is being sent. It MUST
* NOT be sent in the result.
- *
* When <range> is sent in the offer, it should have no attributes.
* This signifies that the sender can do ranged transfers. When a Stream
- * Initiation result is sent with the element, it uses these
+ * Initiation result is sent with the <range> element, it uses these
* attributes:
- *
+ *
*
+ * @author Alvaro Saurin
*/
public class JingleException extends XMPPException {
private static final long serialVersionUID = -1521230401958103382L;
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleManager.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleManager.java
index 28bcc2893..64c861de5 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleManager.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleManager.java
@@ -56,34 +56,41 @@ import org.jxmpp.jid.Jid;
* Jingle is a session establishment protocol defined in (XEP-0166).
* It defines a framework for negotiating and managing out-of-band ( data that is send and receive through other connection than XMPP connection) data sessions over XMPP.
* With this protocol you can setup VOIP Calls, Video Streaming, File transfers and whatever out-of-band session based transmission.
- *
+ *
* To create a Jingle Session you need a Transport method and a Payload type.
- *
+ *
+ *
* A transport method is how it will transmit and receive network packets. Transport MUST have one or more candidates.
* A transport candidate is an IP Address with a defined port, that other party must send data to.
- *
+ *
+ *
* A supported payload type, is the data encoding format that the jmf will be transmitted.
* For instance an Audio Payload "GSM".
- *
+ *
+ *
* A Jingle session negotiates a payload type and a pair of transport candidates.
* Which means that when a Jingle Session is established you will have two defined transport candidates with addresses
* and a defined Payload type.
* In other words, you will have two IP address with their respective ports, and a Codec type defined.
- *
+ *
+ *
* The JingleManager is a facade built upon Jabber Jingle (XEP-166) to allow the
* use of Jingle. This implementation allows the user to simply
* use this class for setting the Jingle parameters, create and receive Jingle Sessions.
- *
+ *
+ *
* In order to use the Jingle, the user must provide a
* TransportManager that will handle the resolution of potential IP addresses that can be used to transport the streaming (jmf).
* This TransportManager can be initialized with several default resolvers,
* including a fixed solver that can be used when the address and port are know
* in advance.
* This API have ready to use Transport Managers, for instance: BasicTransportManager, STUNTransportManager, BridgedTransportManager.
- *
+ *
+ *
* You should also specify a JingleMediaManager if you want that JingleManager assume Media control
* Using a JingleMediaManager implementation is the easier way to implement a Jingle Application.
- *
+ *
+ *
* Otherwise before creating an outgoing connection, the user must create jingle session
* listeners that will be called when different events happen. The most
* important event is sessionEstablished(), that will be called when all
@@ -91,85 +98,60 @@ import org.jxmpp.jid.Jid;
* transmission as well as the remote and local addresses and ports for the
* communication. See JingleSessionListener for a complete list of events that can be
* observed.
- *
+ *
* This is an example of how to use the JingleManager:
* This example implements a Jingle VOIP Call between two users.
- *
*
- *
* To wait for an Incoming Jingle Session:
- *
* try {
- *
* // Connect to an XMPP Server
* XMPPConnection x1 = new XMPPTCPConnection("xmpp.com");
* x1.connect();
* x1.login("juliet", "juliet");
- *
* // Create a JingleManager using a BasicResolver
* final JingleManager jm1 = new JingleManager(
* x1, new BasicTransportManager());
- *
* // Create a JingleMediaManager. In this case using Jingle Audio Media API
* JingleMediaManager jingleMediaManager = new AudioMediaManager();
- *
* // Set the JingleMediaManager
* jm1.setMediaManager(jingleMediaManager);
- *
* // Listen for incoming calls
* jm1.addJingleSessionRequestListener(new JingleSessionRequestListener() {
* public void sessionRequested(JingleSessionRequest request) {
- *
* try {
* // Accept the call
* IncomingJingleSession session = request.accept();
- *
- *
* // Start the call
* session.start();
* } catch (XMPPException e) {
* LOGGER.log(Level.WARNING, "exception", e);
* }
- *
* }
* });
- *
* Thread.sleep(15000);
- *
* } catch (Exception e) {
* LOGGER.log(Level.WARNING, "exception", e);
* }
- *
* To create an Outgoing Jingle Session:
- *
* try {
- *
* // Connect to an XMPP Server
* XMPPConnection x0 = new XMPPTCPConnection("xmpp.com");
* x0.connect();
* x0.login("romeo", "romeo");
- *
* // Create a JingleManager using a BasicResolver
* final JingleManager jm0 = new JingleManager(
* x0, new BasicTransportManager());
- *
* // Create a JingleMediaManager. In this case using Jingle Audio Media API
* JingleMediaManager jingleMediaManager = new AudioMediaManager(); // Using Jingle Media API
- *
* // Set the JingleMediaManager
* jm0.setMediaManager(jingleMediaManager);
- *
* // Create a new Jingle Call with a full JID
* OutgoingJingleSession js0 = jm0.createOutgoingJingleSession("juliet@xmpp.com/Smack");
- *
* // Start the call
* js0.start();
- *
* Thread.sleep(10000);
* js0.terminate();
- *
* Thread.sleep(3000);
- *
* } catch (Exception e) {
* LOGGER.log(Level.WARNING, "exception", e);
* }
@@ -279,11 +261,11 @@ public class JingleManager implements JingleSessionListener {
/**
* Enables or disables the Jingle support on a given connection.
- *
- *
+ *
* Before starting any Jingle jmf session, check that the user can handle
* it. Enable the Jingle support to indicate that this client handles Jingle
* messages.
+ *
*
* @param connection the connection where the service will be enabled or
* disabled
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiator.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiator.java
index 06e97f572..ddb2e08dc 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiator.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiator.java
@@ -29,13 +29,10 @@ import org.jivesoftware.smackx.jingleold.listeners.JingleListener;
/**
* Basic Jingle negotiator.
- *
- *
- *
+ *
* JingleNegotiator implements some basic behavior for every Jingle negotiation.
* It implements a "state" pattern: each stage should process Jingle packets and
* act depending on the current state in the negotiation...
- *
*
*
* @author Alvaro Saurin
@@ -215,18 +212,18 @@ public abstract class JingleNegotiator {
* Media Negotiator
* Transport Negotiator
*
- *
- *
- *
- *
- *
- *
- *
+ * <jingle>
+ * <content>
+ * <description>
+ * <transport>
+ * <content>
+ * <description>
+ * <transport>
*
* This way, each segment of a Jingle stanza(/packet) has a corresponding negotiator that know how to deal with that
* part of the Jingle packet. It also allows us to support Jingle packets of arbitraty complexity.
*
- * Each parent calls dispatchIncomingPacket for each of its children. The children then pass back a List<> of
+ * Each parent calls dispatchIncomingPacket for each of its children. The children then pass back a List of
* results that will get sent when we reach the top level negotiator (JingleSession).
*
* @param iq the stanza(/packet) received
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSession.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSession.java
index aaa0ca9fe..9ea3924fd 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSession.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSession.java
@@ -55,7 +55,7 @@ import org.jivesoftware.smackx.jingleold.packet.JingleError;
import org.jxmpp.jid.Jid;
/**
- * An abstract Jingle session. This class contains some basic properties of
+ * An abstract Jingle session. This class contains some basic properties of
* every Jingle session. However, the concrete implementation can be found in
* subclasses.
*
@@ -270,7 +270,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
// ----------------------------------------------------------------------------------------------------------
/**
- * Process and respond to an incoming packet. This method is called
+ * Process and respond to an incoming packet. This method is called
* from the stanza(/packet) listener dispatcher when a new stanza(/packet) has arrived. The
* method is responsible for recognizing the stanza(/packet) type and, depending on
* the current state, delivering it to the right event handler and wait for
@@ -394,7 +394,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
- * Add a new content negotiator on behalf of a section received.
+ * Add a new content negotiator on behalf of a <content/> section received.
*/
public void addContentNegotiator(ContentNegotiator inContentNegotiator) {
contentNegotiators.add(inContentNegotiator);
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionRequest.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionRequest.java
index 3ad9cc414..2584f3279 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionRequest.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionRequest.java
@@ -28,7 +28,7 @@ import org.jxmpp.jid.Jid;
/**
* A Jingle session request.
- *
+ *
* This class is a facade of a received Jingle request. The user can have direct
* access to the Jingle stanza(/packet) (JingleSessionRequest.getJingle() ) of
* the request or can use the convenience methods provided by this class.
@@ -107,7 +107,7 @@ public class JingleSessionRequest {
/**
* Accepts this request and creates the incoming Jingle session.
*
- * @return Returns the IncomingJingleSession on which the
+ * @return Returns the IncomingJingleSession on which the
* negotiation can be carried out.
* @throws SmackException
* @throws InterruptedException
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/ContentInfo.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/ContentInfo.java
index 2f0ceb9b9..dbdcbd63b 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/ContentInfo.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/ContentInfo.java
@@ -22,14 +22,14 @@ import java.util.Locale;
* Content info. Content info messages are complementary messages that can be
* transmitted for informing of events like "busy", "ringtone", etc.
*
- * @author Alvaro Saurin
+ * @author Alvaro Saurin
*/
public abstract class ContentInfo {
/**
* Audio content info messages.
*
- * @author Alvaro Saurin
+ * @author Alvaro Saurin
*/
public static class Audio extends ContentInfo {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaManager.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaManager.java
index 2c28d0598..4b7cb43bf 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaManager.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaManager.java
@@ -25,10 +25,11 @@ import org.jivesoftware.smackx.jingleold.nat.TransportCandidate;
/**
* This class provides necessary Jingle Session jmf methods and behavior.
- *
+ *
* The goal of this class is to provide a flexible way to make JingleManager control jmf streaming APIs without implement them.
* For instance you can implement a file transfer using java sockets or a VOIP Media Manager using JMF.
* You can implement many JingleMediaManager according to you necessity.
+ *
*
* @author Thiago Camargo
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaSession.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaSession.java
index 18b60fb0b..44effa49e 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaSession.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/JingleMediaSession.java
@@ -24,11 +24,11 @@ import org.jivesoftware.smackx.jingleold.nat.TransportCandidate;
/**
* Public Abstract Class provides a clear interface between Media Session and Jingle API.
- *
+ *
* When a Jingle Session is fully stablished, we will have a Payload Type and two transport candidates defined for it.
* Smack Jingle API don't implement Media Transmit and Receive methods.
* But provides an interface to let the user implements it using another API. For instance: JMF.
- *
+ *
* The Class that implements this one, must have the support to transmit and receive the jmf.
* This interface let the user choose his own jmf API.
*
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaNegotiator.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaNegotiator.java
index 9b6600ecd..24d5545f5 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaNegotiator.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaNegotiator.java
@@ -38,7 +38,7 @@ import org.jivesoftware.smackx.jingleold.packet.JingleDescription;
import org.jivesoftware.smackx.jingleold.packet.JingleError;
/**
- * Manager for jmf descriptor negotiation. This class is responsible
+ * Manager for jmf descriptor negotiation. This class is responsible
* for managing the descriptor negotiation process, handling all the xmpp
* packets interchange and the stage control. handling all the xmpp packets
* interchange and the stage control.
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioChannel.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioChannel.java
index 0976aa5b3..fdd9c8689 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioChannel.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioChannel.java
@@ -54,15 +54,17 @@ import org.jivesoftware.smackx.jingleold.media.JingleMediaSession;
* It sends and receives jmf for and from desired IPs and ports.
* Also has a rport Symetric behavior for better NAT Traversal.
* It send data from a defined port and receive data in the same port, making NAT binds easier.
- *
+ *
* Send from portA to portB and receive from portB in portA.
- *
+ *
+ *
* Sending
- * portA ---> portB
- *
+ * portA ---> portB
+ *
+ *
* Receiving
- * portB ---> portA
- *
+ * portB ---> portA
+ *
* Transmit and Receive are interdependence. To receive you MUST transmit.
*
* @author Thiago Camargo
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/BasicResolver.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/BasicResolver.java
index 5b210592f..c79e33803 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/BasicResolver.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/BasicResolver.java
@@ -45,7 +45,7 @@ public class BasicResolver extends TransportResolver {
/**
* Resolve the IP address.
- *
+ *
* The BasicResolver takes the IP addresses of the interfaces and uses the
* first non-loopback, non-linklocal and non-sitelocal address.
* @throws NotConnectedException
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/BridgedResolver.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/BridgedResolver.java
index 451da4ad1..84f4a4cbb 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/BridgedResolver.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/BridgedResolver.java
@@ -36,7 +36,7 @@ import org.jivesoftware.smackx.jingleold.JingleSession;
/**
* Bridged Resolver use a RTPBridge Service to add a relayed candidate.
* A very reliable solution for NAT Traversal.
- *
+ *
* The resolver verify is the XMPP Server that the client is connected offer this service.
* If the server supports, a candidate is requested from the service.
* The resolver adds this candidate
@@ -61,7 +61,7 @@ public class BridgedResolver extends TransportResolver {
/**1
* Resolve Bridged Candidate.
- *
+ *
* The BridgedResolver takes the IP address and ports of a jmf proxy service.
* @throws NotConnectedException
* @throws InterruptedException
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/FixedResolver.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/FixedResolver.java
index 9a9e8f2b4..0f96a01c5 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/FixedResolver.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/FixedResolver.java
@@ -26,7 +26,7 @@ import org.jivesoftware.smackx.jingleold.JingleSession;
* the external address and port are previously known when the object is
* initialized.
*
- * @author Alvaro Saurin
+ * @author Alvaro Saurin
*/
public class FixedResolver extends TransportResolver {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/ICECandidate.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/ICECandidate.java
index 6650ce0e8..f5f05b4d3 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/ICECandidate.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/ICECandidate.java
@@ -24,7 +24,7 @@ import java.util.logging.Logger;
/**
* ICE Transport candidate.
- *
+ *
* A candidate represents the possible transport for data interchange between
* the two endpoints.
*
@@ -216,7 +216,7 @@ public class ICECandidate extends TransportCandidate implements Comparable
+ *
* ICE Candidate can check connectivity using UDP echo Test.
*/
@Override
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/RTPBridge.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/RTPBridge.java
index 33c8efd41..2a7c00fe4 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/RTPBridge.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/RTPBridge.java
@@ -45,9 +45,9 @@ import org.xmlpull.v1.XmlPullParserException;
* RTPBridge IQ Stanza(/Packet) used to request and retrieve a RTPBridge Candidates that can be used for a Jingle Media Transmission between two parties that are behind NAT.
* This Jingle Bridge has all the needed information to establish a full UDP Channel (Send and Receive) between two parties.
* This transport method should be used only if other transport methods are not allowed. Or if you want a more reliable transport.
- *
+ *
* High Level Usage Example:
- *
+ *
* RTPBridge rtpBridge = RTPBridge.getRTPBridge(connection, sessionID);
*
* @author Thiago Camargo
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/STUN.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/STUN.java
index c934fb5e0..ed0d54003 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/STUN.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/STUN.java
@@ -39,9 +39,9 @@ import org.xmlpull.v1.XmlPullParserException;
/**
* STUN IQ Stanza(/Packet) used to request and retrieve a STUN server and port to make p2p connections easier. STUN is usually used by Jingle Media Transmission between two parties that are behind NAT.
- *
+ *
* High Level Usage Example:
- *
+ *
* STUN stun = STUN.getSTUNServer(connection);
*
* @author Thiago Camargo
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/STUNResolver.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/STUNResolver.java
index 69abdb4bb..ed07da13d 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/STUNResolver.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/STUNResolver.java
@@ -199,7 +199,7 @@ public class STUNResolver extends TransportResolver {
/**
* Load a list of services: STUN servers and ports. Some public STUN servers
* are:
- *
+ *
*
* iphone-stun.freenet.de:3478
* larry.gloo.net:3478
@@ -212,7 +212,7 @@ public class STUNResolver extends TransportResolver {
* stun.voxgratia.org (no DNS SRV record)
* stun.noc.ams-ix.net
*
- *
+ *
* This list should be contained in a file in the "META-INF" directory
*
* @return a list of services
@@ -494,7 +494,7 @@ public class STUNResolver extends TransportResolver {
/**
* Check a binding with the STUN currentServer.
- *
+ *
* Note: this function blocks for some time, waiting for a response.
*
* @return true if the currentServer is usable.
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportCandidate.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportCandidate.java
index de55a860a..7c0900903 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportCandidate.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportCandidate.java
@@ -37,7 +37,7 @@ import org.jxmpp.jid.Jid;
/**
* Transport candidate.
- *
+ *
* A candidate represents the possible transport for data interchange between
* the two endpoints.
*
@@ -346,7 +346,7 @@ public abstract class TransportCandidate {
* Check if a transport candidate is usable. The transport resolver should
* check if the transport candidate the other endpoint has provided is
* usable.
- *
+ *
* Subclasses should provide better methods if they can...
*/
public void check(final List localCandidates) {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportNegotiator.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportNegotiator.java
index 783ef5501..4949cc6a3 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportNegotiator.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportNegotiator.java
@@ -45,12 +45,11 @@ import org.jivesoftware.smackx.jingleold.packet.JingleTransport.JingleTransportC
/**
* Transport negotiator.
- *
- *
+ *
* This class is responsible for managing the transport negotiation process,
* handling all the stanza(/packet) interchange and the stage control.
*
- * @author Alvaro Saurin
+ * @author Alvaro Saurin
*/
public abstract class TransportNegotiator extends JingleNegotiator {
@@ -829,7 +828,7 @@ public abstract class TransportNegotiator extends JingleNegotiator {
/**
* Raw-UDP transport negotiator.
*
- * @author Alvaro Saurin
+ * @author Alvaro Saurin
*/
public static final class RawUdp extends TransportNegotiator {
@@ -884,7 +883,7 @@ public abstract class TransportNegotiator extends JingleNegotiator {
/**
* Ice transport negotiator.
*
- * @author Alvaro Saurin
+ * @author Alvaro Saurin
*/
public static final class Ice extends TransportNegotiator {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportResolver.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportResolver.java
index d01b41718..54dc57bf2 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportResolver.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportResolver.java
@@ -37,7 +37,7 @@ import org.jivesoftware.smackx.jingleold.JingleSession;
* It is called candidate, because it can be elected or not.
*
* @author Thiago Camargo
- * @author Alvaro Saurin
+ * @author Alvaro Saurin
*/
public abstract class TransportResolver {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/Jingle.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/Jingle.java
index 092dd5b00..99608cd22 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/Jingle.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/Jingle.java
@@ -30,11 +30,11 @@ import org.jxmpp.jid.Jid;
/**
* An Jingle sub-packet, which is used by XMPP clients to exchange info like
- * descriptions and transports. The following link summarizes the
+ * descriptions and transports. The following link summarizes the
* requirements of Jingle IM: Valid tags.
- *
- * Warning: this is an non-standard protocol documented by XEP-166. Because this is
* a non-standard protocol, it is subject to change.
*
@@ -156,7 +156,7 @@ public class Jingle extends IQ {
* Set the session ID related to this session. The session ID is a unique
* identifier generated by the initiator. This should match the XML Nmtoken
* production so that XML character escaping is not needed for characters
- * such as &.
+ * such as &.
*
* @param sid the session ID
*/
@@ -168,7 +168,7 @@ public class Jingle extends IQ {
* Returns the session ID related to the session. The session ID is a unique
* identifier generated by the initiator. This should match the XML Nmtoken
* production so that XML character escaping is not needed for characters
- * such as &.
+ * such as &.
*
* @return Returns the session ID related to the session.
* @see #setSid(String)
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentDescription.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentDescription.java
index 6e5f163c2..7935cc87c 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentDescription.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentDescription.java
@@ -28,7 +28,7 @@ import org.jivesoftware.smackx.jingleold.media.PayloadType;
/**
* Jingle content description.
*
- * @author Alvaro Saurin
+ * @author Alvaro Saurin
*/
public abstract class JingleContentDescription implements ExtensionElement {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentInfo.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentInfo.java
index 9165c3805..4507a6175 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentInfo.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleContentInfo.java
@@ -23,7 +23,7 @@ import org.jivesoftware.smackx.jingleold.media.ContentInfo;
/**
* Jingle content info.
*
- * @author Alvaro Saurin
+ * @author Alvaro Saurin
*/
public class JingleContentInfo implements ExtensionElement {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleDescription.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleDescription.java
index 7745aafc3..1713cce6b 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleDescription.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleDescription.java
@@ -29,7 +29,7 @@ import org.jivesoftware.smackx.jingleold.media.PayloadType;
/**
* Jingle content description.
*
- * @author Alvaro Saurin
+ * @author Alvaro Saurin
*/
public abstract class JingleDescription implements ExtensionElement {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleTransport.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleTransport.java
index a523c5d6e..4f4807e9a 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleTransport.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/JingleTransport.java
@@ -29,7 +29,7 @@ import org.jivesoftware.smackx.jingleold.nat.TransportCandidate;
/**
* A jingle transport extension.
*
- * @author Alvaro Saurin
+ * @author Alvaro Saurin
*/
public class JingleTransport implements ExtensionElement {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentDescriptionProvider.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentDescriptionProvider.java
index 12f6b3d44..3d5de9e70 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentDescriptionProvider.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentDescriptionProvider.java
@@ -31,7 +31,7 @@ import org.xmlpull.v1.XmlPullParserException;
/**
* Parser for a Jingle description.
*
- * @author Alvaro Saurin
+ * @author Alvaro Saurin
*/
public abstract class JingleContentDescriptionProvider extends ExtensionElementProvider {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentProvider.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentProvider.java
index dc8fe3857..c8f08e0ce 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentProvider.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleContentProvider.java
@@ -23,7 +23,7 @@ import org.jivesoftware.smackx.jingleold.packet.JingleContent;
import org.xmlpull.v1.XmlPullParser;
/**
- * Jingle provider.
+ * Jingle <content> provider.
*
* @author Jeff Williams
*/
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleDescriptionProvider.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleDescriptionProvider.java
index a0265702d..b852014f2 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleDescriptionProvider.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleDescriptionProvider.java
@@ -30,7 +30,7 @@ import org.xmlpull.v1.XmlPullParserException;
/**
* Parser for a Jingle description.
*
- * @author Alvaro Saurin
+ * @author Alvaro Saurin
*/
public abstract class JingleDescriptionProvider extends ExtensionElementProvider {
diff --git a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleTransportProvider.java b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleTransportProvider.java
index 22b5ac4f0..c67f7af79 100644
--- a/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleTransportProvider.java
+++ b/smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/provider/JingleTransportProvider.java
@@ -32,7 +32,7 @@ import org.xmlpull.v1.XmlPullParserException;
/**
* Provider for a Jingle transport element.
*
- * @author Alvaro Saurin
+ * @author Alvaro Saurin
*/
public abstract class JingleTransportProvider extends ExtensionElementProvider {
diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java
index 6896d66d7..719e8e28c 100644
--- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java
+++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java
@@ -363,14 +363,14 @@ public class AgentSession {
* Sets the agent's current status with the workgroup. The presence mode affects
* how offers are routed to the agent. The possible presence modes with their
* meanings are as follows:
- *
+ *
* - Presence.Mode.AVAILABLE -- (Default) the agent is available for more chats
* (equivalent to Presence.Mode.CHAT).
*
- Presence.Mode.DO_NOT_DISTURB -- the agent is busy and should not be disturbed.
* However, special case, or extreme urgency chats may still be offered to the agent.
*
- Presence.Mode.AWAY -- the agent is not available and should not
* have a chat routed to them (equivalent to Presence.Mode.EXTENDED_AWAY).
- *
+ *
* The max chats value is the maximum number of chats the agent is willing to have
* routed to them at once. Some servers may be configured to only accept max chat
* values in a certain range; for example, between two and five. In that case, the
@@ -391,14 +391,14 @@ public class AgentSession {
/**
* Sets the agent's current status with the workgroup. The presence mode affects how offers
* are routed to the agent. The possible presence modes with their meanings are as follows:
- *
+ *
* - Presence.Mode.AVAILABLE -- (Default) the agent is available for more chats
* (equivalent to Presence.Mode.CHAT).
*
- Presence.Mode.DO_NOT_DISTURB -- the agent is busy and should not be disturbed.
* However, special case, or extreme urgency chats may still be offered to the agent.
*
- Presence.Mode.AWAY -- the agent is not available and should not
* have a chat routed to them (equivalent to Presence.Mode.EXTENDED_AWAY).
- *
+ *
* The max chats value is the maximum number of chats the agent is willing to have routed to
* them at once. Some servers may be configured to only accept max chat values in a certain
* range; for example, between two and five. In that case, the maxChats value the agent sends
@@ -450,7 +450,7 @@ public class AgentSession {
/**
* Sets the agent's current status with the workgroup. The presence mode affects how offers
* are routed to the agent. The possible presence modes with their meanings are as follows:
- *
+ *
* - Presence.Mode.AVAILABLE -- (Default) the agent is available for more chats
* (equivalent to Presence.Mode.CHAT).
*
- Presence.Mode.DO_NOT_DISTURB -- the agent is busy and should not be disturbed.
@@ -493,7 +493,7 @@ public class AgentSession {
/**
* Removes a user from the workgroup queue. This is an administrative action that the
- *
+ *
* The agent is not guaranteed of having privileges to perform this action; an exception
* denying the request may be thrown.
*
diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java
index c4af93326..5ab295c5a 100644
--- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java
+++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java
@@ -68,7 +68,7 @@ import org.jxmpp.jid.Jid;
* Provides workgroup services for users. Users can join the workgroup queue, depart the
* queue, find status information about their placement in the queue, and register to
* be notified when they are routed to an agent.
- *
+ *
* This class only provides a users perspective into a workgroup and is not intended
* for use by agents.
*
@@ -232,20 +232,20 @@ public class Workgroup {
* the queue, queue status events will be sent to indicate the user's position and
* estimated time left in the queue. Once joining the queue, there are three ways
* the user can leave the queue:
- *
+ *
* - The user is routed to an agent, which triggers a GroupChat invitation.
*
- The user asks to leave the queue by calling the {@link #departQueue} method.
*
- A server error occurs, or an administrator explicitly removes the user
* from the queue.
*
- *
+ *
* A user cannot request to join the queue again if already in the queue. Therefore,
* this method will throw an IllegalStateException if the user is already in the queue.
- *
+ *
* Some servers may be configured to require certain meta-data in order to
* join the queue. In that case, the {@link #joinQueue(Form)} method should be
* used instead of this method so that meta-data may be passed in.
- *
+ *
* The server tracks the conversations that a user has with agents over time. By
* default, that tracking is done using the user's JID. However, this is not always
* possible. For example, when the user is logged in anonymously using a web client.
@@ -271,19 +271,19 @@ public class Workgroup {
* the queue, queue status events will be sent to indicate the user's position and
* estimated time left in the queue. Once joining the queue, there are three ways
* the user can leave the queue:
- *
+ *
* - The user is routed to an agent, which triggers a GroupChat invitation.
*
- The user asks to leave the queue by calling the {@link #departQueue} method.
*
- A server error occurs, or an administrator explicitly removes the user
* from the queue.
*
- *
+ *
* A user cannot request to join the queue again if already in the queue. Therefore,
* this method will throw an IllegalStateException if the user is already in the queue.
- *
+ *
* Some servers may be configured to require certain meta-data in order to
* join the queue.
- *
+ *
* The server tracks the conversations that a user has with agents over time. By
* default, that tracking is done using the user's JID. However, this is not always
* possible. For example, when the user is logged in anonymously using a web client.
@@ -310,19 +310,19 @@ public class Workgroup {
* the queue, queue status events will be sent to indicate the user's position and
* estimated time left in the queue. Once joining the queue, there are three ways
* the user can leave the queue:
- *
+ *
* - The user is routed to an agent, which triggers a GroupChat invitation.
*
- The user asks to leave the queue by calling the {@link #departQueue} method.
*
- A server error occurs, or an administrator explicitly removes the user
* from the queue.
*
- *
+ *
* A user cannot request to join the queue again if already in the queue. Therefore,
* this method will throw an IllegalStateException if the user is already in the queue.
- *
+ *
* Some servers may be configured to require certain meta-data in order to
* join the queue.
- *
+ *
* The server tracks the conversations that a user has with agents over time. By
* default, that tracking is done using the user's JID. However, this is not always
* possible. For example, when the user is logged in anonymously using a web client.
@@ -359,19 +359,19 @@ public class Workgroup {
* the queue, queue status events will be sent to indicate the user's position and
* estimated time left in the queue. Once joining the queue, there are three ways
* the user can leave the queue:
- *
+ *
* - The user is routed to an agent, which triggers a GroupChat invitation.
*
- The user asks to leave the queue by calling the {@link #departQueue} method.
*
- A server error occurs, or an administrator explicitly removes the user
* from the queue.
*
- *
+ *
* A user cannot request to join the queue again if already in the queue. Therefore,
* this method will throw an IllegalStateException if the user is already in the queue.
- *
+ *
* Some servers may be configured to require certain meta-data in order to
* join the queue.
- *
+ *
* The server tracks the conversations that a user has with agents over time. By
* default, that tracking is done using the user's JID. However, this is not always
* possible. For example, when the user is logged in anonymously using a web client.
@@ -413,7 +413,7 @@ public class Workgroup {
/**
* Departs the workgroup queue. If the user is not currently in the queue, this
* method will do nothing.
- *
+ *
* Normally, the user would not manually leave the queue. However, they may wish to
* under certain circumstances -- for example, if they no longer wish to be routed
* to an agent because they've been waiting too long.
diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/util/MetaDataUtils.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/util/MetaDataUtils.java
index fc52e1856..514bf21e0 100644
--- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/util/MetaDataUtils.java
+++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/util/MetaDataUtils.java
@@ -84,7 +84,7 @@ public class MetaDataUtils {
/**
* Serializes a Map of String name/value pairs into the meta-data XML format.
*
- * @param metaData the Map of meta-data as Map<String,List<String>>
+ * @param metaData the Map of meta-data as Map<String,List<String>>
* @return the meta-data values in XML form.
*/
public static String serializeMetaData(Map> metaData) {
diff --git a/smack-tcp/src/main/java/org/jivesoftware/smack/tcp/XMPPTCPConnection.java b/smack-tcp/src/main/java/org/jivesoftware/smack/tcp/XMPPTCPConnection.java
index 038ec6e1b..76f197676 100644
--- a/smack-tcp/src/main/java/org/jivesoftware/smack/tcp/XMPPTCPConnection.java
+++ b/smack-tcp/src/main/java/org/jivesoftware/smack/tcp/XMPPTCPConnection.java
@@ -1670,8 +1670,8 @@ public class XMPPTCPConnection extends AbstractXMPPConnection {
* Send a unconditional Stream Management acknowledgment to the server.
*
* See XEP-198: Stream Management § 4. Acks:
- * "Either party MAY send an element at any time (e.g., after it has received a certain number of stanzas,
- * or after a certain period of time), even if it has not received an element from the other party."
+ * "Either party MAY send an <a/> element at any time (e.g., after it has received a certain number of stanzas,
+ * or after a certain period of time), even if it has not received an <r/> element from the other party."
*
*
* @throws StreamManagementNotEnabledException if Stream Management is not enabled.