Package de.damios.jpapi.core

Class Api

java.lang.Object

de.damios.jpapi.core.Api

public class Api
extends java.lang.Object

Diese Klasse besteht ausschließlich aus statischen Methoden, die zum Ausführen der Anfragen an die Pewn-API notwendig sind.

Since:

0.1.0

Method Summary

Modifier and Type	Method	Description
static java.lang.String	authForFirstTime(java.lang.String clientId, java.lang.String clientSecret, java.lang.String authCode, java.lang.String redirectUri)	Authentifiziert den Nutzer das erste Mal.
static <T> T	createService(java.lang.Class<T> service)	Erstellt eine Implementation der API-Endpunkte, die im übergebenen Interface definiert werden.
static <T> T	executeCall(retrofit2.Call<T> call)	Führt eine Anfrage an die Pewn-API aus und liefert die Antwort.
static java.lang.String	getClientId()
static java.lang.String	getClientSecret()
static java.lang.String	getRefreshToken()
static void	initAuth(java.lang.String clientId, java.lang.String clientSecret, java.lang.String refreshToken)	Initialisiert die API für die Authentifizierung.

Methods inherited from class java.lang.Object

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

Method Detail

initAuth

public static void initAuth(java.lang.String clientId,
                            java.lang.String clientSecret,
                            java.lang.String refreshToken)

Initialisiert die API für die Authentifizierung.

Die Einrichtung über diese Methode erlaubt auch den Zugriff auf geschützte Ressourcen.

Parameters:

clientId - Die ID der API-Anwendung.

clientSecret - Das Secret der Anwendung.

refreshToken - Der nutzer- und anwendungsspezifische Refresh-Token.

See Also:

authForFirstTime(String, String, String, String)

getClientId

public static java.lang.String getClientId()

getClientSecret

public static java.lang.String getClientSecret()

getRefreshToken

public static java.lang.String getRefreshToken()

authForFirstTime

public static java.lang.String authForFirstTime(java.lang.String clientId,
                                                java.lang.String clientSecret,
                                                java.lang.String authCode,
                                                java.lang.String redirectUri)
                                         throws java.io.IOException

Authentifiziert den Nutzer das erste Mal.

Hier wird ein temporärer Auth-Code gegen einen dauerhaften Refresh-Token ausgetauscht.

Parameters:

clientId - Die ID der API-Anwendung.

clientSecret - Das Secret der Anwendung.

authCode - Der nutzer- und anwendungsspezifische Authorization-Code.

redirectUri - Die für die Anwendung hinterlegte Weiterleitungs-URI.

Returns:

Der nutzer- und anwendungsspezifische Refresh-Token.

Throws:

java.io.IOException - wenn ein Fehler bei der Kommunikation mit Pewn auftritt.

See Also:

Token.getFirstToken(String, String, String, String)

createService

public static <T> T createService(java.lang.Class<T> service)

Erstellt eine Implementation der API-Endpunkte, die im übergebenen Interface definiert werden.

Type Parameters:

T - Der Typ des Services.

Parameters:

service - Die Klasse des Service-Interfaces.

Returns:

Der Service.

See Also:

restAdapter

executeCall

public static <T> T executeCall(retrofit2.Call<T> call)
                         throws java.io.IOException

Führt eine Anfrage an die Pewn-API aus und liefert die Antwort.

Type Parameters:

T - Der Typ der Antwort.

Parameters:

call - Die Anfrage.

Returns:

Die Antwort der Pewn-API.

Throws:

java.io.IOException - wenn ein Fehler bei der Kommunikation mit Pewn auftritt.