org.cloudfoundry.client.lib.UploadStatusCallback Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloudfoundry-client-lib Show documentation
A Cloud Foundry client library for Java
The newest version!
/*
 * Copyright 2009-2011 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.cloudfoundry.client.lib;

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);
}