vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-12-12 05:51:08 +01:00
Code Issues Releases Wiki Activity

Globally 's;stanza(/packet);stanza;'

Browse source
This commit is contained in:
Florian Schmaus 2018-03-31 14:17:30 +02:00
parent 1d12be1644
commit ad87243060
171 changed files with 911 additions and 599 deletions
Download patch file Download diff file Expand all files Collapse all files

4
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/DataListener.java
View file

@ -26,9 +26,9 @@ import org.jivesoftware.smackx.bytestreams.ibb.packet.DataPacketExtension;
/**
* DataListener handles all In-Band Bytestream IQ stanzas containing a data
* stanza(/packet) extension that don't belong to an existing session.
* stanza extension that don't belong to an existing session.
* <p>
* If a data stanza(/packet) is received it looks if a stored In-Band Bytestream session
* If a data stanza is received it looks if a stored In-Band Bytestream session
* exists. If no session with the given session ID exists an
* &lt;item-not-found/&gt; error is returned to the sender.
* <p>

12
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManager.java
View file

@ -53,7 +53,7 @@ import org.jxmpp.jid.Jid;
* in case the Socks5 bytestream method of transferring data is not available.
* <p>
* There are two ways to send data over an In-Band Bytestream. It could either use IQ stanzas to
* send data packets or message stanzas. If IQ stanzas are used every data stanza(/packet) is acknowledged by
* send data packets or message stanzas. If IQ stanzas are used every data stanza is acknowledged by
* the receiver. This is the recommended way to avoid possible rate-limiting penalties. Message
* stanzas are not acknowledged because most XMPP server implementation don't support stanza
* flow-control method like <a href="http://xmpp.org/extensions/xep-0079.html">Advanced Message
@ -291,7 +291,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream
* to the initiator.
* <p>
* This method should be used if you are awaiting an In-Band Bytestream request as a reply to
* another stanza(/packet) (e.g. file transfer).
* another stanza (e.g. file transfer).
*
* @param sessionID to be ignored
*/
@ -447,7 +447,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream
* Responses to the given IQ packet's sender with an XMPP error that an In-Band Bytestream is
* not accepted.
*
* @param request IQ stanza(/packet) that should be answered with a not-acceptable error
* @param request IQ stanza that should be answered with a not-acceptable error
* @throws NotConnectedException
* @throws InterruptedException
*/
@ -460,7 +460,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream
* Responses to the given IQ packet's sender with an XMPP error that an In-Band Bytestream open
* request is rejected because its block size is greater than the maximum allowed block size.
*
* @param request IQ stanza(/packet) that should be answered with a resource-constraint error
* @param request IQ stanza that should be answered with a resource-constraint error
* @throws NotConnectedException
* @throws InterruptedException
*/
@ -473,7 +473,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream
* Responses to the given IQ packet's sender with an XMPP error that an In-Band Bytestream
* session could not be found.
*
* @param request IQ stanza(/packet) that should be answered with a item-not-found error
* @param request IQ stanza that should be answered with a item-not-found error
* @throws NotConnectedException
* @throws InterruptedException
*/
@ -543,7 +543,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream
}
/**
* Disables the InBandBytestreamManager by removing its stanza(/packet) listeners and resetting its
* Disables the InBandBytestreamManager by removing its stanza listeners and resetting its
* internal status, which includes removing this instance from the managers map.
*/
private void disableService() {

22
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSession.java
View file

@ -242,7 +242,7 @@ public class InBandBytestreamSession implements BytestreamSession {
/**
* IBBInputStream class is the base implementation of an In-Band Bytestream input stream.
* Subclasses of this input stream must provide a stanza(/packet) listener along with a stanza(/packet) filter to
* Subclasses of this input stream must provide a stanza listener along with a stanza filter to
* collect the In-Band Bytestream data packets.
*/
private abstract class IBBInputStream extends InputStream {
@ -281,16 +281,16 @@ public class InBandBytestreamSession implements BytestreamSession {
}
/**
* Returns the stanza(/packet) listener that processes In-Band Bytestream data packets.
* Returns the stanza listener that processes In-Band Bytestream data packets.
*
* @return the data stanza(/packet) listener
* @return the data stanza listener
*/
protected abstract StanzaListener getDataPacketListener();
/**
* Returns the stanza(/packet) filter that accepts In-Band Bytestream data packets.
* Returns the stanza filter that accepts In-Band Bytestream data packets.
*
* @return the data stanza(/packet) filter
* @return the data stanza filter
*/
protected abstract StanzaFilter getDataPacketFilter();
@ -350,7 +350,7 @@ public class InBandBytestreamSession implements BytestreamSession {
}
/**
* This method blocks until a data stanza(/packet) is received, the stream is closed or the current
* This method blocks until a data stanza is received, the stream is closed or the current
* thread is interrupted.
*
* @return <code>true</code> if data was received, otherwise <code>false</code>
@ -436,7 +436,7 @@ public class InBandBytestreamSession implements BytestreamSession {
}
/**
* This method sets the close flag and removes the data stanza(/packet) listener.
* This method sets the close flag and removes the data stanza listener.
*/
private void closeInternal() {
if (isClosed) {
@ -513,7 +513,7 @@ public class InBandBytestreamSession implements BytestreamSession {
protected StanzaFilter getDataPacketFilter() {
/*
* filter all IQ stanzas having type 'SET' (represented by Data class), containing a
* data stanza(/packet) extension, matching session ID and recipient
* data stanza extension, matching session ID and recipient
*/
return new AndFilter(new StanzaTypeFilter(Data.class), new IBBDataPacketFilter());
}
@ -561,7 +561,7 @@ public class InBandBytestreamSession implements BytestreamSession {
@Override
protected StanzaFilter getDataPacketFilter() {
/*
* filter all message stanzas containing a data stanza(/packet) extension, matching session ID
* filter all message stanzas containing a data stanza extension, matching session ID
* and recipient
*/
return new AndFilter(new StanzaTypeFilter(Message.class), new IBBDataPacketFilter());
@ -571,7 +571,7 @@ public class InBandBytestreamSession implements BytestreamSession {
/**
* IBBDataPacketFilter class filters all packets from the remote peer of this session,
* containing an In-Band Bytestream data stanza(/packet) extension whose session ID matches this sessions
* containing an In-Band Bytestream data stanza extension whose session ID matches this sessions
* ID.
*/
private class IBBDataPacketFilter implements StanzaFilter {
@ -632,7 +632,7 @@ public class InBandBytestreamSession implements BytestreamSession {
}
/**
* Writes the given data stanza(/packet) to the XMPP stream.
* Writes the given data stanza to the XMPP stream.
*
* @param data the data packet
* @throws IOException if an I/O error occurred while sending or if the stream is closed

6
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/Data.java
View file

@ -32,7 +32,7 @@ public class Data extends IQ {
/**
* Constructor.
*
* @param data data stanza(/packet) extension containing the encoded data
* @param data data stanza extension containing the encoded data
*/
public Data(DataPacketExtension data) {
super(DataPacketExtension.ELEMENT, DataPacketExtension.NAMESPACE);
@ -45,9 +45,9 @@ public class Data extends IQ {
}
/**
* Returns the data stanza(/packet) extension.
* Returns the data stanza extension.
*
* @return the data stanza(/packet) extension
* @return the data stanza extension
*/
public DataPacketExtension getDataPacketExtension() {
return this.dataPacketExtension;

8
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataPacketExtension.java
View file

@ -30,7 +30,7 @@ import org.jivesoftware.smack.util.stringencoder.Base64;
public class DataPacketExtension implements ExtensionElement {
/**
* The element name of the data stanza(/packet) extension.
* The element name of the data stanza extension.
*/
public static final String ELEMENT = "data";
@ -54,7 +54,7 @@ public class DataPacketExtension implements ExtensionElement {
* Creates a new In-Band Bytestream data packet.
*
* @param sessionID unique session ID identifying this In-Band Bytestream
* @param seq sequence of this stanza(/packet) in regard to the other data packets
* @param seq sequence of this stanza in regard to the other data packets
* @param data the base64 encoded data contained in this packet
*/
public DataPacketExtension(String sessionID, long seq, String data) {
@ -82,9 +82,9 @@ public class DataPacketExtension implements ExtensionElement {
}
/**
* Returns the sequence of this stanza(/packet) in regard to the other data packets.
* Returns the sequence of this stanza in regard to the other data packets.
*
* @return the sequence of this stanza(/packet) in regard to the other data packets.
* @return the sequence of this stanza in regard to the other data packets.
*/
public long getSeq() {
return seq;

2
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/provider/DataPacketProvider.java
View file

@ -25,7 +25,7 @@ import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
/**
* Parses an In-Band Bytestream data stanza(/packet) which can be a stanza(/packet) extension of
* Parses an In-Band Bytestream data stanza which can be a stanza extension of
* either an IQ stanza or a message stanza.
*
* @author Henning Staib

8
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamManager.java
View file

@ -256,7 +256,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
* to the initiator.
* <p>
* This method should be used if you are awaiting a SOCKS5 Bytestream request as a reply to
* another stanza(/packet) (e.g. file transfer).
* another stanza (e.g. file transfer).
*
* @param sessionID to be ignored
*/
@ -612,10 +612,10 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
}
/**
* Returns a IQ stanza(/packet) to query a SOCKS5 proxy its network settings.
* Returns a IQ stanza to query a SOCKS5 proxy its network settings.
*
* @param proxy the proxy to query
* @return IQ stanza(/packet) to query a SOCKS5 proxy its network settings
* @return IQ stanza to query a SOCKS5 proxy its network settings
*/
private static Bytestream createStreamHostRequest(Jid proxy) {
Bytestream request = new Bytestream();
@ -664,7 +664,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
}
/**
* Returns a SOCKS5 Bytestream initialization request stanza(/packet) with the given session ID
* Returns a SOCKS5 Bytestream initialization request stanza with the given session ID
* containing the given stream hosts for the given target JID.
*
* @param sessionID the session ID for the SOCKS5 Bytestream

2
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiator.java
View file

@ -105,7 +105,7 @@ public class Socks5ClientForInitiator extends Socks5Client {
}
/**
* Activates the SOCKS5 Bytestream by sending an XMPP SOCKS5 Bytestream activation stanza(/packet) to the
* Activates the SOCKS5 Bytestream by sending an XMPP SOCKS5 Bytestream activation stanza to the
* SOCKS5 proxy.
* @throws XMPPErrorException
* @throws NoResponseException

12
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/packet/Bytestream.java
View file

@ -29,7 +29,7 @@ import org.jivesoftware.smack.util.XmlStringBuilder;
import org.jxmpp.jid.Jid;
/**
* A stanza(/packet) representing part of a SOCKS5 Bytestream negotiation.
* A stanza representing part of a SOCKS5 Bytestream negotiation.
*
* @author Alexander Wenckus
*/
@ -202,10 +202,10 @@ public class Bytestream extends IQ {
}
/**
* Returns the activate element of the stanza(/packet) sent to the proxy host to verify the identity of
* Returns the activate element of the stanza sent to the proxy host to verify the identity of
* the initiator and match them to the appropriate stream.
*
* @return Returns the activate element of the stanza(/packet) sent to the proxy host to verify the
* @return Returns the activate element of the stanza sent to the proxy host to verify the
* identity of the initiator and match them to the appropriate stream.
*/
public Activate getToActivate() {
@ -213,7 +213,7 @@ public class Bytestream extends IQ {
}
/**
* Upon the response from the target of the used host the activate stanza(/packet) is sent to the SOCKS5
* Upon the response from the target of the used host the activate stanza is sent to the SOCKS5
* proxy. The proxy will activate the stream or return an error after verifying the identity of
* the initiator, using the activate packet.
*
@ -341,7 +341,7 @@ public class Bytestream extends IQ {
/**
* After selected a SOCKS5 stream host and successfully connecting, the target of the file
* transfer returns a byte stream stanza(/packet) with the stream host used extension.
* transfer returns a byte stream stanza with the stream host used extension.
*
* @author Alexander Wenckus
*/
@ -384,7 +384,7 @@ public class Bytestream extends IQ {
}
/**
* The stanza(/packet) sent by the stream initiator to the stream proxy to activate the connection.
* The stanza sent by the stream initiator to the stream proxy to activate the connection.
*
* @author Alexander Wenckus
*/