me.vertretungsplan.parser

Class IphisParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.IphisParser

All Implemented Interfaces:

SubstitutionScheduleParser

public class IphisParser
extends BaseParser

Parser for substitution schedules from IPHIS.

More information can be found on the official website.

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

Configuration parameters

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

url (String, required)

The URL of the IPHIS Instance.

kuerzel (String, required)

The school shortcode required for IPHIS.

jwt_key (String, required)

The key used for signing the JWT

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

Field Summary

Fields inherited from class me.vertretungsplan.parser.BaseParser

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

Constructor Summary

Constructors

Constructor and Description
IphisParser(SubstitutionScheduleData scheduleData, CookieProvider cookieProvider)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAllClasses() Get a list of all available classes.
java.util.List<java.lang.String>	getAllTeachers() Get a list of all available teachers.
org.joda.time.LocalDateTime	getLastChange() Returns the time when the substitution schedule was last changed.
SubstitutionSchedule	getSubstitutionSchedule() Downloads and parses the substitution schedule

Methods inherited from class me.vertretungsplan.parser.BaseParser

contains, getClassesFromJson, getCredential, getInstance, getWebdavClient, httpGet, httpGet, httpGet, httpPost, httpPost, httpPost, httpPost, isPersonal, recognizeType, setCredential, setDebuggingDataHandler, setLocalSource

Methods inherited from class java.lang.Object

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

Constructor Detail

IphisParser

public IphisParser(SubstitutionScheduleData scheduleData,
                   CookieProvider cookieProvider)

Method Detail

getSubstitutionSchedule

public SubstitutionSchedule getSubstitutionSchedule()
                                             throws java.io.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:

java.io.IOException - Connection or parsing error

org.json.JSONException - Error with the JSON configuration

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

getLastChange

public org.joda.time.LocalDateTime getLastChange()
                                          throws java.io.IOException,
                                                 org.json.JSONException,
                                                 CredentialInvalidException

Description copied from interface: SubstitutionScheduleParser

Returns the time when the substitution schedule was last changed. This can be used to use a previously cached schedule if nothing was changed. Should return null if this information is not available or should not be relied upon. The default implementation in BaseParser returns null.

Specified by:

getLastChange in interface SubstitutionScheduleParser

Overrides:

getLastChange in class BaseParser

Returns:

the time when the substitution schedule was last changed

Throws:

java.io.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 java.util.List<java.lang.String> getAllClasses()
                                               throws java.io.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:

java.io.IOException - Connection or parsing error

org.json.JSONException - Error with the JSON configuration

CredentialInvalidException

getAllTeachers

public java.util.List<java.lang.String> getAllTeachers()
                                                throws java.io.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:

java.io.IOException - Connection or parsing error

org.json.JSONException - Error with the JSON configuration

CredentialInvalidException