MoodleServiceClient (DeepaMehta 4 Moodle Plugin 1.2.2-SNAPSHOT API)

java.lang.Object
- de.deepamehta.core.osgi.PluginActivator
- - org.deepamehta.plugins.moodle.MoodleServiceClient

All Implemented Interfaces:

PluginContext, EventListener, PostLoginUserListener, org.osgi.framework.BundleActivator
```
public class MoodleServiceClient
extends PluginActivator
implements PostLoginUserListener
```
A webservice-client enabling collaborative mapping on course-materials (and more) for any moodle (2.4+) course. A very simple plugin to connect users of DeepaMehta 4 with a moodle installation.

Version:

1.2.2-SNAPSHOT

Author:

Malte Reißig ()

Field Summary

Fields
Modifier and Type	Field and Description
`private AccessControlService`	`aclService`
`private String`	`AGGREGATION_TYPE_URI`
`private String`	`CHILD_ROLE_TYPE_URI`
`private String`	`CHILD_URI`
`private String`	`CLIENT_OPTION_ENDPOINT_URL_URI`
`private String`	`CLIENT_OPTION_JAVA_KEY_STORE_PASS`
`private String`	`CLIENT_OPTION_JAVA_KEY_STORE_PATH`
`private String`	`CLIENT_OPTION_USE_HTTPS`
`private String`	`COMPOSITION_TYPE_URI`
`private String`	`DEFAULT_ROLE_TYPE_URI`
`static String`	`ISIS_COURSE_URI_PREFIX`
`static String`	`ISIS_ITEM_URI_PREFIX`
`static String`	`ISIS_SECTION_URI_PREFIX`
`private static Logger`	`logger`
`static String`	`MOODLE_COURSE_NAME_URI`
`static String`	`MOODLE_COURSE_SHORT_NAME_URI`
`static String`	`MOODLE_COURSE_URI`
`static String`	`MOODLE_ITEM_AUTHOR_URI`
`static String`	`MOODLE_ITEM_CREATED_URI`
`static String`	`MOODLE_ITEM_DESC_URI`
`static String`	`MOODLE_ITEM_HREF_URI`
`static String`	`MOODLE_ITEM_ICON_URI`
`static String`	`MOODLE_ITEM_LICENSE_URI`
`static String`	`MOODLE_ITEM_MEDIA_TYPE_URI`
`static String`	`MOODLE_ITEM_MODIFIED_URI`
`static String`	`MOODLE_ITEM_NAME_URI`
`static String`	`MOODLE_ITEM_REMOTE_URL_URI`
`static String`	`MOODLE_ITEM_SIZE_URI`
`static String`	`MOODLE_ITEM_TYPE_URI`
`static String`	`MOODLE_ITEM_URI`
`static String`	`MOODLE_PARTICIPANT_EDGE`
`static String`	`MOODLE_SECTION_NAME_URI`
`static String`	`MOODLE_SECTION_ORDINAL_NR`
`static String`	`MOODLE_SECTION_SUMMARY_URI`
`static String`	`MOODLE_SECTION_URI`
`private int`	`MOODLE_SECURITY_KEY_LENGTH`
`private String`	`MOODLE_SECURITY_KEY_URI`
`private String`	`MOODLE_SERVICE_FORMAT`
`private String`	`MOODLE_SERVICE_NAME`
`private String`	`MOODLE_USER_ID_URI`
`private String`	`PARENT_ROLE_TYPE_URI`
`private String`	`PARENT_URI`
`private String`	`REVIEW_SCORE_URI`
`private String`	`TAG_URI`
`private String`	`URI_URI`
`private String`	`USER_ACCOUNT_TYPE_URI`
`private String`	`USER_NAME_TYPE_URI`
`private String`	`USERNAME_OF_SETTINGS_ADMINISTRATOR`
`private String`	`WEBSERVICE_CLIENT_OPTION_OPTION`
`static String`	`WS_MOODLE_NAME`
`static String`	`WS_MOODLE_URI`

