Package org.opencastproject.userdirectory.moodle

Class MoodleWebServiceImpl

java.lang.Object

org.opencastproject.userdirectory.moodle.MoodleWebServiceImpl

All Implemented Interfaces:

MoodleWebService

public class MoodleWebServiceImpl
extends Object
implements MoodleWebService

Implementation of the Moodle web service client.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencastproject.userdirectory.moodle.MoodleWebService

MoodleWebService.CoreUserGetUserByFieldFilters

Field Summary

Fields inherited from interface org.opencastproject.userdirectory.moodle.MoodleWebService

MOODLE_FUNCTION_CORE_USER_GET_USERS_BY_FIELD, MOODLE_FUNCTION_TOOL_OPENCAST_GET_COURSES_FOR_INSTRUCTOR, MOODLE_FUNCTION_TOOL_OPENCAST_GET_COURSES_FOR_LEARNER, MOODLE_FUNCTION_TOOL_OPENCAST_GET_GROUPS_FOR_LEARNER

Constructor Summary

Constructors

Constructor	Description
MoodleWebServiceImpl(URI url, String token)	Constructs a new Moodle web service client.

Method Summary

Modifier and Type	Method	Description
List<MoodleUser>	coreUserGetUsersByField(MoodleWebService.CoreUserGetUserByFieldFilters filter, List<String> values)	Searches for a user in Moodle.
String	getURL()	Returns the URL to the Moodle web service.
List<String>	toolOpencastGetCoursesForInstructor(String username)	Returns the list of Moodle course IDs the given user has the instructor capability.
List<String>	toolOpencastGetCoursesForLearner(String username)	Returns the list of Moodle course IDs the given user has the learner capability.
List<String>	toolOpencastGetGroupsForLearner(String username)	Returns the list of Moodle group IDs where the given user has the learner capability.

Methods inherited from class java.lang.Object

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

Constructor Details

MoodleWebServiceImpl

public MoodleWebServiceImpl(URI url,
 String token)

Constructs a new Moodle web service client.

Parameters:

url - URL of the Moodle instance

token - Web service token

Method Details

coreUserGetUsersByField

public List<MoodleUser> coreUserGetUsersByField(MoodleWebService.CoreUserGetUserByFieldFilters filter,
 List<String> values)
                                         throws URISyntaxException,
IOException,
MoodleWebServiceException,
org.json.simple.parser.ParseException

Searches for a user in Moodle.

Specified by:

coreUserGetUsersByField in interface MoodleWebService

Parameters:

filter - Filter type to apply

values - Value for the filter.

Returns:

A MoodleUser list.

Throws:

URISyntaxException - In case the URL cannot be constructed.

IOException - In case of an IO error.

MoodleWebServiceException - In case Moodle returns an error.

org.json.simple.parser.ParseException - In case the Moodle response cannot be parsed.

toolOpencastGetCoursesForInstructor

public List<String> toolOpencastGetCoursesForInstructor(String username)
                                                 throws URISyntaxException,
IOException,
MoodleWebServiceException,
org.json.simple.parser.ParseException

Returns the list of Moodle course IDs the given user has the instructor capability.

Specified by:

toolOpencastGetCoursesForInstructor in interface MoodleWebService

Parameters:

username - The username to search for.

Returns:

A list of Moodle course IDs.

Throws:

URISyntaxException - In case the URL cannot be constructed.

IOException - In case of an IO error.

MoodleWebServiceException - In case Moodle returns an error.

org.json.simple.parser.ParseException - In case the Moodle response cannot be parsed.

See Also:

• MoodleWebService.toolOpencastGetCoursesForInstructor(String)

toolOpencastGetCoursesForLearner

public List<String> toolOpencastGetCoursesForLearner(String username)
                                              throws URISyntaxException,
IOException,
MoodleWebServiceException,
org.json.simple.parser.ParseException

Returns the list of Moodle course IDs the given user has the learner capability.

Specified by:

toolOpencastGetCoursesForLearner in interface MoodleWebService

Parameters:

username - The username to search for.

Returns:

A list of Moodle course IDs.

Throws:

URISyntaxException - In case the URL cannot be constructed.

IOException - In case of an IO error.

MoodleWebServiceException - In case Moodle returns an error.

org.json.simple.parser.ParseException - In case the Moodle response cannot be parsed.

See Also:

• MoodleWebService.toolOpencastGetCoursesForLearner(String)

toolOpencastGetGroupsForLearner

public List<String> toolOpencastGetGroupsForLearner(String username)
                                             throws URISyntaxException,
IOException,
MoodleWebServiceException,
org.json.simple.parser.ParseException

Description copied from interface: MoodleWebService

Returns the list of Moodle group IDs where the given user has the learner capability.

Specified by:

toolOpencastGetGroupsForLearner in interface MoodleWebService

Parameters:

username - The username to search for.

Returns:

A list of Moodle group IDs.

Throws:

URISyntaxException - In case the URL cannot be constructed.

IOException - In case of an IO error.

MoodleWebServiceException - In case Moodle returns an error.

org.json.simple.parser.ParseException - In case the Moodle response cannot be parsed.

getURL

public String getURL()

Returns the URL to the Moodle web service.

Specified by:

getURL in interface MoodleWebService

Returns:

URL to the Moodle web service.

See Also:

• MoodleWebService.getURL()