Package io.jmix.superset.client

Interface SupersetClient

All Known Implementing Classes:

SupersetClientImpl

@NullMarked
public interface SupersetClient

Service for communicating with Superset API.

See Apache Superset API

Method Summary

Modifier and Type	Method	Description
CsrfTokenResponse	fetchCsrfToken(String accessToken)	Performs a request to get a CSRF token /api/v1/security/csrf_token.
GuestTokenResponse	fetchGuestToken(GuestTokenBody body, String accessToken, @Nullable String csrfToken)	Performs a guest token request /api/v1/security/guest_token.
LoginResponse	login()	Performs POST login request /api/v1/security/login with default body configuration.
LoginResponse	login(LoginBody body)	Performs POST login request /api/v1/security/login.
RefreshResponse	refresh(String refreshToken)	Performs refresh access token request /api/v1/security/refresh.

Method Details

login

LoginResponse login()
             throws IOException,
InterruptedException

Performs POST login request /api/v1/security/login with default body configuration. The request blocks current thread.

Note, that failed request will return response with message property.

Returns:

response with JWT access token and refresh token

Throws:

IOException - if an I/ O error occurs when sending or receiving

InterruptedException - if the operation is interrupted

IllegalStateException - if it cannot write or read JSON value

login

LoginResponse login(LoginBody body)
             throws IOException,
InterruptedException

Performs POST login request /api/v1/security/login. The request blocks current thread.

Note, that failed request will return response with message property.

Parameters:

body - request body

Returns:

response with JWT access token and refresh token

Throws:

IOException - if an I/ O error occurs when sending or receiving

InterruptedException - if the operation is interrupted

IllegalStateException - if it cannot write or read JSON value

refresh

RefreshResponse refresh(String refreshToken)
                 throws IOException,
InterruptedException

Performs refresh access token request /api/v1/security/refresh. The request blocks current thread.

Note, that failed request will return response with systemMessage property.

Parameters:

refreshToken - refresh token to send

Returns:

response with new JWT access token

Throws:

IOException - if an I/ O error occurs when sending or receiving

InterruptedException - if the operation is interrupted

IllegalStateException - if it cannot write or read JSON value

fetchGuestToken

GuestTokenResponse fetchGuestToken(GuestTokenBody body,
 String accessToken,
 @Nullable String csrfToken)
                            throws IOException,
InterruptedException

Performs a guest token request /api/v1/security/guest_token. The request blocks current thread. The guest token can be used to embed a dashboard.

Note, that failed request will return response with message or systemMessage property.

Parameters:

body - the body to send

accessToken - access token that can be taken from login(LoginBody)

csrfToken - CSRF token should be passed if SupersetProperties.isCsrfProtectionEnabled() is enabled

Returns:

response with guest token

Throws:

IOException - if an I/ O error occurs when sending or receiving

InterruptedException - if the operation is interrupted

IllegalStateException - if it cannot write or read JSON value

fetchCsrfToken

CsrfTokenResponse fetchCsrfToken(String accessToken)
                          throws IOException,
InterruptedException

Performs a request to get a CSRF token /api/v1/security/csrf_token. The request blocks current thread. CSRF token is required when Superset configures CSRF protection.

When SupersetProperties.isCsrfProtectionEnabled() is enabled a Spring scheduler gets CSRF token on Spring refresh context. See SupersetTokenScheduleConfigurer and SupersetTokenManager.

Parameters:

accessToken - access token to send

Returns:

response with CSRF token

Throws:

IOException - if an I/ O error occurs when sending or receiving

InterruptedException - if the operation is interrupted

IllegalStateException - if it cannot read JSON value