Fields inherited from class de.deepamehta.core.osgi.PluginActivator
bundle, dms

Constructor Summary

Constructors
Constructor and Description

MoodleServiceClient()

Constructors
Constructor and Description
`MoodleServiceClient()`

Method Summary

Methods
Modifier and Type	Method and Description
`private void`	`assignToMoodleWorkspace(Topic topic)`
`private boolean`	`associationExists(String edge_type, Topic item, Topic user)`
`private String`	`callMoodle(String key, String functionName, String params)` Do a HTTP/S request to the configured moodle endpoint.
`private Topic`	`checkAuthorization()`
`private void`	`createAggregatingCourseEdge(Topic courseTopic, Topic sectionTopic)`
`private void`	`createAggregatingSectionEdge(Topic sectionTopic, Topic itemTopic)`
`private Topic`	`createMoodleCourseItemTopic(org.codehaus.jettison.json.JSONObject object, List<Topic> hashtags)`
`private Topic`	`createMoodleCourseTopic(org.codehaus.jettison.json.JSONObject object)`
`private Topic`	`createMoodleSectionTopic(org.codehaus.jettison.json.JSONObject object, int nr)`
`private void`	`createParticipantEdge(Topic courseTopic, Topic userAccount)`
`private void`	`fetchAndSetMoodleUserId(Topic userAccount)` Fetches and relates the internal moodle-user-id to our currently logged-in user-account.
`private void`	`fetchMoodleCourseItems(long topicId, String token, List<Topic> hashtags)`
`private void`	`fetchMoodleCourses(Topic userAccount, long moodleUserId, String token)`
`private Topic`	`getJavaKeyStorePass()`
`private Topic`	`getJavaKeyStorePath()`
`private Topic`	`getMoodleCourseItemTopic(long itemId)`
`private Topic`	`getMoodleCourseTopic(long courseId)`
`private ResultList<RelatedTopic>`	`getMoodleCourseTopicsByUser(Topic user)`
`private Topic`	`getMoodleEndpointUrl()`
`private Topic`	`getMoodleSectionTopic(long sectionId)`
`String`	`getMoodleSecurityKey()` Delivers the moodle security key for the logged in user to the requesting client.
`private String`	`getMoodleSecurityKeyWithoutAuthCheck(Topic userAccount)`
`private long`	`getMoodleUserId(Topic userAccount)`
`private Topic`	`getUserAccountTopic(String username)`
`private boolean`	`hasAggregatingCourseParentEdge(Topic child, Topic parent)`
`private boolean`	`hasAggregatingSectionParentEdge(Topic child, Topic parent)`
`private boolean`	`hasAnyWorkspace(Topic topic)`
`private boolean`	`hasParticipantEdge(Topic course, Topic user)`
`void`	`init()`
`private boolean`	`isHTTPSConfigured()`
`private ChildTopicsModel`	`parseGenericsToItemModel(org.codehaus.jettison.json.JSONObject object)`
`private ChildTopicsModel`	`parseResourceToItemModel(ChildTopicsModel model, org.codehaus.jettison.json.JSONObject resource)`
`private ChildTopicsModel`	`parseTimestampsToItemModel(ChildTopicsModel model, org.codehaus.jettison.json.JSONObject item)`
`private String`	`parseYoutubeEmbedUrl(String fileUrl)`
`void`	`postInstall()`
`void`	`postLoginUser(String username)`
`private DeepaMehtaObject`	`setDefaultMoodleAdminACLEntries(DeepaMehtaObject item)`
`private DeepaMehtaObject`	`setDefaultMoodleGroupACLEntries(DeepaMehtaObject item)`
`String`	`setMoodleSecurityKey(int id, String input)` Relates the moodle-security-key to our currently logged-in user-account.
`private void`	`setMoodleUserId(Topic userAccount, long moodleUserId)`
`String`	`startMoodleSynchronization(String username)`
`private void`	`startSynchronizationThreadFor(Topic user)`
`private Topic`	`updateMoodleCourseItemTopic(Topic item, org.codehaus.jettison.json.JSONObject object)`
`private Topic`	`updateMoodleCourseTopic(Topic course, org.codehaus.jettison.json.JSONObject object)`
`private Topic`	`updateMoodleSectionTopic(Topic section, org.codehaus.jettison.json.JSONObject object)`

