com.sap.cloudfoundry.client.facade.UploadStatusCallback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloudfoundry-client-facade Show documentation

A facade of the official Cloud Foundry Java client

There is a newer version: 2.56.0

Show newest version

package com.sap.cloudfoundry.client.facade;

import java.util.Set;

/**
 * Reports status information when uploading an application.
 */
public interface UploadStatusCallback {

    /**
     * Empty implementation
     */
    UploadStatusCallback NONE = new UploadStatusCallback() {
        @Override
        public void onCheckResources() {
        }

        @Override
        public void onMatchedFileNames(Set matchedFileNames) {
        }

        @Override
        public void onProcessMatchedResources(int length) {
        }

        @Override
        public boolean onProgress(String status) {
            return false;
        }

        @Override
        public void onError(String description) {
        }
    };

    /**
     * Called after the /resources call is made.
     */
    void onCheckResources();

    /**
     * Called after the files to be uploaded have been identified.
     *
     * @param matchedFileNames the files to be uploaded
     */
    void onMatchedFileNames(Set matchedFileNames);

    /**
     * Called after the data to be uploaded has been processed
     *
     * @param length the size of the upload data (before compression)
     */
    void onProcessMatchedResources(int length);

    /**
     * Called during asynchronous upload process.
     *
     * Implementation can return true to unsubscribe from progress update reports. This is useful if the caller want to unblock the thread
     * that initiated the upload. Note, however, that the upload job that has been asynchronously started will continue to execute on the
     * server.
     *
     * @param status string such as "queued", "finished"
     * @return true to unsubscribe from update report
     */
    boolean onProgress(String status);

    void onError(String description);
}