edu.ksu.canvas.impl

Class ExternalToolImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<ExternalTool,ExternalToolReader,ExternalToolWriter>

edu.ksu.canvas.impl.ExternalToolImpl

All Implemented Interfaces:

CanvasReader<ExternalTool,ExternalToolReader>, CanvasWriter<ExternalTool,ExternalToolWriter>, ExternalToolReader, ExternalToolWriter

public class ExternalToolImpl
extends BaseImpl<ExternalTool,ExternalToolReader,ExternalToolWriter>
implements ExternalToolReader, ExternalToolWriter

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
ExternalToolImpl(String canvasBaseUrl, Integer apiVersion, OauthToken oauthToken, RestClient restClient, int connectTimeout, int readTimeout, Integer paginationPageSize, Boolean serializeNulls)

Method Summary

Modifier and Type	Method and Description
Optional<ExternalTool>	createExternalToolInAccount(String accountId, ExternalTool tool) Create an External tool in the specified Canvas account
Optional<ExternalTool>	createExternalToolInCourse(String courseId, ExternalTool tool) Create an External tool in the specified Canvas course
Optional<ExternalTool>	deleteExternalToolInAccount(String accountId, Integer toolId) Delete an external tool from an account.
Optional<ExternalTool>	deleteExternalToolInCourse(String courseId, Integer toolId) Delete an external tool from a course.
Optional<ExternalTool>	editExternalToolInAccount(String accountId, ExternalTool tool) Modify the settings of an external tool associated with an account
Optional<ExternalTool>	editExternalToolInCourse(String courseId, ExternalTool tool) Modify the settings of an external tool associated with a course
Optional<ExternalTool>	getExternalToolInAccount(String accountId, Integer toolId) Retrieve a specific external tool configuration in a given account
Optional<ExternalTool>	getExternalToolInCourse(String courseId, Integer toolId) Retrieve a specific external tool configuration in a given course
List<ExternalTool>	listExternalToolsInAccount(ListExternalToolsOptions options) Return a list of external tools registered to an account
List<ExternalTool>	listExternalToolsInCourse(ListExternalToolsOptions options) Return a list of external tools registered to a course
List<ExternalTool>	listExternalToolsInGroup(ListExternalToolsOptions options) Return a list of external tools registered to a group
protected Type	listType()
protected Class<ExternalTool>	objectType()

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

ExternalToolImpl

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

Method Detail

getExternalToolInCourse

public Optional<ExternalTool> getExternalToolInCourse(String courseId,
                                                      Integer toolId)
                                               throws IOException

Description copied from interface: ExternalToolReader

Retrieve a specific external tool configuration in a given course

Specified by:

getExternalToolInCourse in interface ExternalToolReader

Parameters:

courseId - The Canvas ID or sis_course_id:[SIS ID] for the course to query

toolId - The Canvas ID of the tool to query

Returns:

The requested tool's configuration

Throws:

IOException - if there is an error communicating with Canvas

getExternalToolInAccount

public Optional<ExternalTool> getExternalToolInAccount(String accountId,
                                                       Integer toolId)
                                                throws IOException

Description copied from interface: ExternalToolReader

Retrieve a specific external tool configuration in a given account

Specified by:

getExternalToolInAccount in interface ExternalToolReader

Parameters:

accountId - The Canvas ID or sis_account_id:[SIS ID] for the account to query

toolId - The Canvas ID of the tool to query

Returns:

The requested tool's configuration

Throws:

IOException - if there is an error communicating with Canvas

listExternalToolsInAccount

public List<ExternalTool> listExternalToolsInAccount(ListExternalToolsOptions options)
                                              throws IOException

Description copied from interface: ExternalToolReader

Return a list of external tools registered to an account

Specified by:

listExternalToolsInAccount in interface ExternalToolReader

Parameters:

options - Parameters that alter which tools are returned by this call

Returns:

List of external tools in the account

Throws:

IOException - if there is an error communicating with Canvas

listExternalToolsInCourse

public List<ExternalTool> listExternalToolsInCourse(ListExternalToolsOptions options)
                                             throws IOException

Description copied from interface: ExternalToolReader

Return a list of external tools registered to a course

Specified by:

listExternalToolsInCourse in interface ExternalToolReader

Parameters:

options - Parameters that alter which tools are returned by this call

Returns:

