me.vertretungsplan.parser

Class LoginHandler

java.lang.Object

me.vertretungsplan.parser.LoginHandler

public class LoginHandler
extends java.lang.Object

Utility class used by most parsers to access schedules protected by a login page. This can be used with both UserPasswordAuthenticationData and PasswordAuthenticationData.

LoginHandler supports authentication using HTTP POST (using application/x-www-form-urlencoded), HTTP Basic Auth, NTLM or a fixed (username and) password.

Configuration parameters

These parameters can be supplied in a JSON Object under login in SubstitutionScheduleData.setData(JSONObject) to configure the login:

type (String, required)

The type of login. Can be one of "post", "basic, "ntlm" or "fixed"

Parameters for HTTP POST ("post")

url (String, required)

The URL that the HTTP POST data is sent to.

data (JSON Object, required)

The actual form data (in a "key": "value" fashion) sent in the HTTP POST. The value can be set to "_login" (only for UserPasswordAuthenticationData) or "_password" to insert the username and password, respectively. If you specify preUrl and add "_hiddeninputs": "" here, the contents of all <input type="hidden"> fields on the page at preUrl are inserted into the HTTP POST data.

preUrl (String, optional)

A URL that is opened before the login (such as the login form itself). This is only required if this sets a Cookie that you need or if you need to send contents of hidden input fields located on this page.

checkUrl (String, optional)

A URL that is opened after the login to check if it was successful.

checkText (String, optional)

If this String is included in the HTML under checkUrl, the credential is considered invalid. If checkUrl is not specified, the response from the login request is used (only for POST).

encoding (String, optional, default: UTF-8)

Specify the encoding which is used for the URL Encoded POST parameters

form-data (Boolean, optional, Default: false)

Whether to use multipart/form-data instead of application/x-www-form-urlencoded.

Parameters for HTTP Basic Auth ("basic") and NTLM ("ntlm")

url (String, optional)

A URL that is opened after the login to check if it was successful. If the server responds with a status code that is not 200, the credential is considered invalid.

Parameters for fixed login ("fixed")

login (String, required, only for UserPasswordAuthenticationData)

The fixed username checked against the supplied one.

password (String, required)

The fixed password checked against the supplied one.

Method Summary

Methods inherited from class java.lang.Object

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