Java

Azure File Service: Upload Large File

See more Azure Cloud Storage Examples

Sample code to upload a large file to a directory in a share in the Azure File Service. A file is uploaded by first creating the file in the Azure share and then writing ranges of bytes to the file. Azure imposes a 4MB limit for each PUT to write a range. Files larger than 4MB need to be uploaded by making multiple "Put Range" calls. This example uploads a large file requiring multiple "Put Range" calls. Chilkat2 Java

import com.chilkatsoft.chilkat2.AuthAzureStorage;
import com.chilkatsoft.chilkat2.BinData;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.FileAccess;
import com.chilkatsoft.chilkat2.Rest;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

    public static void main(String[] args) {
        // Azure File Service Example: Upload a large file.
        // See:  https://docs.microsoft.com/en-us/rest/api/storageservices/create-share
        // also see: https://docs.microsoft.com/en-us/rest/api/storageservices/put-range

        // This example requires the Chilkat API to have been previously unlocked.
        // See Global Unlock Sample for sample code.

        Rest rest = new Rest();

        // Connect to the Azure Storage Blob Service
        boolean bTls = true;
        int port = 443;
        boolean bAutoReconnect = true;
        // In this example, the storage account name is "chilkat".
        try {
            rest.connect("chilkat.file.core.windows.net", port, bTls, bAutoReconnect);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // This example will upload a larger file.
        String localFilePath = "qa_data/zips/somethingBig.zip";
        FileAccess fac = new FileAccess();
        // Note: The FileSize method returns a signed 32-bit integer.  If the file is potentially larger than 2GB, call FileSizeStr instead to return
        // the size of the file as a string, then convert to an integer value.
        int szLocalFile = fac.fileSize(localFilePath);
        if (szLocalFile < 0) {
            System.out.println(fac.getLastErrorText());
            return;
        }

        // Provide Azure Cloud credentials for the REST calls.
        AuthAzureStorage azAuth = new AuthAzureStorage();
        azAuth.setAccessKey("AZURE_ACCESS_KEY");
        // The account name used here should match the 1st part of the domain passed in the call to Connect (above).
        azAuth.setAccount("chilkat");
        azAuth.setScheme("SharedKey");
        azAuth.setService("File");
        // This causes the "x-ms-version: 2021-08-06" header to be automatically added.
        azAuth.setXMsVersion("2021-08-06");
        rest.setAuthAzureStorage(azAuth);

        // Note: The application does not need to explicitly set the following
        // headers: x-ms-date, Authorization.  These headers
        // are automatically set by Chilkat.

        // However, a few additional headers are required for the "Create File" operation:
        rest.addHeader("x-ms-type", "file");

        // This required header specifies the final size of the file (or the maximum size it can be).
        StringBuilder sbFileSize = new StringBuilder();
        sbFileSize.appendInt(szLocalFile);
        rest.addHeader("x-ms-content-length", sbFileSize.getAsString());

        // Send a PUT request to create the file (or replace the file if it already exists).
        // This will initialize the file in the Azure file storage.  To upload content, we'll need
        // to do the "Put Range" operation one or more times.

        // The following will create the file "somethingBig.zip" in the share "pip"
        String responseStr;
        try {
            responseStr = rest.fullRequestNoBody("PUT", "/pip/somethingBig.zip");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // When successful, the Azure File Service will respond with a 201 (Created) response status code,
        // with no XML response body.  If an error response is returned, there will be an XML response body.

        if (rest.getResponseStatusCode() != 201) {
            // Examine the request/response to see what happened.
            System.out.println("response status code = " + rest.getResponseStatusCode());
            System.out.println("response status text = " + rest.getResponseStatusText());
            System.out.println("response header: " + rest.getResponseHeader());
            System.out.println("response body (if any): " + responseStr);
            System.out.println("---");
            System.out.println("LastRequestStartLine: " + rest.getLastRequestStartLine());
            System.out.println("LastRequestHeader: " + rest.getLastRequestHeader());
            return;
        }

        System.out.println("Successfully created somethingBig.zip");

        // --------------------------------------------------------------------------------
        // Upload the file data...

        // Make sure the headers from the "Create File" operation are removed.
        rest.clearAllHeaders();

        // The x-ms-write header is required for each "Put Range" request.
        rest.addHeader("x-ms-write", "update");

        StringBuilder sbRange = new StringBuilder();
        StringBuilder sbResponseBody = new StringBuilder();
        BinData bdFileData = new BinData();

        // Open the file.  We'll be reading and uploading in chunks..
        try {
            fac.openForRead(localFilePath);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        int numBytesLeft = szLocalFile;
        int curIndex = 0;
        while (numBytesLeft > 0) {
            int chunkSize = numBytesLeft;
            // Azure allows for 4MB max chunks  (4 x 1024 x 1024 = 4194304)
            if (chunkSize > 4194304) {
                chunkSize = 4194304;
            }

            // The only tricky part here is to correctly add the x-ms-range header.
            // It will be formatted like this:
            // x-ms-range: bytes=0-759623
            sbRange.clear();
            sbRange.append("bytes=");
            sbRange.appendInt(curIndex);
            sbRange.append("-");
            sbRange.appendInt(curIndex + chunkSize - 1);

            // This replaces the header if it already exists..
            rest.addHeader("x-ms-range", sbRange.getAsString());

            // Read the next chunk from the local file.
            bdFileData.clear();
            fac.fileReadBd(chunkSize, bdFileData);

            try {
                rest.fullRequestBd("PUT", "/pip/somethingBig.zip?comp=range", bdFileData, sbResponseBody);
            } catch (ChilkatException e) {
                // This would indicate a failure where no response was received.
                System.out.println(e.getLastErrorText());
                return;
            }

            // A 201 response indicates the chunk was uploaded.
            if (rest.getResponseStatusCode() != 201) {
                // Examine the request/response to see what happened.
                System.out.println("response status code = " + rest.getResponseStatusCode());
                System.out.println("response status text = " + rest.getResponseStatusText());
                System.out.println("response header: " + rest.getResponseHeader());
                System.out.println("response body (if any): " + responseStr);
                System.out.println("---");
                System.out.println("LastRequestStartLine: " + rest.getLastRequestStartLine());
                System.out.println("LastRequestHeader: " + rest.getLastRequestHeader());
                return;
            }

            System.out.println("Uploaded chunk from " + curIndex + " to " + (curIndex + chunkSize - 1));

            curIndex = curIndex + chunkSize;
            numBytesLeft = numBytesLeft - chunkSize;
        }

        fac.fileClose();

        System.out.println("success.");
    }
}