Methods inherited from class de.deepamehta.core.osgi.PluginActivator
getBundleContext, getPluginName, getStaticResource, getUri, publishDirectory, serviceArrived, serviceGone, setCoreService, shutdown, start, stop, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- WS_MOODLE_NAME
```
public static final String WS_MOODLE_NAME
```
  See Also:
  Constant Field Values
- WS_MOODLE_URI
```
public static final String WS_MOODLE_URI
```
  See Also:
  Constant Field Values
- MOODLE_PARTICIPANT_EDGE
```
public static final String MOODLE_PARTICIPANT_EDGE
```
  See Also:
  Constant Field Values
- MOODLE_COURSE_URI
```
public static final String MOODLE_COURSE_URI
```
  See Also:
  Constant Field Values
- MOODLE_COURSE_NAME_URI
```
public static final String MOODLE_COURSE_NAME_URI
```
  See Also:
  Constant Field Values
- MOODLE_COURSE_SHORT_NAME_URI
```
public static final String MOODLE_COURSE_SHORT_NAME_URI
```
  See Also:
  Constant Field Values
- MOODLE_SECTION_URI
```
public static final String MOODLE_SECTION_URI
```
  See Also:
  Constant Field Values
- MOODLE_SECTION_NAME_URI
```
public static final String MOODLE_SECTION_NAME_URI
```
  See Also:
  Constant Field Values
- MOODLE_SECTION_SUMMARY_URI
```
public static final String MOODLE_SECTION_SUMMARY_URI
```
  See Also:
  Constant Field Values
- MOODLE_SECTION_ORDINAL_NR
```
public static final String MOODLE_SECTION_ORDINAL_NR
```
  See Also:
  Constant Field Values
- MOODLE_ITEM_URI
```
public static final String MOODLE_ITEM_URI
```
  See Also:
  Constant Field Values
- MOODLE_ITEM_NAME_URI
```
public static final String MOODLE_ITEM_NAME_URI
```
  See Also:
  Constant Field Values
- MOODLE_ITEM_ICON_URI
```
public static final String MOODLE_ITEM_ICON_URI
```
  See Also:
  Constant Field Values
- MOODLE_ITEM_REMOTE_URL_URI
```
public static final String MOODLE_ITEM_REMOTE_URL_URI
```
  See Also:
  Constant Field Values
- MOODLE_ITEM_MEDIA_TYPE_URI
```
public static final String MOODLE_ITEM_MEDIA_TYPE_URI
```
  See Also:
  Constant Field Values
- MOODLE_ITEM_DESC_URI
```
public static final String MOODLE_ITEM_DESC_URI
```
  See Also:
  Constant Field Values
- MOODLE_ITEM_HREF_URI
```
public static final String MOODLE_ITEM_HREF_URI
```
  See Also:
  Constant Field Values
- MOODLE_ITEM_TYPE_URI
```
public static final String MOODLE_ITEM_TYPE_URI
```
  See Also:
  Constant Field Values
- MOODLE_ITEM_MODIFIED_URI
```
public static final String MOODLE_ITEM_MODIFIED_URI
```
  See Also:
  Constant Field Values
- MOODLE_ITEM_CREATED_URI
```
public static final String MOODLE_ITEM_CREATED_URI
```
  See Also:
  Constant Field Values
- MOODLE_ITEM_AUTHOR_URI
```
public static final String MOODLE_ITEM_AUTHOR_URI
```
  See Also:
  Constant Field Values
- MOODLE_ITEM_LICENSE_URI
```
public static final String MOODLE_ITEM_LICENSE_URI
```
  See Also:
  Constant Field Values