List of external tools in the course

Throws:

IOException - if there is an error communicating with Canvas

listExternalToolsInGroup

public List<ExternalTool> listExternalToolsInGroup(ListExternalToolsOptions options)
                                            throws IOException

Description copied from interface: ExternalToolReader

Return a list of external tools registered to a group

Specified by:

listExternalToolsInGroup in interface ExternalToolReader

Parameters:

options - Parameters that alter which tools are returned by this call

Returns:

List of external tools in the group

Throws:

IOException - if there is an error communicating with Canvas

createExternalToolInCourse

public Optional<ExternalTool> createExternalToolInCourse(String courseId,
                                                         ExternalTool tool)
                                                  throws IOException

Description copied from interface: ExternalToolWriter

Create an External tool in the specified Canvas course

Specified by:

createExternalToolInCourse in interface ExternalToolWriter

Parameters:

courseId - Canvas ID or sis_course_id:[SIS ID] for the course to create the tool in

tool - The tool to create. Must have name, privacy level, consumer key, shared secret and either url or domain

Returns:

The newly created external tool with the Canvas assigned ID

Throws:

IOException - if there is an error communicating with Canvas

createExternalToolInAccount

public Optional<ExternalTool> createExternalToolInAccount(String accountId,
                                                          ExternalTool tool)
                                                   throws IOException

Description copied from interface: ExternalToolWriter

Create an External tool in the specified Canvas account

Specified by:

createExternalToolInAccount in interface ExternalToolWriter

Parameters:

accountId - Canvas ID or sis_account_id:[SIS ID] for the account to create the tool in

tool - The tool to create. Must have name, privacy level, consumer key, shared secret and either url or domain

Returns:

The newly created external tool with the Canvas assigned ID

Throws:

IOException - if there is an error communicating with Canvas

editExternalToolInCourse

public Optional<ExternalTool> editExternalToolInCourse(String courseId,
                                                       ExternalTool tool)
                                                throws IOException

Description copied from interface: ExternalToolWriter

Modify the settings of an external tool associated with a course

Specified by:

editExternalToolInCourse in interface ExternalToolWriter

Parameters:

courseId - Canvas ID or sis_course_id:[SIS ID] for the course

tool - The tool with settings to be modified. Tool ID must be present

Returns:

The updated tool object

Throws:

IOException - if there is an error communicating with Canvas

editExternalToolInAccount

public Optional<ExternalTool> editExternalToolInAccount(String accountId,
                                                        ExternalTool tool)
                                                 throws IOException

Description copied from interface: ExternalToolWriter

Modify the settings of an external tool associated with an account

Specified by:

editExternalToolInAccount in interface ExternalToolWriter

Parameters:

accountId - Canvas ID or sis_account_id:[SIS ID] for the account that contains the tool

tool - The tool with settings to be modified. Tool ID must be present

Returns:

The updated tool object

Throws:

IOException - if there is an error communicating with Canvas

deleteExternalToolInCourse

public Optional<ExternalTool> deleteExternalToolInCourse(String courseId,
                                                         Integer toolId)
                                                  throws IOException

Description copied from interface: ExternalToolWriter

Delete an external tool from a course.

Specified by:

deleteExternalToolInCourse in interface ExternalToolWriter

Parameters:

courseId - Canvas course ID or sis_course_id:[SIS ID] for the course to delete the tool from

toolId - The Canvas ID of the tool to delete

Returns:

The deleted tool. Should have a workflow state of "deleted"

Throws:

IOException - if there is an error communicating with Canvas

deleteExternalToolInAccount

public Optional<ExternalTool> deleteExternalToolInAccount(String accountId,
                                                          Integer toolId)
                                                   throws IOException

Description copied from interface: ExternalToolWriter

Delete an external tool from an account.

Specified by:

deleteExternalToolInAccount in interface ExternalToolWriter

Parameters:

accountId - Canvas account ID or sis_account_id:[SIS ID] for the account to delete the tool from

toolId - Canvas ID of the tool to delete

Returns:

The deleted tool. Should have a workflow state of "deleted"

Throws:

IOException - if there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<ExternalTool,ExternalToolReader,ExternalToolWriter>

objectType

protected Class<ExternalTool> objectType()

Specified by:

objectType in class BaseImpl<ExternalTool,ExternalToolReader,ExternalToolWriter>