edu.ksu.canvas.impl.ProgressImpl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of canvas-api Show documentation

A native Java library to talk to the Canvas REST API

The newest version!

package edu.ksu.canvas.impl;

import com.google.gson.reflect.TypeToken;
import edu.ksu.canvas.interfaces.ProgressReader;
import edu.ksu.canvas.interfaces.ProgressWriter;
import edu.ksu.canvas.model.Progress;

import edu.ksu.canvas.net.Response;
import edu.ksu.canvas.net.RestClient;
import edu.ksu.canvas.oauth.OauthToken;

import java.io.IOException;
import java.lang.reflect.Type;
import java.util.Collections;
import java.util.Optional;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class ProgressImpl extends BaseImpl implements ProgressReader, ProgressWriter {

    private static final Logger LOG = LoggerFactory.getLogger(ProgressImpl.class);

    public ProgressImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient,
                                int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls) {
        super(canvasBaseUrl, apiVersion, oauthToken, restClient, connectTimeout, readTimeout,
                paginationPageSize, serializeNulls);
    }

    @Override
    public Optional getProgress(String url) throws IOException {
        LOG.debug("getting the progress of an asynchronous API operation with url {}", url);
        Response response = canvasMessenger.getSingleResponseFromCanvas(oauthToken, url);
        return responseParser.parseToObject(Progress.class, response);
    }

    @Override
    public Optional getProgress(Long progressId) throws IOException {
        LOG.debug("getting the progress of an asynchronous operation by ID: {}", progressId);
        String url = buildCanvasUrl(String.format("progress/%d", progressId), Collections.emptyMap());
        return responseParser.parseToObject(Progress.class, canvasMessenger.getSingleResponseFromCanvas(oauthToken, url));
    }

    @Override
    protected Type listType() {
        return new TypeToken(){}.getType();
    }

    @Override
    protected Class objectType() {
        return Progress.class;
    }
}