- MOODLE_ITEM_SIZE_URI
```
public static final String MOODLE_ITEM_SIZE_URI
```
  See Also:
  Constant Field Values
- ISIS_COURSE_URI_PREFIX
```
public static final String ISIS_COURSE_URI_PREFIX
```
  See Also:
  Constant Field Values
- ISIS_SECTION_URI_PREFIX
```
public static final String ISIS_SECTION_URI_PREFIX
```
  See Also:
  Constant Field Values
- ISIS_ITEM_URI_PREFIX
```
public static final String ISIS_ITEM_URI_PREFIX
```
  See Also:
  Constant Field Values
- WEBSERVICE_CLIENT_OPTION_OPTION
```
private final String WEBSERVICE_CLIENT_OPTION_OPTION
```
  See Also:
  Constant Field Values
- CLIENT_OPTION_ENDPOINT_URL_URI
```
private final String CLIENT_OPTION_ENDPOINT_URL_URI
```
  See Also:
  Constant Field Values
- CLIENT_OPTION_USE_HTTPS
```
private final String CLIENT_OPTION_USE_HTTPS
```
  See Also:
  Constant Field Values
- CLIENT_OPTION_JAVA_KEY_STORE_PATH
```
private final String CLIENT_OPTION_JAVA_KEY_STORE_PATH
```
  See Also:
  Constant Field Values
- CLIENT_OPTION_JAVA_KEY_STORE_PASS
```
private final String CLIENT_OPTION_JAVA_KEY_STORE_PASS
```
  See Also:
  Constant Field Values
- USERNAME_OF_SETTINGS_ADMINISTRATOR
```
private final String USERNAME_OF_SETTINGS_ADMINISTRATOR
```
  See Also:
  Constant Field Values
- MOODLE_SECURITY_KEY_URI
```
private final String MOODLE_SECURITY_KEY_URI
```
  See Also:
  Constant Field Values
- MOODLE_USER_ID_URI
```
private final String MOODLE_USER_ID_URI
```
  See Also:
  Constant Field Values
- MOODLE_SERVICE_NAME
```
private final String MOODLE_SERVICE_NAME
```
  See Also:
  Constant Field Values
- MOODLE_SERVICE_FORMAT
```
private final String MOODLE_SERVICE_FORMAT
```
  See Also:
  Constant Field Values
- MOODLE_SECURITY_KEY_LENGTH
```
private final int MOODLE_SECURITY_KEY_LENGTH
```
  See Also:
  Constant Field Values
- URI_URI
```
private final String URI_URI
```
  See Also:
  Constant Field Values
- DEFAULT_ROLE_TYPE_URI
```
private final String DEFAULT_ROLE_TYPE_URI
```
  See Also:
  Constant Field Values
- CHILD_ROLE_TYPE_URI
```
private final String CHILD_ROLE_TYPE_URI
```
  See Also:
  Constant Field Values
- PARENT_ROLE_TYPE_URI
```
private final String PARENT_ROLE_TYPE_URI
```
  See Also:
  Constant Field Values
- AGGREGATION_TYPE_URI
```
private final String AGGREGATION_TYPE_URI
```
  See Also:
  Constant Field Values
- COMPOSITION_TYPE_URI
```
private final String COMPOSITION_TYPE_URI
```
  See Also:
  Constant Field Values
- USER_ACCOUNT_TYPE_URI
```
private final String USER_ACCOUNT_TYPE_URI
```
  See Also:
  Constant Field Values
- USER_NAME_TYPE_URI
```
private final String USER_NAME_TYPE_URI
```
  See Also:
  Constant Field Values
- CHILD_URI
```
private final String CHILD_URI
```
  See Also:
  Constant Field Values
- PARENT_URI
```
private final String PARENT_URI
```
  See Also:
  Constant Field Values
- TAG_URI
```
private final String TAG_URI
```
  See Also:
  Constant Field Values
- REVIEW_SCORE_URI
```
private final String REVIEW_SCORE_URI
```
  See Also:
  Constant Field Values
