de.femtopedia.studip

Class StudIPAPI

java.lang.Object

de.femtopedia.studip.StudIPAPI

public class StudIPAPI
extends Object

A simple-to-use API class to access the Stud.IP RestAPI.

Constructor Summary

Constructors

Constructor and Description
StudIPAPI() Initializes a new StudIPAPI instance.
StudIPAPI(InputStream keyStore, String password) Initializes a new StudIPAPI instance.
StudIPAPI(List<org.apache.http.cookie.Cookie> cookies, InputStream keyStore, String password) Initializes a new StudIPAPI instance with cookies.

Method Summary

Modifier and Type	Method and Description
void	authenticate(String username, String password) Authenticates against the Shibboleth SSO.
de.femtopedia.studip.shib.ShibHttpResponse	get(String url) Performs a HTTP GET Request.
Contacts	getContacts(String userID) Returns data about the searched user's contacts.
Course	getCourse(String courseID) Returns data about the searched course.
Courses	getCourses(String userID) Returns data about the searched user's courses.
User	getCurrentUserData() Returns the currently logged in user's data.
<T> T	getData(String api_url, Class<T> obj_class) Performs a HTTP GET Request and converts the site's content into the given Object type using Gson.
Events	getEvents(String userID) Returns data about the searched user's events.
Schedule	getSchedule() Returns data about the currently logged in user's schedule.
Schedule	getSchedule(String userID) Returns data about the currently logged in user's schedule.
Schedule	getSchedule(String userID, String semesterID) Returns data about the currently logged in user's schedule.
Semester	getSemester(String semesterID) Returns data about the searched semester.
Semesters	getSemesters() Returns data about all semesters.
de.femtopedia.studip.shib.ShibbolethClient	getShibbolethClient() Returns the currently used ShibbolethClient instance.
User	getUserData(String userID) Returns data about the searched user.
void	shutdown() Shuts down the ShibbolethClient.

Methods inherited from class java.lang.Object

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

Constructor Detail

StudIPAPI

public StudIPAPI()

Initializes a new StudIPAPI instance.

StudIPAPI

public StudIPAPI(InputStream keyStore,
                 String password)

Initializes a new StudIPAPI instance.

Parameters:

keyStore - A custom KeyStore as InputStream to set or null

password - The KeyStore's password

StudIPAPI

public StudIPAPI(List<org.apache.http.cookie.Cookie> cookies,
                 InputStream keyStore,
                 String password)

Initializes a new StudIPAPI instance with cookies.

Parameters:

cookies - the cookies to load into the Cookie Store

keyStore - A custom KeyStore as InputStream to set or null

password - The KeyStore's password

Method Detail

authenticate

public void authenticate(String username,
                         String password)
                  throws IOException,
                         IllegalArgumentException,
                         IllegalAccessException,
                         IllegalStateException

Authenticates against the Shibboleth SSO.

Parameters:

username - The username to login

password - The password to login

Throws:

IOException - if reading errors occur

IllegalArgumentException - if the header values are broken

IllegalAccessException - if the user credentials are not correct

IllegalStateException - if cookies don't match the server

getShibbolethClient

public de.femtopedia.studip.shib.ShibbolethClient getShibbolethClient()

Returns the currently used ShibbolethClient instance.

Returns:

the currently used ShibbolethClient instance

get

public de.femtopedia.studip.shib.ShibHttpResponse get(String url)
                                               throws IOException,
                                                      IllegalArgumentException,
                                                      IllegalAccessException

Performs a HTTP GET Request.

Parameters:

url - The URL to get

Returns:

A ShibHttpResponse representing the result

Throws:

IOException - if reading errors occur

IllegalArgumentException - if the header values are broken

IllegalAccessException - if the session isn't valid

getData

public <T> T getData(String api_url,
                     Class<T> obj_class)
              throws IOException,
                     IllegalArgumentException,
                     IllegalAccessException

Performs a HTTP GET Request and converts the site's content into the given Object type using Gson.

Type Parameters:

T - The wanted Generic type

Parameters:

api_url - The URL to get

obj_class - The class to cast to

Returns:

the parsed and converted object

Throws:

IOException - if reading errors occur

IllegalArgumentException - if the header values are broken

IllegalAccessException - if the session isn't valid

getCurrentUserData

public User getCurrentUserData()
                        throws IOException,
                               IllegalArgumentException,
                               IllegalAccessException

Returns the currently logged in user's data.

Returns:

the parsed and converted User object

Throws:

IOException - if reading errors occur

IllegalArgumentException - if the header values are broken

IllegalAccessException - if the session isn't valid

