me.vertretungsplan.parser

Class DSBLightParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.UntisCommonParser

me.vertretungsplan.parser.DSBLightParser

All Implemented Interfaces:

SubstitutionScheduleParser

public class DSBLightParser
extends UntisCommonParser

Parser for Untis substitution schedules served by DSBlight. Supports both password-protected and public schedules.

It seems that the "light" version of DSB is discontinued, many schools are currently switching to the newer DSBmobile (which can be parsed with DSBMobileParser.

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

Configuration parameters

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

id (String, required)

The ID of the DSBlight instance. This is a UUID and can be found in the URL (Player.aspx?ID=...)

classes (Array of Strings, required)

The list of all classes, as they can appear in the schedule

encoding (String, required)

The charset of the Untis schedule. DSBlight itself always uses UTF-8, but the hosted HTML schedule can also be ISO-8859-1.

login (Boolean, optional, Default: false)

Whether this DSBlight instance requires login using a username and a password.

baseurl (String, optional, Default: https://light.dsbcontrol .de/DSBlightWebsite/Homepage/)

URL where this DSBlight instance is located

iframeIndex (Integer, optional)

If this is set, the content of only one of the displayed iframes is used

Additionally, this parser supports the parameters specified in UntisCommonParser and LoginHandler (the latter as an alternative to the Boolean login parameter defined here). For password protected schedules, you have to use a UserPasswordAuthenticationData.

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
DSBLightParser(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.UntisCommonParser

parseSubstitutionTable

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

DSBLightParser

public DSBLightParser(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

Description copied from class: BaseParser

Get a list of all available classes.

Overrides:

getAllClasses in class UntisCommonParser

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

getAllTeachers

public List<String> getAllTeachers()

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)