edu.ksu.canvas.impl

Class LoginImpl

java.lang.Object

edu.ksu.canvas.impl.BaseImpl<Login,LoginReader,LoginWriter>

edu.ksu.canvas.impl.LoginImpl

All Implemented Interfaces:

CanvasReader<Login,LoginReader>, CanvasWriter<Login,LoginWriter>, LoginReader, LoginWriter

public class LoginImpl
extends BaseImpl<Login,LoginReader,LoginWriter>
implements LoginReader, LoginWriter

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
LoginImpl(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<Login>	deleteLogin(Login login) Delete a login from Canvas
List<Login>	getLoginForUser(String userId) Retrieve a user's logins.
protected Type	listType()
protected Class<Login>	objectType()
Optional<Login>	updateLogin(Login login) Write changes to a login to Canvas.

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

LoginImpl

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

Method Detail

getLoginForUser

public List<Login> getLoginForUser(String userId)
                            throws IOException

Description copied from interface: LoginReader

Retrieve a user's logins.

Specified by:

getLoginForUser in interface LoginReader

Parameters:

userId - the id of the user to retrieve logins for

Returns:

List of the user's logins

Throws:

IOException - When there is an error communicating with Canvas

updateLogin

public Optional<Login> updateLogin(Login login)
                            throws IOException

Description copied from interface: LoginWriter

Write changes to a login to Canvas.

Specified by:

updateLogin in interface LoginWriter

Parameters:

login - The modified login to update. Must contain account ID and login ID.

Returns:

The modified login object if update was successful

Throws:

IOException - When there is an error communicating with Canvas

deleteLogin

public Optional<Login> deleteLogin(Login login)
                            throws IOException

Description copied from interface: LoginWriter

Delete a login from Canvas

Specified by:

deleteLogin in interface LoginWriter

Parameters:

login - The login record to delete. Must contain User ID and login ID.

Returns:

The now deleted login record

Throws:

IOException - When there is an error communicating with Canvas

listType

protected Type listType()

Specified by:

listType in class BaseImpl<Login,LoginReader,LoginWriter>

objectType

protected Class<Login> objectType()

Specified by:

objectType in class BaseImpl<Login,LoginReader,LoginWriter>