public class Bytestream extends IQ
Modifier and Type | Class and Description |
---|---|
static class |
Bytestream.Activate
The packet sent by the stream initiator to the stream proxy to activate the connection.
|
static class |
Bytestream.Mode
The stream can be either a TCP stream or a UDP stream.
|
static class |
Bytestream.StreamHost
Packet extension that represents a potential SOCKS5 proxy for the file transfer.
|
static class |
Bytestream.StreamHostUsed
After selected a SOCKS5 stream host and successfully connecting, the target of the file
transfer returns a byte stream packet with the stream host used extension.
|
DEFAULT_LANGUAGE, ID_NOT_AVAILABLE
Constructor and Description |
---|
Bytestream()
The default constructor
|
Bytestream(String SID)
A constructor where the session ID can be specified.
|
Modifier and Type | Method and Description |
---|---|
void |
addStreamHost(Bytestream.StreamHost host)
Adds a potential stream host that the remote user can transfer the file through.
|
Bytestream.StreamHost |
addStreamHost(String JID,
String address)
Adds a potential stream host that the remote user can connect to to receive the file.
|
Bytestream.StreamHost |
addStreamHost(String JID,
String address,
int port)
Adds a potential stream host that the remote user can connect to to receive the file.
|
int |
countStreamHosts()
Returns the count of stream hosts contained in this packet.
|
String |
getChildElementXML()
Returns the sub-element XML section of the IQ packet, or null if there
isn't one.
|
Bytestream.Mode |
getMode()
Returns the transport mode.
|
String |
getSessionID()
Returns the session ID related to the bytestream negotiation.
|
Bytestream.StreamHost |
getStreamHost(String JID)
Returns the stream host related to the given JID, or null if there is none.
|
Collection<Bytestream.StreamHost> |
getStreamHosts()
Returns the list of stream hosts contained in the packet.
|
Bytestream.Activate |
getToActivate()
Returns the activate element of the packet sent to the proxy host to verify the identity of
the initiator and match them to the appropriate stream.
|
Bytestream.StreamHostUsed |
getUsedHost()
Returns the SOCKS5 host connected to by the remote user.
|
void |
setMode(Bytestream.Mode mode)
Set the transport mode.
|
void |
setSessionID(String sessionID)
Set the session ID related to the bytestream.
|
void |
setToActivate(String targetID)
Upon the response from the target of the used host the activate packet is sent to the SOCKS5
proxy.
|
void |
setUsedHost(String JID)
Upon connecting to the stream host the target of the stream replies to the initiator with the
JID of the SOCKS5 host that they used.
|
createErrorResponse, createResultIQ, getType, setType, toXML
addExtension, deleteProperty, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setProperty, setTo
public Bytestream()
public Bytestream(String SID)
SID
- The session ID related to the negotiation.setSessionID(String)
public void setSessionID(String sessionID)
sessionID
- the unique session ID that identifies the transfer.public String getSessionID()
setSessionID(String)
public void setMode(Bytestream.Mode mode)
mode
- the transport mode, either UDP or TCPBytestream.Mode
public Bytestream.Mode getMode()
setMode(Mode)
public Bytestream.StreamHost addStreamHost(String JID, String address)
JID
- The JID of the stream host.address
- The internet address of the stream host.public Bytestream.StreamHost addStreamHost(String JID, String address, int port)
JID
- The JID of the stream host.address
- The internet address of the stream host.port
- The port on which the remote host is seeking connections.public void addStreamHost(Bytestream.StreamHost host)
host
- The potential stream host.public Collection<Bytestream.StreamHost> getStreamHosts()
public Bytestream.StreamHost getStreamHost(String JID)
JID
- The JID of the desired stream host.public int countStreamHosts()
public void setUsedHost(String JID)
JID
- The JID of the used host.public Bytestream.StreamHostUsed getUsedHost()
public Bytestream.Activate getToActivate()
public void setToActivate(String targetID)
targetID
- The JID of the target of the file transfer.public String getChildElementXML()
IQ
Extensions of this class must override this method.
getChildElementXML
in class IQ
Copyright © 2003-2007 Jive Software.