edu.ksu.canvas.impl

Class BaseImpl<T,READERTYPE extends CanvasReader,WRITERTYPE extends CanvasWriter>

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<T,READERTYPE,WRITERTYPE>

All Implemented Interfaces:

CanvasReader<T,READERTYPE>, CanvasWriter<T,WRITERTYPE>

Direct Known Subclasses:

AccountImpl, AccountReportImpl, AccountReportSummaryImpl, AdminImpl, AssignmentGroupImpl, AssignmentImpl, AssignmentOverrideImpl, AuthenticationLogImpl, CalendarEventImpl, CommunicationChannelImpl, ContentMigrationImpl, ConversationImpl, CourseImpl, CourseSettingsImpl, EnrollmentImpl, EnrollmentTermImpl, ExternalToolImpl, FeatureFlagImpl, FeatureImpl, FileImpl, GradingStandardImpl, LoginImpl, MigrationIssueImpl, ModuleImpl, PageImpl, ProgressImpl, QuizImpl, QuizQuestionImpl, QuizSubmissionImpl, QuizSubmissionQuestionImpl, RoleImpl, RubricImpl, SectionsImpl, SelectiveDataImpl, SisImportImpl, SubmissionImpl, TabImpl, UserImpl

public abstract class BaseImpl<T,READERTYPE extends CanvasReader,WRITERTYPE extends CanvasWriter>
extends Object
implements CanvasReader<T,READERTYPE>, CanvasWriter<T,WRITERTYPE>

Base class for accessing the Canvas API

Field Summary

Fields

Modifier and Type	Field and Description
protected Integer	apiVersion
protected String	canvasBaseUrl
protected CanvasMessenger	canvasMessenger
protected String	masqueradeAs
protected String	masqueradeType
protected OauthToken	oauthToken
protected Integer	paginationPageSize
protected Consumer<List<T>>	responseCallback
protected ResponseParser	responseParser
protected Boolean	serializeNulls

Constructor Summary

Constructors

Constructor and Description
BaseImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls) Construct a new CanvasApi class with an OAuth token

Method Summary

Modifier and Type	Method and Description
protected String	buildCanvasUrl(String canvasMethod, Map<String,List<String>> parameters)
protected String	encode(String value)
protected Optional<T>	getFromCanvas(String url)
protected List<T>	getListFromCanvas(String url)
protected abstract Type	listType()
protected abstract Class<T>	objectType()
protected List<T>	parseListOfResponses(List<Response> responses)
READERTYPE	readAsCanvasUser(String masqueradeAs)
READERTYPE	readAsSisUser(String masqueradeAs)
READERTYPE	withCallback(Consumer<List<T>> responseReceivedCallBack)
WRITERTYPE	writeAsCanvasUser(String masqueradeAs)
WRITERTYPE	writeAsSisUser(String masqueradeAs)

Methods inherited from class java.lang.Object

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

Field Detail

canvasBaseUrl

protected String canvasBaseUrl

apiVersion

protected Integer apiVersion

oauthToken

protected OauthToken oauthToken

responseParser

protected ResponseParser responseParser

canvasMessenger

protected CanvasMessenger canvasMessenger

responseCallback

protected Consumer<List<T>> responseCallback

masqueradeAs

protected String masqueradeAs

masqueradeType

protected String masqueradeType

paginationPageSize

protected Integer paginationPageSize

serializeNulls

protected Boolean serializeNulls

Constructor Detail

BaseImpl

public BaseImpl(String canvasBaseUrl,
                Integer apiVersion,
                OauthToken oauthToken,
                RestClient restClient,
                int connectTimeout,
                int readTimeout,
                Integer paginationPageSize,
                Boolean serializeNulls)

Construct a new CanvasApi class with an OAuth token

Parameters:

canvasBaseUrl - The base URL of your canvas instance

apiVersion - The version of the Canvas API (currently 1)

oauthToken - OAuth token to use when executing API calls

restClient - a RestClient implementation to use when talking to Canvas

connectTimeout - Timeout in seconds to use when connecting

readTimeout - Timeout in seconds to use when waiting for data to come back from an open connection

paginationPageSize - How many objects to request per page on paginated requests

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

Method Detail

getFromCanvas

protected Optional<T> getFromCanvas(String url)
                             throws IOException

Throws:

IOException

getListFromCanvas

protected List<T> getListFromCanvas(String url)
                             throws IOException

Throws:

IOException

withCallback

public READERTYPE withCallback(Consumer<List<T>> responseReceivedCallBack)

Specified by:

withCallback in interface CanvasReader<T,READERTYPE extends CanvasReader>

readAsCanvasUser

public READERTYPE readAsCanvasUser(String masqueradeAs)

Specified by:

readAsCanvasUser in interface CanvasReader<T,READERTYPE extends CanvasReader>

readAsSisUser

public READERTYPE readAsSisUser(String masqueradeAs)

Specified by:

readAsSisUser in interface CanvasReader<T,READERTYPE extends CanvasReader>

writeAsCanvasUser

public WRITERTYPE writeAsCanvasUser(String masqueradeAs)

Specified by:

writeAsCanvasUser in interface CanvasWriter<T,WRITERTYPE extends CanvasWriter>

writeAsSisUser

public WRITERTYPE writeAsSisUser(String masqueradeAs)

Specified by:

writeAsSisUser in interface CanvasWriter<T,WRITERTYPE extends CanvasWriter>

encode

protected String encode(String value)

buildCanvasUrl

protected String buildCanvasUrl(String canvasMethod,
                                Map<String,List<String>> parameters)

listType

protected abstract Type listType()

objectType

protected abstract Class<T> objectType()

parseListOfResponses

protected List<T> parseListOfResponses(List<Response> responses)