package de.thedevstack.conversationsplus.xmpp.filetransfer.http.upload;

import eu.siacs.conversations.xmpp.jid.Jid;
import eu.siacs.conversations.xmpp.stanzas.IqPacket;

/**
 * Generates the IQ Packets for requesting a http upload slot
 * as defined in XEP-0363.
 * @see <a href="http://xmpp.org/extensions/xep-0363.html">http://xmpp.org/extensions/xep-0363.html</a>
 */
public final class HttpUploadRequestSlotPacketGenerator {
    /**
     * Generates the IqPacket to request a http upload slot.
     * The attributes from and id are not set in here - this is added while sending the packet.
     * <pre>
     * <iq from='romeo@montague.tld/garden'
     *     id='step_03'
     *     to='upload.montague.tld'
     *     type='get'>
     *   <request xmlns='urn:xmpp:http:upload'>
     *     <filename>my_juliet.png</filename>
     *     <size>23456</size>
     *     <content-type>image/jpeg</content-type>
     *   </request>
     * </iq>
     * </pre>
     * @param host the jid of the host to request a slot from
     * @param filename the filename of the file which will be transferred
     * @param filesize the filesize of the file which will be transferred
     * @param mime the mime type of the file which will be transferred - <code>optional</code> and therefore nullable
     * @return the IqPacket
     */
    public static IqPacket generate(Jid host, String filename, long filesize, String mime) {
        SlotRequestPacket packet = new SlotRequestPacket(filename, filesize);
        packet.setTo(host);
        packet.setMime((mime == null) ? HttpUpload.DEFAULT_MIME_TYPE : mime);
        return packet;
    }

    /**
     * Utility class - avoid instantiation
     */
    private HttpUploadRequestSlotPacketGenerator() {
        // Helper class - avoid instantiation
    }
}