ReliableResourceStatus.java

/**
 * Copyright (c) Codice Foundation
 * <p/>
 * This is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser
 * General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or any later version.
 * <p/>
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details. A copy of the GNU Lesser General Public License
 * is distributed along with this program and can be found at
 * <http://www.gnu.org/licenses/lgpl.html>.
 */
package ddf.catalog.resource.download;

/**
 * Provides the status of the product caching thread @ReliableResourceCallable, and the
 * total number of bytes read from the product's @InputStream. If the entire product
 * @InputStream was read successfully a value of -1 is returned for bytes read.
 * The @DownloadStatus indicates if the caching was successful or whether an exception
 * in reading or writing to one of the streams was encountered.
 *
 */
public class ReliableResourceStatus {

    private long bytesRead;

    private DownloadStatus downloadStatus;

    private String message;

    public ReliableResourceStatus(DownloadStatus downloadStatus, long bytesRead) {
        this.downloadStatus = downloadStatus;
        this.bytesRead = bytesRead;
    }

    public long getBytesRead() {
        return bytesRead;
    }

    public void setBytesRead(long bytesRead) {
        this.bytesRead = bytesRead;
    }

    public DownloadStatus getDownloadStatus() {
        return downloadStatus;
    }

    public void setDownloadStatus(DownloadStatus downloadStatus) {
        this.downloadStatus = downloadStatus;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public String toString() {
        String s = "bytesRead = " + bytesRead + ",  downloadStatus = " + downloadStatus.toString()
                + ",  message = " + message;

        return s;
    }
}