- logger
```
private static Logger logger
```
- aclService
```
private AccessControlService aclService
```

Constructor Detail
- MoodleServiceClient
```
public MoodleServiceClient()
```

Method Detail

init
```
public void init()
```
Specified by:

init in interface PluginContext

Overrides:

init in class PluginActivator

postInstall
```
public void postInstall()
```
Specified by:

postInstall in interface PluginContext

Overrides:

postInstall in class PluginActivator

postLoginUser
```
public void postLoginUser(String username)
```
Specified by:

postLoginUser in interface PostLoginUserListener

startMoodleSynchronization

public String startMoodleSynchronization(String username)

getMoodleSecurityKey

public String getMoodleSecurityKey()

Delivers the moodle security key for the logged in user to the requesting client. This is needed to load course materials (esp. files) directly into the browser where thens, e.g. in Firefox

Class MoodleServiceClient

Field Summary

Fields inherited from class de.deepamehta.core.osgi.PluginActivator

Constructor Summary

Method Summary

Methods inherited from class de.deepamehta.core.osgi.PluginActivator

Methods inherited from class java.lang.Object

Field Detail

WS_MOODLE_NAME

WS_MOODLE_URI

MOODLE_PARTICIPANT_EDGE

MOODLE_COURSE_URI

MOODLE_COURSE_NAME_URI

MOODLE_COURSE_SHORT_NAME_URI

MOODLE_SECTION_URI

MOODLE_SECTION_NAME_URI

MOODLE_SECTION_SUMMARY_URI

MOODLE_SECTION_ORDINAL_NR

MOODLE_ITEM_URI

MOODLE_ITEM_NAME_URI

MOODLE_ITEM_ICON_URI

MOODLE_ITEM_REMOTE_URL_URI

MOODLE_ITEM_MEDIA_TYPE_URI

MOODLE_ITEM_DESC_URI

MOODLE_ITEM_HREF_URI

MOODLE_ITEM_TYPE_URI

MOODLE_ITEM_MODIFIED_URI

MOODLE_ITEM_CREATED_URI

MOODLE_ITEM_AUTHOR_URI

MOODLE_ITEM_LICENSE_URI

MOODLE_ITEM_SIZE_URI

ISIS_COURSE_URI_PREFIX

ISIS_SECTION_URI_PREFIX

ISIS_ITEM_URI_PREFIX

WEBSERVICE_CLIENT_OPTION_OPTION

CLIENT_OPTION_ENDPOINT_URL_URI

CLIENT_OPTION_USE_HTTPS

CLIENT_OPTION_JAVA_KEY_STORE_PATH

CLIENT_OPTION_JAVA_KEY_STORE_PASS

USERNAME_OF_SETTINGS_ADMINISTRATOR

MOODLE_SECURITY_KEY_URI

MOODLE_USER_ID_URI

MOODLE_SERVICE_NAME

MOODLE_SERVICE_FORMAT

MOODLE_SECURITY_KEY_LENGTH

URI_URI

DEFAULT_ROLE_TYPE_URI

CHILD_ROLE_TYPE_URI

PARENT_ROLE_TYPE_URI

AGGREGATION_TYPE_URI

COMPOSITION_TYPE_URI

USER_ACCOUNT_TYPE_URI

USER_NAME_TYPE_URI

CHILD_URI

PARENT_URI

TAG_URI

REVIEW_SCORE_URI

logger

aclService

Constructor Detail

MoodleServiceClient

Method Detail

init

postInstall

postLoginUser

startMoodleSynchronization

getMoodleSecurityKey

setMoodleSecurityKey

startSynchronizationThreadFor

fetchAndSetMoodleUserId

fetchMoodleCourses

fetchMoodleCourseItems

createParticipantEdge

hasParticipantEdge

createAggregatingCourseEdge

hasAggregatingCourseParentEdge

createAggregatingSectionEdge

hasAggregatingSectionParentEdge

createMoodleCourseTopic

updateMoodleCourseTopic