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

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
There is a newer version: 2.0.0
package edu.ksu.canvas.impl;

import java.io.IOException;
import java.lang.reflect.Type;
import java.net.URLEncoder;
import java.util.Collections;
import java.util.List;
import java.util.Optional;

import org.apache.log4j.Logger;

import com.google.gson.reflect.TypeToken;

import edu.ksu.canvas.constants.CanvasConstants;
import edu.ksu.canvas.interfaces.PageReader;
import edu.ksu.canvas.interfaces.PageWriter;
import edu.ksu.canvas.model.Page;
import edu.ksu.canvas.net.Response;
import edu.ksu.canvas.net.RestClient;
import edu.ksu.canvas.oauth.OauthToken;

public class PageImpl extends BaseImpl implements PageReader, PageWriter {
    private static final Logger LOG = Logger.getLogger(PageImpl.class);

    public PageImpl(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 getCoursePage(String courseId, String pageUrl) throws IOException {
        LOG.debug("retrieving page " + pageUrl + " for course " + courseId);
        String encodedUrl = URLEncoder.encode(pageUrl, CanvasConstants.URLENCODING_TYPE);
        String url = buildCanvasUrl("courses/" + courseId + "/pages/" + encodedUrl, Collections.emptyMap());
        Response response = canvasMessenger.getSingleResponseFromCanvas(oauthToken, url);
        return responseParser.parseToObject(Page.class, response);
    }

    @Override
    public Optional getGroupPage(String groupId, String pageUrl) throws IOException {
        LOG.debug("retrieving page " + pageUrl + " for group " + groupId);
        String encodedUrl = URLEncoder.encode(pageUrl, CanvasConstants.URLENCODING_TYPE);
        String url = buildCanvasUrl("groups/" + groupId + "/pages/" + encodedUrl, Collections.emptyMap());
        Response response = canvasMessenger.getSingleResponseFromCanvas(oauthToken, url);
        return responseParser.parseToObject(Page.class, response);
    }

    @Override
    public Optional updateCoursePage(Page page, String courseId) throws IOException {
        LOG.debug("Updating page in course" + courseId);
        String encodedUrl = URLEncoder.encode(page.getUrl(), CanvasConstants.URLENCODING_TYPE);
        String url = buildCanvasUrl("courses/" + courseId + "/pages/" + encodedUrl, Collections.emptyMap());
        Response response = canvasMessenger.sendJsonPutToCanvas(oauthToken, url, page.toJsonObject(serializeNulls));
        return responseParser.parseToObject(Page.class, response);
    }

    @Override
    public List listPagesInCourse(String courseId) throws IOException {
        LOG.debug("fetching all pages for course " + courseId);
        String url = buildCanvasUrl("courses/" + courseId + "/pages", Collections.emptyMap());
        return getListFromCanvas(url);
    }

    @Override
    public List listPagesInGroup(String groupId) throws IOException {
        LOG.debug("fetching all pages for course " + groupId);
        String url = buildCanvasUrl("groups/" + groupId + "/pages", Collections.emptyMap());
        return getListFromCanvas(url);
    }

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

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