me.vertretungsplan.parser

Class WebUntisParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.WebUntisParser

All Implemented Interfaces:

SubstitutionScheduleParser

public class WebUntisParser
extends BaseParser

Parser for substitution schedules hosted on WebUntis.

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

Please bear in mind that WebUntis's API does not allow frequent polling, according to this forum post

Configuration parameters

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

host (String, required)

The hostname of the WebUntis server. For schedules hosted by Gruber&Petters, this is `<something>.webuntis .com`.

schoolname (String, required)

The school name entered into WebUntis for login.

protocol (String, optional, Default: https)

The protocol used to access WebUntis. The *.webuntis.com servers support HTTPS, self-hosted ones may not.

Schedules on WebUntis are always protected using a UserPasswordAuthenticationData.

Field Summary

Fields

Modifier and Type	Field and Description
static org.joda.time.format.DateTimeFormatter	DATE_FORMAT
static String	PARAM_PROTOCOL
static org.joda.time.format.DateTimeFormatter	TIME_FORMAT

Fields inherited from class me.vertretungsplan.parser.BaseParser

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

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
boolean	isPersonal() Some substitution schedule systems allow the user to only see his "own" substitution schedule depending on the credentials he enters.

Methods inherited from class me.vertretungsplan.parser.BaseParser

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

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_PROTOCOL

public static final String PARAM_PROTOCOL

See Also:

Constant Field Values

DATE_FORMAT

public static final org.joda.time.format.DateTimeFormatter DATE_FORMAT

TIME_FORMAT

public static final org.joda.time.format.DateTimeFormatter TIME_FORMAT

Method Detail

getSubstitutionSchedule

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

Description copied from interface: SubstitutionScheduleParser

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

isPersonal

public boolean isPersonal()

Description copied from interface: SubstitutionScheduleParser

Some substitution schedule systems allow the user to only see his "own" substitution schedule depending on the credentials he enters. If this is the case - i.e. the parser can return different schedules depending on the credentials - this function should be overridden to return true.

Specified by:

isPersonal in interface SubstitutionScheduleParser

Overrides:

isPersonal in class BaseParser

Returns:

whether this parser returns personal schedules