me.vertretungsplan.parser

Class LegionBoardParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.LegionBoardParser

All Implemented Interfaces:

SubstitutionScheduleParser

public class LegionBoardParser
extends BaseParser

Parser for LegionBoard, an open source changes management system for schools.

More information can be found on the official website and on its project page on GitLab.

This parser can be accessed using "legionboard" for SubstitutionScheduleData.setApi(String).

Configuration parameters

These parameters can be supplied in SubstitutionScheduleData.setData(JSONObject) to configure the parser:

api (String, required)

The URL where the LegionBoard Heart API can be found.

website (String, recommended)

The URL of a website where the substitution schedule can be seen online. Normally, this would be the URL of the LegionBoard Eye instance.

You have to use a UserPasswordAuthenticationData because all schedules on LegionBoard are protected by a login.

Field Summary

Fields inherited from class me.vertretungsplan.parser.BaseParser

colorProvider, cookieProvider, cookieStore, credential, encodingDetector, executor, PARAM_CLASS_REGEX, scheduleData

Constructor Summary

Constructors

Constructor and Description
LegionBoardParser(SubstitutionScheduleData scheduleData, CookieProvider cookieProvider)

Method Summary

Modifier and Type	Method and Description
List<String>	getAllClasses() Get a list of all available classes.
List<String>	getAllTeachers() Get a list of all available teachers.
SubstitutionSchedule	getSubstitutionSchedule() Downloads and parses the substitution schedule

Methods inherited from class me.vertretungsplan.parser.BaseParser

contains, getClassesFromJson, getCredential, getInstance, httpGet, httpGet, httpPost, httpPost, httpPost, httpPost, recognizeType, setCredential

Methods inherited from class java.lang.Object

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

Constructor Detail

LegionBoardParser

public LegionBoardParser(SubstitutionScheduleData scheduleData,
                         CookieProvider cookieProvider)

Method Detail

getSubstitutionSchedule

public SubstitutionSchedule getSubstitutionSchedule()
                                             throws IOException,
                                                    org.json.JSONException,
                                                    CredentialInvalidException

Description copied from class: BaseParser

Downloads and parses the substitution schedule

Specified by:

getSubstitutionSchedule in interface SubstitutionScheduleParser

Specified by:

getSubstitutionSchedule in class BaseParser

Returns:

the parsed SubstitutionSchedule

Throws:

IOException - Connection or parsing error

org.json.JSONException - Error with the JSON configuration

CredentialInvalidException - the supplied credential (BaseParser.setCredential(Credential) is not correct

getAllClasses

public List<String> getAllClasses()
                           throws IOException,
                                  org.json.JSONException,
                                  CredentialInvalidException

Description copied from class: BaseParser

Get a list of all available classes.

Specified by:

getAllClasses in class BaseParser

Returns:

a list of all available classes (also those not currently affected by the substitution schedule)

Throws:

IOException - Connection or parsing error

org.json.JSONException - Error with the JSON configuration

CredentialInvalidException

getAllTeachers

public List<String> getAllTeachers()
                            throws IOException,
                                   org.json.JSONException,
                                   CredentialInvalidException

Description copied from class: BaseParser

Get a list of all available teachers. Can also be null.

Specified by:

getAllTeachers in class BaseParser

Returns:

a list of all available teachers (also those not currently affected by the substitution schedule)

Throws:

IOException - Connection or parsing error

org.json.JSONException - Error with the JSON configuration

CredentialInvalidException