Package io.jmix.superset.client.impl

Class SupersetClientImpl

java.lang.Object

io.jmix.superset.client.impl.SupersetClientImpl

All Implemented Interfaces:

SupersetClient

@Service("sprset_SupersetService")
public class SupersetClientImpl
extends Object
implements SupersetClient

Field Summary

Fields

Modifier and Type	Field	Description
protected SupersetCookieManager	cookieManager
protected HttpClient	httpClient
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected final SupersetProperties	properties

Constructor Summary

Constructors

Constructor	Description
SupersetClientImpl(SupersetProperties properties, SupersetCookieManager cookieManager)

Method Summary

Modifier and Type	Method	Description
protected HttpClient	buildHttpClient()
protected com.fasterxml.jackson.databind.ObjectMapper	buildObjectMapper()
protected void	checkGuestTokenResources(List<GuestTokenBody.Resource> resources)
CsrfTokenResponse	fetchCsrfToken(String accessToken)	Performs a request to get a CSRF token /api/v1/security/csrf_token.
GuestTokenResponse	fetchGuestToken(GuestTokenBody body, String accessToken, 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.

Methods inherited from class java.lang.Object

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

Field Details

properties

protected final SupersetProperties properties

httpClient

protected HttpClient httpClient

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

cookieManager

protected SupersetCookieManager cookieManager

Constructor Details

SupersetClientImpl

public SupersetClientImpl(SupersetProperties properties,
 SupersetCookieManager cookieManager)

Method Details

login

public LoginResponse login()
                    throws IOException,
InterruptedException

Description copied from interface: SupersetClient

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.

Specified by:

login in interface SupersetClient

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

login

public LoginResponse login(LoginBody body)
                    throws IOException,
InterruptedException

Description copied from interface: SupersetClient

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

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

Specified by:

login in interface SupersetClient

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

refresh

public RefreshResponse refresh(String refreshToken)
                        throws IOException,
InterruptedException

Description copied from interface: SupersetClient

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

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

Specified by:

refresh in interface SupersetClient

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

fetchGuestToken

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

Description copied from interface: SupersetClient

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.

Specified by:

fetchGuestToken in interface SupersetClient

Parameters:

body - the body to send

accessToken - access token that can be taken from SupersetClient.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

fetchCsrfToken

public CsrfTokenResponse fetchCsrfToken(String accessToken)
                                 throws IOException,
InterruptedException

Description copied from interface: SupersetClient

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.

Specified by:

fetchCsrfToken in interface SupersetClient

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

buildHttpClient

protected HttpClient buildHttpClient()

buildObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper buildObjectMapper()

checkGuestTokenResources

protected void checkGuestTokenResources(List<GuestTokenBody.Resource> resources)