mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-11-22 12:02:05 +01:00
Globally s;Stanza(/Packet);Stanza; and more 'packet' → 'stanza'
This commit is contained in:
parent
98109e7b86
commit
cc0022c919
32 changed files with 99 additions and 99 deletions
|
@ -18,7 +18,7 @@
|
||||||
package org.jivesoftware.smack.packet;
|
package org.jivesoftware.smack.packet;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A mock implementation of the Stanza(/Packet) abstract class. Implements toXML() by returning null.
|
* A mock implementation of the Stanza abstract class. Implements toXML() by returning null.
|
||||||
*/
|
*/
|
||||||
public class MockPacket extends Packet {
|
public class MockPacket extends Packet {
|
||||||
|
|
||||||
|
|
|
@ -207,50 +207,50 @@ public interface XMPPConnection {
|
||||||
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException;
|
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a new stanza collector collecting packets that are replies to <code>packet</code>.
|
* Creates a new stanza collector collecting IQ responses that are replies to the IQ <code>request</code>.
|
||||||
* Does also send <code>packet</code>. The stanza filter for the collector is an
|
* Does also send the <code>request</code> IQ. The stanza filter for the collector is an
|
||||||
* {@link IQReplyFilter}, guaranteeing that stanza id and JID in the 'from' address have
|
* {@link IQReplyFilter}, guaranteeing that stanza id and JID in the 'from' address have
|
||||||
* expected values.
|
* expected values.
|
||||||
*
|
*
|
||||||
* @param packet the stanza to filter responses from
|
* @param request the IQ request to filter responses from
|
||||||
* @return a new stanza collector.
|
* @return a new stanza collector.
|
||||||
* @throws NotConnectedException
|
* @throws NotConnectedException
|
||||||
* @throws InterruptedException
|
* @throws InterruptedException
|
||||||
*/
|
*/
|
||||||
StanzaCollector createStanzaCollectorAndSend(IQ packet) throws NotConnectedException, InterruptedException;
|
StanzaCollector createStanzaCollectorAndSend(IQ request) throws NotConnectedException, InterruptedException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a new stanza collector for this connection. A stanza filter determines
|
* Creates a new stanza collector for this connection. A stanza filter determines
|
||||||
* which packets will be accumulated by the collector. A StanzaCollector is
|
* which stanzas will be accumulated by the collector. A StanzaCollector is
|
||||||
* more suitable to use than a {@link StanzaListener} when you need to wait for
|
* more suitable to use than a {@link StanzaListener} when you need to wait for
|
||||||
* a specific result.
|
* a specific result.
|
||||||
*
|
*
|
||||||
* @param packetFilter the stanza filter to use.
|
* @param stanzaFilter the stanza filter to use.
|
||||||
* @param packet the packet to send right after the collector got created
|
* @param stanza the stanza to send right after the collector got created
|
||||||
* @return a new stanza collector.
|
* @return a new stanza collector.
|
||||||
* @throws InterruptedException
|
* @throws InterruptedException
|
||||||
* @throws NotConnectedException
|
* @throws NotConnectedException
|
||||||
*/
|
*/
|
||||||
StanzaCollector createStanzaCollectorAndSend(StanzaFilter packetFilter, Stanza packet)
|
StanzaCollector createStanzaCollectorAndSend(StanzaFilter stanzaFilter, Stanza stanza)
|
||||||
throws NotConnectedException, InterruptedException;
|
throws NotConnectedException, InterruptedException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a new stanza collector for this connection. A stanza filter
|
* Creates a new stanza collector for this connection. A stanza filter
|
||||||
* determines which packets will be accumulated by the collector. A
|
* determines which stanzas will be accumulated by the collector. A
|
||||||
* StanzaCollector is more suitable to use than a {@link StanzaListener}
|
* StanzaCollector is more suitable to use than a {@link StanzaListener}
|
||||||
* when you need to wait for a specific result.
|
* when you need to wait for a specific result.
|
||||||
* <p>
|
* <p>
|
||||||
* <b>Note:</b> If you send a Stanza(/Packet) right after using this method, then
|
* <b>Note:</b> If you send a Stanza right after using this method, then
|
||||||
* consider using
|
* consider using
|
||||||
* {@link #createStanzaCollectorAndSend(StanzaFilter, Stanza)} instead.
|
* {@link #createStanzaCollectorAndSend(StanzaFilter, Stanza)} instead.
|
||||||
* Otherwise make sure cancel the StanzaCollector in every case, e.g. even
|
* Otherwise make sure cancel the StanzaCollector in every case, e.g. even
|
||||||
* if an exception is thrown, or otherwise you may leak the StanzaCollector.
|
* if an exception is thrown, or otherwise you may leak the StanzaCollector.
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* @param packetFilter the stanza filter to use.
|
* @param stanzaFilter the stanza filter to use.
|
||||||
* @return a new stanza collector.
|
* @return a new stanza collector.
|
||||||
*/
|
*/
|
||||||
StanzaCollector createStanzaCollector(StanzaFilter packetFilter);
|
StanzaCollector createStanzaCollector(StanzaFilter stanzaFilter);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a new stanza collector with the given stanza collector configuration.
|
* Create a new stanza collector with the given stanza collector configuration.
|
||||||
|
@ -274,35 +274,35 @@ public interface XMPPConnection {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Registers a <b>synchronous</b> stanza listener with this connection. A stanza listener will be invoked only when
|
* Registers a <b>synchronous</b> stanza listener with this connection. A stanza listener will be invoked only when
|
||||||
* an incoming stanza is received. A stanza filter determines which packets will be delivered to the listener. If
|
* an incoming stanza is received. A stanza filter determines which stanzas will be delivered to the listener. If
|
||||||
* the same stanza listener is added again with a different filter, only the new filter will be used.
|
* the same stanza listener is added again with a different filter, only the new filter will be used.
|
||||||
* <p>
|
* <p>
|
||||||
* <b>Important:</b> This stanza listeners will be called in the same <i>single</i> thread that processes all
|
* <b>Important:</b> This stanza listeners will be called in the same <i>single</i> thread that processes all
|
||||||
* incoming stanzas. Only use this kind of stanza filter if it does not perform any XMPP activity that waits for a
|
* incoming stanzas. Only use this kind of stanza filter if it does not perform any XMPP activity that waits for a
|
||||||
* response. Consider using {@link #addAsyncStanzaListener(StanzaListener, StanzaFilter)} when possible, i.e. when
|
* response. Consider using {@link #addAsyncStanzaListener(StanzaListener, StanzaFilter)} when possible, i.e. when
|
||||||
* the invocation order doesn't have to be the same as the order of the arriving packets. If the order of the
|
* the invocation order doesn't have to be the same as the order of the arriving stanzas. If the order of the
|
||||||
* arriving packets, consider using a {@link StanzaCollector} when possible.
|
* arriving stanzas, consider using a {@link StanzaCollector} when possible.
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* @param packetListener the stanza listener to notify of new received packets.
|
* @param stanzaListener the stanza listener to notify of new received stanzas.
|
||||||
* @param packetFilter the stanza filter to use.
|
* @param stanzaFilter the stanza filter to use.
|
||||||
* @see #addStanzaInterceptor(StanzaListener, StanzaFilter)
|
* @see #addStanzaInterceptor(StanzaListener, StanzaFilter)
|
||||||
* @since 4.1
|
* @since 4.1
|
||||||
*/
|
*/
|
||||||
void addSyncStanzaListener(StanzaListener packetListener, StanzaFilter packetFilter);
|
void addSyncStanzaListener(StanzaListener stanzaListener, StanzaFilter stanzaFilter);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Removes a stanza listener for received packets from this connection.
|
* Removes a stanza listener for received stanzas from this connection.
|
||||||
*
|
*
|
||||||
* @param packetListener the stanza listener to remove.
|
* @param stanzaListener the stanza listener to remove.
|
||||||
* @return true if the stanza listener was removed
|
* @return true if the stanza listener was removed
|
||||||
* @since 4.1
|
* @since 4.1
|
||||||
*/
|
*/
|
||||||
boolean removeSyncStanzaListener(StanzaListener packetListener);
|
boolean removeSyncStanzaListener(StanzaListener stanzaListener);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Registers an <b>asynchronous</b> stanza listener with this connection. A stanza listener will be invoked only
|
* Registers an <b>asynchronous</b> stanza listener with this connection. A stanza listener will be invoked only
|
||||||
* when an incoming stanza is received. A stanza filter determines which packets will be delivered to the listener.
|
* when an incoming stanza is received. A stanza filter determines which stanzas will be delivered to the listener.
|
||||||
* If the same stanza listener is added again with a different filter, only the new filter will be used.
|
* If the same stanza listener is added again with a different filter, only the new filter will be used.
|
||||||
* <p>
|
* <p>
|
||||||
* Unlike {@link #addAsyncStanzaListener(StanzaListener, StanzaFilter)} stanza listeners added with this method will be
|
* Unlike {@link #addAsyncStanzaListener(StanzaListener, StanzaFilter)} stanza listeners added with this method will be
|
||||||
|
@ -310,117 +310,117 @@ public interface XMPPConnection {
|
||||||
* on the order how the stanzas where received.
|
* on the order how the stanzas where received.
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* @param packetListener the stanza listener to notify of new received packets.
|
* @param stanzaListener the stanza listener to notify of new received stanzas.
|
||||||
* @param packetFilter the stanza filter to use.
|
* @param stanzaFilter the stanza filter to use.
|
||||||
* @see #addStanzaInterceptor(StanzaListener, StanzaFilter)
|
* @see #addStanzaInterceptor(StanzaListener, StanzaFilter)
|
||||||
* @since 4.1
|
* @since 4.1
|
||||||
*/
|
*/
|
||||||
void addAsyncStanzaListener(StanzaListener packetListener, StanzaFilter packetFilter);
|
void addAsyncStanzaListener(StanzaListener stanzaListener, StanzaFilter stanzaFilter);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Removes an <b>asynchronous</b> stanza listener for received packets from this connection.
|
* Removes an <b>asynchronous</b> stanza listener for received stanzas from this connection.
|
||||||
*
|
*
|
||||||
* @param packetListener the stanza listener to remove.
|
* @param stanzaListener the stanza listener to remove.
|
||||||
* @return true if the stanza listener was removed
|
* @return true if the stanza listener was removed
|
||||||
* @since 4.1
|
* @since 4.1
|
||||||
*/
|
*/
|
||||||
boolean removeAsyncStanzaListener(StanzaListener packetListener);
|
boolean removeAsyncStanzaListener(StanzaListener stanzaListener);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Registers a stanza listener with this connection. The listener will be
|
* Registers a stanza listener with this connection. The listener will be
|
||||||
* notified of every stanza that this connection sends. A stanza filter determines
|
* notified of every stanza that this connection sends. A stanza filter determines
|
||||||
* which packets will be delivered to the listener. Note that the thread
|
* which stanzas will be delivered to the listener. Note that the thread
|
||||||
* that writes packets will be used to invoke the listeners. Therefore, each
|
* that writes stanzas will be used to invoke the listeners. Therefore, each
|
||||||
* stanza listener should complete all operations quickly or use a different
|
* stanza listener should complete all operations quickly or use a different
|
||||||
* thread for processing.
|
* thread for processing.
|
||||||
*
|
*
|
||||||
* @param packetListener the stanza listener to notify of sent packets.
|
* @param stanzaListener the stanza listener to notify of sent stanzas.
|
||||||
* @param packetFilter the stanza filter to use.
|
* @param stanzaFilter the stanza filter to use.
|
||||||
* @deprecated use {@link #addStanzaSendingListener} instead
|
* @deprecated use {@link #addStanzaSendingListener} instead
|
||||||
*/
|
*/
|
||||||
// TODO Remove in Smack 4.4
|
// TODO Remove in Smack 4.4
|
||||||
@Deprecated
|
@Deprecated
|
||||||
void addPacketSendingListener(StanzaListener packetListener, StanzaFilter packetFilter);
|
void addPacketSendingListener(StanzaListener stanzaListener, StanzaFilter stanzaFilter);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Registers a stanza listener with this connection. The listener will be
|
* Registers a stanza listener with this connection. The listener will be
|
||||||
* notified of every stanza that this connection sends. A stanza filter determines
|
* notified of every stanza that this connection sends. A stanza filter determines
|
||||||
* which packets will be delivered to the listener. Note that the thread
|
* which stanzas will be delivered to the listener. Note that the thread
|
||||||
* that writes packets will be used to invoke the listeners. Therefore, each
|
* that writes stanzas will be used to invoke the listeners. Therefore, each
|
||||||
* stanza listener should complete all operations quickly or use a different
|
* stanza listener should complete all operations quickly or use a different
|
||||||
* thread for processing.
|
* thread for processing.
|
||||||
*
|
*
|
||||||
* @param packetListener the stanza listener to notify of sent packets.
|
* @param stanzaListener the stanza listener to notify of sent stanzas.
|
||||||
* @param packetFilter the stanza filter to use.
|
* @param stanzaFilter the stanza filter to use.
|
||||||
*/
|
*/
|
||||||
void addStanzaSendingListener(StanzaListener packetListener, StanzaFilter packetFilter);
|
void addStanzaSendingListener(StanzaListener stanzaListener, StanzaFilter stanzaFilter);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Removes a stanza listener for sending packets from this connection.
|
* Removes a stanza listener for sending stanzas from this connection.
|
||||||
*
|
*
|
||||||
* @param packetListener the stanza listener to remove.
|
* @param stanzaListener the stanza listener to remove.
|
||||||
* @deprecated use {@link #removeStanzaSendingListener} instead
|
* @deprecated use {@link #removeStanzaSendingListener} instead
|
||||||
*/
|
*/
|
||||||
// TODO Remove in Smack 4.4
|
// TODO Remove in Smack 4.4
|
||||||
@Deprecated
|
@Deprecated
|
||||||
void removePacketSendingListener(StanzaListener packetListener);
|
void removePacketSendingListener(StanzaListener stanzaListener);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Removes a stanza listener for sending packets from this connection.
|
* Removes a stanza listener for sending stanzas from this connection.
|
||||||
*
|
*
|
||||||
* @param packetListener the stanza listener to remove.
|
* @param stanzaListener the stanza listener to remove.
|
||||||
*/
|
*/
|
||||||
void removeStanzaSendingListener(StanzaListener packetListener);
|
void removeStanzaSendingListener(StanzaListener stanzaListener);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Registers a stanza interceptor with this connection. The interceptor will be
|
* Registers a stanza interceptor with this connection. The interceptor will be
|
||||||
* invoked every time a stanza is about to be sent by this connection. Interceptors
|
* invoked every time a stanza is about to be sent by this connection. Interceptors
|
||||||
* may modify the stanza to be sent. A stanza filter determines which packets
|
* may modify the stanza to be sent. A stanza filter determines which stanzas
|
||||||
* will be delivered to the interceptor.
|
* will be delivered to the interceptor.
|
||||||
*
|
*
|
||||||
* <p>
|
* <p>
|
||||||
* NOTE: For a similar functionality on incoming packets, see {@link #addAsyncStanzaListener(StanzaListener, StanzaFilter)}.
|
* NOTE: For a similar functionality on incoming stanzas, see {@link #addAsyncStanzaListener(StanzaListener, StanzaFilter)}.
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* @param packetInterceptor the stanza interceptor to notify of packets about to be sent.
|
* @param stanzaInterceptor the stanza interceptor to notify of stanzas about to be sent.
|
||||||
* @param packetFilter the stanza filter to use.
|
* @param stanzaFilter the stanza filter to use.
|
||||||
* @deprecated use {@link #addStanzaInterceptor} instead
|
* @deprecated use {@link #addStanzaInterceptor} instead
|
||||||
*/
|
*/
|
||||||
// TODO Remove in Smack 4.4
|
// TODO Remove in Smack 4.4
|
||||||
@Deprecated
|
@Deprecated
|
||||||
void addPacketInterceptor(StanzaListener packetInterceptor, StanzaFilter packetFilter);
|
void addPacketInterceptor(StanzaListener stanzaInterceptor, StanzaFilter stanzaFilter);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Registers a stanza interceptor with this connection. The interceptor will be
|
* Registers a stanza interceptor with this connection. The interceptor will be
|
||||||
* invoked every time a stanza is about to be sent by this connection. Interceptors
|
* invoked every time a stanza is about to be sent by this connection. Interceptors
|
||||||
* may modify the stanza to be sent. A stanza filter determines which packets
|
* may modify the stanza to be sent. A stanza filter determines which stanzas
|
||||||
* will be delivered to the interceptor.
|
* will be delivered to the interceptor.
|
||||||
*
|
*
|
||||||
* <p>
|
* <p>
|
||||||
* NOTE: For a similar functionality on incoming packets, see {@link #addAsyncStanzaListener(StanzaListener, StanzaFilter)}.
|
* NOTE: For a similar functionality on incoming stanzas, see {@link #addAsyncStanzaListener(StanzaListener, StanzaFilter)}.
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* @param packetInterceptor the stanza interceptor to notify of packets about to be sent.
|
* @param stanzaInterceptor the stanza interceptor to notify of stanzas about to be sent.
|
||||||
* @param packetFilter the stanza filter to use.
|
* @param stanzaFilter the stanza filter to use.
|
||||||
*/
|
*/
|
||||||
void addStanzaInterceptor(StanzaListener packetInterceptor, StanzaFilter packetFilter);
|
void addStanzaInterceptor(StanzaListener stanzaInterceptor, StanzaFilter stanzaFilter);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Removes a stanza interceptor.
|
* Removes a stanza interceptor.
|
||||||
*
|
*
|
||||||
* @param packetInterceptor the stanza interceptor to remove.
|
* @param stanzaInterceptor the stanza interceptor to remove.
|
||||||
* @deprecated user {@link #removeStanzaInterceptor} instead
|
* @deprecated user {@link #removeStanzaInterceptor} instead
|
||||||
*/
|
*/
|
||||||
// TODO Remove in Smack 4.4
|
// TODO Remove in Smack 4.4
|
||||||
@Deprecated
|
@Deprecated
|
||||||
void removePacketInterceptor(StanzaListener packetInterceptor);
|
void removePacketInterceptor(StanzaListener stanzaInterceptor);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Removes a stanza interceptor.
|
* Removes a stanza interceptor.
|
||||||
*
|
*
|
||||||
* @param packetInterceptor the stanza interceptor to remove.
|
* @param stanzaInterceptor the stanza interceptor to remove.
|
||||||
*/
|
*/
|
||||||
void removeStanzaInterceptor(StanzaListener packetInterceptor);
|
void removeStanzaInterceptor(StanzaListener stanzaInterceptor);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the current value of the reply timeout in milliseconds for request for this
|
* Returns the current value of the reply timeout in milliseconds for request for this
|
||||||
|
@ -662,9 +662,9 @@ public interface XMPPConnection {
|
||||||
* stanza filter.
|
* stanza filter.
|
||||||
*
|
*
|
||||||
* @param callback the callback invoked once the stanza filter matches a stanza.
|
* @param callback the callback invoked once the stanza filter matches a stanza.
|
||||||
* @param packetFilter the filter to match stanzas or null to match all.
|
* @param stanzaFilter the filter to match stanzas or null to match all.
|
||||||
*/
|
*/
|
||||||
void addOneTimeSyncCallback(StanzaListener callback, StanzaFilter packetFilter);
|
void addOneTimeSyncCallback(StanzaListener callback, StanzaFilter stanzaFilter);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Register an IQ request handler with this connection.
|
* Register an IQ request handler with this connection.
|
||||||
|
|
|
@ -18,7 +18,7 @@
|
||||||
package org.jivesoftware.smack.filter;
|
package org.jivesoftware.smack.filter;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Defines a way to filter packets for particular attributes. Stanza(/Packet) filters are used when
|
* Defines a way to filter packets for particular attributes. Stanza filters are used when
|
||||||
* constructing stanza listeners or collectors -- the filter defines what packets match the criteria
|
* constructing stanza listeners or collectors -- the filter defines what packets match the criteria
|
||||||
* of the collector or listener for further stanza processing.
|
* of the collector or listener for further stanza processing.
|
||||||
* <p>
|
* <p>
|
||||||
|
|
|
@ -161,7 +161,7 @@ public interface Packet extends TopLevelStreamElement {
|
||||||
/**
|
/**
|
||||||
* Returns the first stanza extension that matches the specified element name and
|
* Returns the first stanza extension that matches the specified element name and
|
||||||
* namespace, or <tt>null</tt> if it doesn't exist. If the provided elementName is null,
|
* namespace, or <tt>null</tt> if it doesn't exist. If the provided elementName is null,
|
||||||
* only the namespace is matched. Stanza(/Packet) extensions are
|
* only the namespace is matched. Stanza extensions are
|
||||||
* are arbitrary XML sub-documents in standard XMPP packets. By default, a
|
* are arbitrary XML sub-documents in standard XMPP packets. By default, a
|
||||||
* DefaultPacketExtension instance will be returned for each extension. However,
|
* DefaultPacketExtension instance will be returned for each extension. However,
|
||||||
* PacketExtensionProvider instances can be registered with the
|
* PacketExtensionProvider instances can be registered with the
|
||||||
|
|
|
@ -34,7 +34,7 @@ import org.jxmpp.stringprep.XmppStringprepException;
|
||||||
import org.jxmpp.util.XmppStringUtils;
|
import org.jxmpp.util.XmppStringUtils;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Base class for XMPP Stanzas, which are called Stanza(/Packet) in older versions of Smack (i.e. < 4.1).
|
* Base class for XMPP Stanzas, which are called Stanza in older versions of Smack (i.e. < 4.1).
|
||||||
* <p>
|
* <p>
|
||||||
* Every stanza has a unique ID (which is automatically generated, but can be overridden). Stanza
|
* Every stanza has a unique ID (which is automatically generated, but can be overridden). Stanza
|
||||||
* IDs are required for IQ stanzas and recommended for presence and message stanzas. Optionally, the
|
* IDs are required for IQ stanzas and recommended for presence and message stanzas. Optionally, the
|
||||||
|
|
|
@ -23,7 +23,7 @@ import org.jivesoftware.smack.util.XmlStringBuilder;
|
||||||
import org.jivesoftware.smackx.forward.packet.Forwarded;
|
import org.jivesoftware.smackx.forward.packet.Forwarded;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension for XEP-0280: Message Carbons. The extension
|
* Stanza extension for XEP-0280: Message Carbons. The extension
|
||||||
* <a href="http://xmpp.org/extensions/xep-0280.html">XEP-0280</a> is
|
* <a href="http://xmpp.org/extensions/xep-0280.html">XEP-0280</a> is
|
||||||
* meant to synchronize a message flow to multiple presences of a user.
|
* meant to synchronize a message flow to multiple presences of a user.
|
||||||
*
|
*
|
||||||
|
@ -129,7 +129,7 @@ public class CarbonExtension implements ExtensionElement {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension indicating that a message may not be carbon-copied. Adding this
|
* Stanza extension indicating that a message may not be carbon-copied. Adding this
|
||||||
* extension to any message will disallow that message from being copied.
|
* extension to any message will disallow that message from being copied.
|
||||||
*/
|
*/
|
||||||
public static final class Private implements ExtensionElement {
|
public static final class Private implements ExtensionElement {
|
||||||
|
|
|
@ -23,7 +23,7 @@ import org.jivesoftware.smack.util.XmlStringBuilder;
|
||||||
import org.jivesoftware.smackx.hoxt.HOXTManager;
|
import org.jivesoftware.smackx.hoxt.HOXTManager;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension for base64 binary chunks.<p>
|
* Stanza extension for base64 binary chunks.<p>
|
||||||
* This class is immutable.
|
* This class is immutable.
|
||||||
*
|
*
|
||||||
* @author Andriy Tsykholyas
|
* @author Andriy Tsykholyas
|
||||||
|
|
|
@ -26,7 +26,7 @@ import org.xmlpull.v1.XmlPullParser;
|
||||||
import org.xmlpull.v1.XmlPullParserException;
|
import org.xmlpull.v1.XmlPullParserException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) provider for base64 binary chunks.
|
* Stanza provider for base64 binary chunks.
|
||||||
*
|
*
|
||||||
* @author Andriy Tsykholyas
|
* @author Andriy Tsykholyas
|
||||||
* @see <a href="http://xmpp.org/extensions/xep-0332.html">XEP-0332: HTTP over XMPP transport</a>
|
* @see <a href="http://xmpp.org/extensions/xep-0332.html">XEP-0332: HTTP over XMPP transport</a>
|
||||||
|
|
|
@ -289,7 +289,7 @@ public class MultipleRecipientManager {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) that holds the XML stanza to send. This class is useful when the same packet
|
* Stanza that holds the XML stanza to send. This class is useful when the same packet
|
||||||
* is needed to be sent to different recipients. Since using the same stanza is not possible
|
* is needed to be sent to different recipients. Since using the same stanza is not possible
|
||||||
* (i.e. cannot change the TO address of a queues stanza to be sent) then this class was
|
* (i.e. cannot change the TO address of a queues stanza to be sent) then this class was
|
||||||
* created to keep the XML stanza to send.
|
* created to keep the XML stanza to send.
|
||||||
|
|
|
@ -27,7 +27,7 @@ import org.jivesoftware.smack.util.XmlStringBuilder;
|
||||||
import org.jxmpp.jid.Jid;
|
import org.jxmpp.jid.Jid;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension that contains the list of addresses that a stanza should be sent or was sent.
|
* Stanza extension that contains the list of addresses that a stanza should be sent or was sent.
|
||||||
*
|
*
|
||||||
* @author Gaston Dombiak
|
* @author Gaston Dombiak
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -694,7 +694,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
|
||||||
* Specified in XEP-65 5.3.1 (Example 13)
|
* Specified in XEP-65 5.3.1 (Example 13)
|
||||||
* </p>
|
* </p>
|
||||||
*
|
*
|
||||||
* @param packet Stanza(/Packet) that should be answered with a not-acceptable error
|
* @param packet Stanza that should be answered with a not-acceptable error
|
||||||
* @throws NotConnectedException
|
* @throws NotConnectedException
|
||||||
* @throws InterruptedException
|
* @throws InterruptedException
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -260,7 +260,7 @@ public class Bytestream extends IQ {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension that represents a potential SOCKS5 proxy for the file transfer. Stream hosts
|
* Stanza extension that represents a potential SOCKS5 proxy for the file transfer. Stream hosts
|
||||||
* are forwarded to the target of the file transfer who then chooses and connects to one.
|
* are forwarded to the target of the file transfer who then chooses and connects to one.
|
||||||
*
|
*
|
||||||
* @author Alexander Wenckus
|
* @author Alexander Wenckus
|
||||||
|
|
|
@ -1024,7 +1024,7 @@ public class MultiUserChat {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds a new {@link StanzaListener} that will be invoked every time a new presence
|
* Adds a new {@link StanzaListener} that will be invoked every time a new presence
|
||||||
* is going to be sent by this MultiUserChat to the server. Stanza(/Packet) interceptors may
|
* is going to be sent by this MultiUserChat to the server. Stanza interceptors may
|
||||||
* add new extensions to the presence that is going to be sent to the MUC service.
|
* add new extensions to the presence that is going to be sent to the MUC service.
|
||||||
*
|
*
|
||||||
* @param presenceInterceptor the new stanza interceptor that will intercept presence packets.
|
* @param presenceInterceptor the new stanza interceptor that will intercept presence packets.
|
||||||
|
@ -1035,7 +1035,7 @@ public class MultiUserChat {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Removes a {@link StanzaListener} that was being invoked every time a new presence
|
* Removes a {@link StanzaListener} that was being invoked every time a new presence
|
||||||
* was being sent by this MultiUserChat to the server. Stanza(/Packet) interceptors may
|
* was being sent by this MultiUserChat to the server. Stanza interceptors may
|
||||||
* add new extensions to the presence that is going to be sent to the MUC service.
|
* add new extensions to the presence that is going to be sent to the MUC service.
|
||||||
*
|
*
|
||||||
* @param presenceInterceptor the stanza interceptor to remove.
|
* @param presenceInterceptor the stanza interceptor to remove.
|
||||||
|
|
|
@ -56,7 +56,7 @@ import org.jxmpp.jid.Jid;
|
||||||
* </p>
|
* </p>
|
||||||
* <pre>
|
* <pre>
|
||||||
* deliveryReceiptManager.addReceiptReceivedListener(new ReceiptReceivedListener() {
|
* deliveryReceiptManager.addReceiptReceivedListener(new ReceiptReceivedListener() {
|
||||||
* void onReceiptReceived(String fromJid, String toJid, String receiptId, Stanza(/Packet) receipt) {
|
* void onReceiptReceived(String fromJid, String toJid, String receiptId, Stanza receipt) {
|
||||||
* // If the receiving entity does not support delivery receipts,
|
* // If the receiving entity does not support delivery receipts,
|
||||||
* // then the receipt received listener may not get invoked.
|
* // then the receipt received listener may not get invoked.
|
||||||
* }
|
* }
|
||||||
|
@ -296,7 +296,7 @@ public final class DeliveryReceiptManager extends Manager {
|
||||||
/**
|
/**
|
||||||
* Test if a message requires a delivery receipt.
|
* Test if a message requires a delivery receipt.
|
||||||
*
|
*
|
||||||
* @param message Stanza(/Packet) object to check for a DeliveryReceiptRequest
|
* @param message Stanza object to check for a DeliveryReceiptRequest
|
||||||
*
|
*
|
||||||
* @return true if a delivery receipt was requested
|
* @return true if a delivery receipt was requested
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -57,7 +57,7 @@ public class ConnectionUtils {
|
||||||
* <code>
|
* <code>
|
||||||
* StanzaCollector collector = connection.createStanzaCollector(new PacketFilter());
|
* StanzaCollector collector = connection.createStanzaCollector(new PacketFilter());
|
||||||
* connection.sendStanza(packet);
|
* connection.sendStanza(packet);
|
||||||
* Stanza(/Packet) reply = collector.nextResult();
|
* Stanza reply = collector.nextResult();
|
||||||
* </code>
|
* </code>
|
||||||
* </pre>
|
* </pre>
|
||||||
*
|
*
|
||||||
|
|
|
@ -42,7 +42,7 @@ import org.xmlpull.v1.XmlPullParser;
|
||||||
import org.xmlpull.v1.XmlPullParserException;
|
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.
|
* RTPBridge IQ Stanza 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 Jingle Bridge has all the needed information to establish a full UDP Channel (Send and Receive) between two parties.
|
||||||
* <i>This transport method should be used only if other transport methods are not allowed. Or if you want a more reliable transport.</i>
|
* <i>This transport method should be used only if other transport methods are not allowed. Or if you want a more reliable transport.</i>
|
||||||
*
|
*
|
||||||
|
@ -123,7 +123,7 @@ public class RTPBridge extends IQ {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a RTPBridge Stanza(/Packet) without Session ID.
|
* Creates a RTPBridge Stanza without Session ID.
|
||||||
*/
|
*/
|
||||||
public RTPBridge() {
|
public RTPBridge() {
|
||||||
super(ELEMENT_NAME, NAMESPACE);
|
super(ELEMENT_NAME, NAMESPACE);
|
||||||
|
@ -157,7 +157,7 @@ public class RTPBridge extends IQ {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the Session ID of the Stanza(/Packet) (usually same as Jingle Session ID).
|
* Get the Session ID of the Stanza (usually same as Jingle Session ID).
|
||||||
*
|
*
|
||||||
* @return the session ID
|
* @return the session ID
|
||||||
*/
|
*/
|
||||||
|
@ -166,7 +166,7 @@ public class RTPBridge extends IQ {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the Session ID of the Stanza(/Packet) (usually same as Jingle Session ID).
|
* Set the Session ID of the Stanza (usually same as Jingle Session ID).
|
||||||
*
|
*
|
||||||
* @param sid
|
* @param sid
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -38,7 +38,7 @@ import org.xmlpull.v1.XmlPullParser;
|
||||||
import org.xmlpull.v1.XmlPullParserException;
|
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.
|
* STUN IQ Stanza 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:
|
* High Level Usage Example:
|
||||||
*
|
*
|
||||||
|
|
|
@ -192,7 +192,7 @@ public class Offer {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) for rejecting offers.
|
* Stanza for rejecting offers.
|
||||||
*/
|
*/
|
||||||
private class RejectPacket extends IQ {
|
private class RejectPacket extends IQ {
|
||||||
|
|
||||||
|
@ -211,7 +211,7 @@ public class Offer {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) for accepting an offer.
|
* Stanza for accepting an offer.
|
||||||
*/
|
*/
|
||||||
private class AcceptPacket extends IQ {
|
private class AcceptPacket extends IQ {
|
||||||
|
|
||||||
|
|
|
@ -97,7 +97,7 @@ public class OfferConfirmation extends SimpleIQ {
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) for notifying server of RoomName
|
* Stanza for notifying server of RoomName
|
||||||
*/
|
*/
|
||||||
private static class NotifyServicePacket extends IQ {
|
private static class NotifyServicePacket extends IQ {
|
||||||
String roomName;
|
String roomName;
|
||||||
|
|
|
@ -88,7 +88,7 @@ public class AgentChatHistory extends IQ {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension provider for AgentHistory packets.
|
* Stanza extension provider for AgentHistory packets.
|
||||||
*/
|
*/
|
||||||
public static class InternalProvider extends IQProvider<AgentChatHistory> {
|
public static class InternalProvider extends IQProvider<AgentChatHistory> {
|
||||||
|
|
||||||
|
|
|
@ -232,7 +232,7 @@ public class AgentStatus implements ExtensionElement {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension provider for AgentStatus packets.
|
* Stanza extension provider for AgentStatus packets.
|
||||||
*/
|
*/
|
||||||
public static class Provider extends ExtensionElementProvider<AgentStatus> {
|
public static class Provider extends ExtensionElementProvider<AgentStatus> {
|
||||||
|
|
||||||
|
|
|
@ -116,7 +116,7 @@ public class AgentStatusRequest extends IQ {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension provider for AgentStatusRequest packets.
|
* Stanza extension provider for AgentStatusRequest packets.
|
||||||
*/
|
*/
|
||||||
public static class Provider extends IQProvider<AgentStatusRequest> {
|
public static class Provider extends IQProvider<AgentStatusRequest> {
|
||||||
|
|
||||||
|
|
|
@ -73,7 +73,7 @@ public class MonitorPacket extends IQ {
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension provider for Monitor Packets.
|
* Stanza extension provider for Monitor Packets.
|
||||||
*/
|
*/
|
||||||
public static class InternalProvider extends IQProvider<MonitorPacket> {
|
public static class InternalProvider extends IQProvider<MonitorPacket> {
|
||||||
|
|
||||||
|
|
|
@ -34,7 +34,7 @@ import org.xmlpull.v1.XmlPullParser;
|
||||||
import org.xmlpull.v1.XmlPullParserException;
|
import org.xmlpull.v1.XmlPullParserException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) used for requesting information about occupants of a room or for retrieving information
|
* Stanza used for requesting information about occupants of a room or for retrieving information
|
||||||
* such information.
|
* such information.
|
||||||
*
|
*
|
||||||
* @author Gaston Dombiak
|
* @author Gaston Dombiak
|
||||||
|
@ -131,7 +131,7 @@ public class OccupantsInfo extends IQ {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension provider for AgentStatusRequest packets.
|
* Stanza extension provider for AgentStatusRequest packets.
|
||||||
*/
|
*/
|
||||||
public static class Provider extends IQProvider<OccupantsInfo> {
|
public static class Provider extends IQProvider<OccupantsInfo> {
|
||||||
|
|
||||||
|
|
|
@ -33,7 +33,7 @@ import org.xmlpull.v1.XmlPullParser;
|
||||||
import org.xmlpull.v1.XmlPullParserException;
|
import org.xmlpull.v1.XmlPullParserException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension for {@link org.jivesoftware.smackx.workgroup.agent.InvitationRequest}.
|
* Stanza extension for {@link org.jivesoftware.smackx.workgroup.agent.InvitationRequest}.
|
||||||
*
|
*
|
||||||
* @author Gaston Dombiak
|
* @author Gaston Dombiak
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -29,7 +29,7 @@ import org.xmlpull.v1.XmlPullParser;
|
||||||
import org.xmlpull.v1.XmlPullParserException;
|
import org.xmlpull.v1.XmlPullParserException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension for {@link org.jivesoftware.smackx.workgroup.agent.TransferRequest}.
|
* Stanza extension for {@link org.jivesoftware.smackx.workgroup.agent.TransferRequest}.
|
||||||
*
|
*
|
||||||
* @author Gaston Dombiak
|
* @author Gaston Dombiak
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -121,7 +121,7 @@ public class ChatSettings extends IQ {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension provider for AgentStatusRequest packets.
|
* Stanza extension provider for AgentStatusRequest packets.
|
||||||
*/
|
*/
|
||||||
public static class InternalProvider extends IQProvider<ChatSettings> {
|
public static class InternalProvider extends IQProvider<ChatSettings> {
|
||||||
|
|
||||||
|
|
|
@ -75,7 +75,7 @@ public class GenericSettings extends IQ {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension provider for SoundSetting Packets.
|
* Stanza extension provider for SoundSetting Packets.
|
||||||
*/
|
*/
|
||||||
public static class InternalProvider extends IQProvider<GenericSettings> {
|
public static class InternalProvider extends IQProvider<GenericSettings> {
|
||||||
|
|
||||||
|
|
|
@ -102,7 +102,7 @@ public class OfflineSettings extends SimpleIQ {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension provider for AgentStatusRequest packets.
|
* Stanza extension provider for AgentStatusRequest packets.
|
||||||
*/
|
*/
|
||||||
public static class InternalProvider extends IQProvider<OfflineSettings> {
|
public static class InternalProvider extends IQProvider<OfflineSettings> {
|
||||||
|
|
||||||
|
|
|
@ -73,7 +73,7 @@ public class SearchSettings extends SimpleIQ {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension provider for AgentStatusRequest packets.
|
* Stanza extension provider for AgentStatusRequest packets.
|
||||||
*/
|
*/
|
||||||
public static class InternalProvider extends IQProvider<SearchSettings> {
|
public static class InternalProvider extends IQProvider<SearchSettings> {
|
||||||
|
|
||||||
|
|
|
@ -63,7 +63,7 @@ public class SoundSettings extends SimpleIQ {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension provider for SoundSetting Packets.
|
* Stanza extension provider for SoundSetting Packets.
|
||||||
*/
|
*/
|
||||||
public static class InternalProvider extends IQProvider<SoundSettings> {
|
public static class InternalProvider extends IQProvider<SoundSettings> {
|
||||||
|
|
||||||
|
|
|
@ -90,7 +90,7 @@ public class WorkgroupProperties extends IQ {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stanza(/Packet) extension provider for SoundSetting Packets.
|
* Stanza extension provider for SoundSetting Packets.
|
||||||
*/
|
*/
|
||||||
public static class InternalProvider extends IQProvider<WorkgroupProperties> {
|
public static class InternalProvider extends IQProvider<WorkgroupProperties> {
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue