edu.ksu.canvas

Class CanvasApiFactory

java.lang.Object

edu.ksu.canvas.CanvasApiFactory

public class CanvasApiFactory
extends Object

Entry point for using the Canvas API library. It constructs concrete implementations of reader/writer classes to perform API calls with. It must be constructed with a Canvas instance URL which will be used for all API calls. It has options to specify network timeouts and a way to control API pagination.

Field Summary

Fields

Modifier and Type	Field and Description
static Integer	CANVAS_API_VERSION

Constructor Summary

Constructors

Constructor and Description
CanvasApiFactory(String canvasBaseUrl) Construct an API factory for a given instance of Canvas.
CanvasApiFactory(String canvasBaseUrl, int connectTimeout, int readTimeout) Construct an API factory with specified timeout values

Method Summary

Modifier and Type	Method and Description
<T extends CanvasReader> T	getReader(Class<T> type, OauthToken oauthToken) Get a reader implementation class to perform API calls with.
<T extends CanvasReader> T	getReader(Class<T> type, OauthToken oauthToken, Integer paginationPageSize) Get a reader implementation class to perform API calls with while specifying an explicit page size for paginated API calls.
<T extends CanvasWriter> T	getWriter(Class<T> type, OauthToken oauthToken) Get a writer implementation to push data into Canvas.
<T extends CanvasWriter> T	getWriter(Class<T> type, OauthToken oauthToken, Boolean serializeNulls) Get a writer implementation to push data into Canvas while being able to control the behavior of blank values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CANVAS_API_VERSION

public static final Integer CANVAS_API_VERSION

Constructor Detail

CanvasApiFactory

public CanvasApiFactory(String canvasBaseUrl)

Construct an API factory for a given instance of Canvas.

Parameters:

canvasBaseUrl - The base URL used to access your Canvas instance

CanvasApiFactory

public CanvasApiFactory(String canvasBaseUrl,
                        int connectTimeout,
                        int readTimeout)

Construct an API factory with specified timeout values

Parameters:

canvasBaseUrl - The base URL used to access your Canvas instance

connectTimeout - Connection timeout in milliseconds

readTimeout - Read timeout in milliseconds. If this is too low, longer API queries could time out prematurely

Method Detail

getReader

public <T extends CanvasReader> T getReader(Class<T> type,
                                            OauthToken oauthToken)

Get a reader implementation class to perform API calls with.

Type Parameters:

T - The reader type to request an instance of

Parameters:

type - Interface type you wish to get an implementation for

oauthToken - An OAuth token to use for authentication when making API calls

Returns:

A reader implementation class

getReader

public <T extends CanvasReader> T getReader(Class<T> type,
                                            OauthToken oauthToken,
                                            Integer paginationPageSize)

Get a reader implementation class to perform API calls with while specifying an explicit page size for paginated API calls. This gets translated to a per_page= parameter on API requests. Note that Canvas does not guarantee it will honor this page size request. There is an explicit maximum page size on the server side which could change. The default page size is 10 which can be limiting when, for example, trying to get all users in a 800 person course.

Type Parameters:

T - The reader type to request an instance of

Parameters:

type - Interface type you wish to get an implementation for

oauthToken - An OAuth token to use for authentication when making API calls

paginationPageSize - Requested pagination page size

Returns:

An instance of the requested reader class

getWriter

public <T extends CanvasWriter> T getWriter(Class<T> type,
                                            OauthToken oauthToken)

Get a writer implementation to push data into Canvas.

Type Parameters:

T - A writer implementation

Parameters:

type - Interface type you wish to get an implementation for

oauthToken - An OAuth token to use for authentication when making API calls

Returns:

A writer implementation class

getWriter

public <T extends CanvasWriter> T getWriter(Class<T> type,
                                            OauthToken oauthToken,
                                            Boolean serializeNulls)

Get a writer implementation to push data into Canvas while being able to control the behavior of blank values. If the serializeNulls parameter is set to true, this writer will serialize null fields in the JSON being sent to Canvas. This is required if you want to explicitly blank out a value that is currently set to something.

Type Parameters:

T - A writer implementation

Parameters:

type - Interface type you wish to get an implementation for

oauthToken - An OAuth token to use for authentication when making API calls

serializeNulls - Whether or not to include null fields in the serialized JSON. Defaults to false if null

Returns:

An instantiated instance of the requested writer type