edu.ksu.canvas.impl

Class FileImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<File,FileReader,FileWriter>

edu.ksu.canvas.impl.FileImpl

All Implemented Interfaces:

CanvasReader<File,FileReader>, CanvasWriter<File,FileWriter>, FileReader, FileWriter

public class FileImpl
extends BaseImpl<File,FileReader,FileWriter>
implements FileReader, FileWriter

Field Summary

Fields inherited from class edu.ksu.canvas.impl.BaseImpl

apiVersion, canvasBaseUrl, canvasMessenger, masqueradeAs, masqueradeType, oauthToken, paginationPageSize, responseCallback, responseParser, serializeNulls

Constructor Summary

Constructors

Constructor and Description
FileImpl(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
Optional<File>	getFile(String url) This is used primarily when you have a redirect after you've uploaded a file.
protected Type	listType()
protected Class<File>	objectType()
Optional<File>	upload(Deposit deposit, InputStream in, String filename)

Methods inherited from class edu.ksu.canvas.impl.BaseImpl

buildCanvasUrl, encode, getFromCanvas, getListFromCanvas, parseListOfResponses, readAsCanvasUser, readAsSisUser, withCallback, writeAsCanvasUser, writeAsSisUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.ksu.canvas.interfaces.CanvasReader

readAsCanvasUser, readAsSisUser, withCallback

Methods inherited from interface edu.ksu.canvas.interfaces.CanvasWriter

writeAsCanvasUser, writeAsSisUser

Constructor Detail

FileImpl

public FileImpl(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

upload

public Optional<File> upload(Deposit deposit,
                             InputStream in,
                             String filename)
                      throws IOException

Specified by:

upload in interface FileWriter

Throws:

IOException

getFile

public Optional<File> getFile(String url)
                       throws IOException

Description copied from interface: FileReader

This is used primarily when you have a redirect after you've uploaded a file.

Specified by:

getFile in interface FileReader

Parameters:

url - The URL of the file that has been uploaded.

Returns:

The file object wrapped in an optional.

Throws:

IOException - When there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<File,FileReader,FileWriter>

objectType

protected Class<File> objectType()

Specified by:

objectType in class BaseImpl<File,FileReader,FileWriter>