getUserData

public User getUserData(String userID)
                 throws IOException,
                        IllegalArgumentException,
                        IllegalAccessException

Returns data about the searched user.

Parameters:

userID - The user to search for

Returns:

the parsed and converted User object

Throws:

IOException - if reading errors occur

IllegalArgumentException - if the header values are broken

IllegalAccessException - if the session isn't valid

getContacts

public Contacts getContacts(String userID)
                     throws IOException,
                            IllegalArgumentException,
                            IllegalAccessException

Returns data about the searched user's contacts.

Parameters:

userID - The user to search for

Returns:

the parsed and converted Contacts object

Throws:

IOException - if reading errors occur

IllegalArgumentException - if the header values are broken

IllegalAccessException - if the session isn't valid

getEvents

public Events getEvents(String userID)
                 throws IOException,
                        IllegalArgumentException,
                        IllegalAccessException

Returns data about the searched user's events.

Parameters:

userID - The user to search for

Returns:

the parsed and converted Events object

Throws:

IOException - if reading errors occur

IllegalArgumentException - if the header values are broken

IllegalAccessException - if the session isn't valid

getCourse

public Course getCourse(String courseID)
                 throws IOException,
                        IllegalArgumentException,
                        IllegalAccessException

Returns data about the searched course.

Parameters:

courseID - The course to search for

Returns:

the parsed and converted Course object

Throws:

IOException - if reading errors occur

IllegalArgumentException - if the header values are broken

IllegalAccessException - if the session isn't valid

getCourses

public Courses getCourses(String userID)
                   throws IOException,
                          IllegalArgumentException,
                          IllegalAccessException

Returns data about the searched user's courses.

Parameters:

userID - The user to search for

Returns:

the parsed and converted Courses object

Throws:

IOException - if reading errors occur

IllegalArgumentException - if the header values are broken

IllegalAccessException - if the session isn't valid

getSemesters

public Semesters getSemesters()
                       throws IOException,
                              IllegalArgumentException,
                              IllegalAccessException

Returns data about all semesters.

Returns:

the parsed and converted Semesters object

Throws:

IOException - if reading errors occur

IllegalArgumentException - if the header values are broken

IllegalAccessException - if the session isn't valid

getSemester

public Semester getSemester(String semesterID)
                     throws IOException,
                            IllegalArgumentException,
                            IllegalAccessException

Returns data about the searched semester.

Parameters:

semesterID - The semester to search for

Returns:

the parsed and converted Semester object

Throws:

IOException - if reading errors occur

IllegalArgumentException - if the header values are broken

IllegalAccessException - if the session isn't valid

getSchedule

public Schedule getSchedule()
                     throws IOException,
                            IllegalArgumentException,
                            IllegalAccessException

Returns data about the currently logged in user's schedule. THIS METHOD WILL GET REMOVED, WHEN THE RESTAPI SCHEDULE IS FIXED. THIS IS A TEMPORARY METHOD, THAT HARDCODED PARSES THE HTML TEXT. IT'S VERY UNSAFE AND CAN BREAK EASILY!!!

Returns:

the parsed and converted Schedule object

Throws:

IOException - if reading errors occur

IllegalArgumentException - if the header values are broken

IllegalAccessException - if the session isn't valid

getSchedule

public Schedule getSchedule(String userID)
                     throws IOException,
                            IllegalArgumentException,
                            IllegalAccessException

Returns data about the currently logged in user's schedule. NOT FUNCTIONAL RIGHT NOW, BECAUSE OF PROBLEMS WITH THE RESTAPI. USE getSchedule() INSTEAD UNTIL THE PROBLEM IS FIXED!

Parameters:

userID - The user to search for

Returns:

the parsed and converted Schedule object

Throws:

IOException - if reading errors occur

IllegalArgumentException - if the header values are broken

IllegalAccessException - if the session isn't valid

getSchedule

public Schedule getSchedule(String userID,
                            String semesterID)
                     throws IOException,
                            IllegalArgumentException,
                            IllegalAccessException

Returns data about the currently logged in user's schedule. NOT FUNCTIONAL RIGHT NOW, BECAUSE OF PROBLEMS WITH THE RESTAPI. USE getSchedule() INSTEAD UNTIL THE PROBLEM IS FIXED!

Parameters:

userID - The user to search for

semesterID - The semester to search for

Returns:

the parsed and converted Schedule object

Throws:

IOException - if reading errors occur

IllegalArgumentException - if the header values are broken

IllegalAccessException - if the session isn't valid

shutdown

public void shutdown()

Shuts down the ShibbolethClient.