| 
 | Smack | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.jivesoftware.smackx.filetransfer.StreamNegotiator
public abstract class StreamNegotiator
After the file transfer negotiation process is completed according to JEP-0096, the negotiation process is passed off to a particular stream negotiator. The stream negotiator will then negotiate the chosen stream and return the stream to transfer the file.
| Constructor Summary | |
|---|---|
| StreamNegotiator() | |
| Method Summary | |
|---|---|
| abstract  void | cleanup()Cleanup any and all resources associated with this negotiator. | 
|  IQ | createError(String from,
            String to,
            String packetID,
            XMPPError xmppError) | 
| abstract  InputStream | createIncomingStream(StreamInitiation initiation)This method handles the file stream download negotiation process. | 
|  StreamInitiation | createInitiationAccept(StreamInitiation streamInitiationOffer,
                       String[] namespaces)Creates the initiation acceptance packet to forward to the stream initiator. | 
| abstract  OutputStream | createOutgoingStream(String streamID,
                     String initiator,
                     String target)This method handles the file upload stream negotiation process. | 
| abstract  PacketFilter | getInitiationPacketFilter(String from,
                          String streamID)Returns the packet filter that will return the initiation packet for the appropriate stream initiation. | 
| abstract  String[] | getNamespaces()Returns the XMPP namespace reserved for this particular type of file transfer. | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
|---|
public StreamNegotiator()
| Method Detail | 
|---|
public StreamInitiation createInitiationAccept(StreamInitiation streamInitiationOffer,
                                               String[] namespaces)
streamInitiationOffer - The offer from the stream initiator to connect for a stream.namespaces - The namespace that relates to the accepted means of transfer.
public IQ createError(String from,
                      String to,
                      String packetID,
                      XMPPError xmppError)
public abstract PacketFilter getInitiationPacketFilter(String from,
                                                       String streamID)
from - The initiator of the file transfer.streamID - The stream ID related to the transfer.
public abstract InputStream createIncomingStream(StreamInitiation initiation)
                                          throws XMPPException,
                                                 InterruptedException
initiation - The initiation that triggered this download.
XMPPException - If an error occurs during this process an XMPPException is
                       thrown.
InterruptedException - If thread is interrupted.
public abstract OutputStream createOutgoingStream(String streamID,
                                                  String initiator,
                                                  String target)
                                           throws XMPPException
streamID - The streamID that uniquely identifies the file transfer.initiator - The fully-qualified JID of the initiator of the file transfer.target - The fully-qualified JID of the target or receiver of the file
                  transfer.
XMPPException - If an error occurs during the negotiation process an
                       exception will be thrown.public abstract String[] getNamespaces()
public abstract void cleanup()
| 
 | Smack | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||