io.getlime.security.powerauth.lib.tpp.engine.client

Class TppEngineClient

java.lang.Object

io.getlime.security.powerauth.lib.tpp.engine.client.TppEngineClient

public class TppEngineClient
extends Object

TPP Engine Client provides methods for communication with the TPP registry and consent engine. It uses the RestTemplate class to handle REST API calls. Apache HTTP client is used instead of default client so that error responses contain full response bodies.

Author:

Petr Dvorak, petr@wultra.com

Constructor Summary

Constructors

Constructor and Description
TppEngineClient(String serviceUrl) Create a new client with provided base URL.
TppEngineClient(String serviceUrl, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Create a new client with provided base URL and custom object mapper.

Method Summary

Modifier and Type	Method and Description
io.getlime.core.rest.model.base.response.ObjectResponse<ConsentDetailResponse>	consentDetail(String id) Lookup consent details (details of a consent template).
io.getlime.core.rest.model.base.response.ObjectResponse<UserConsentDetailResponse>	consentStatus(String userId, String consentId, String clientId) Lookup consent status for given user and app.
io.getlime.core.rest.model.base.response.ObjectResponse<TppAppDetailResponse>	fetchAppInfo(String clientId) Lookup information about a provided app.
org.springframework.web.client.RestTemplate	getRestTemplate() Get default instance of REST client.
io.getlime.core.rest.model.base.response.ObjectResponse<GiveConsentResponse>	giveConsent(GiveConsentRequest request) Give consent according to request parameters.
io.getlime.core.rest.model.base.response.Response	rejectConsent(RemoveConsentRequest request) Reject consent according to request parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

TppEngineClient

public TppEngineClient(String serviceUrl)

Create a new client with provided base URL.

Parameters:

serviceUrl - Base URL.

TppEngineClient

public TppEngineClient(String serviceUrl,
                       com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Create a new client with provided base URL and custom object mapper.

Parameters:

serviceUrl - Base URL.

objectMapper - Object mapper.

Method Detail

getRestTemplate

public org.springframework.web.client.RestTemplate getRestTemplate()

Get default instance of REST client.

Returns:

RestTemplate with default configuration.

consentDetail

public io.getlime.core.rest.model.base.response.ObjectResponse<ConsentDetailResponse> consentDetail(String id)
                                                                                             throws TppEngineClientException

Lookup consent details (details of a consent template).

Parameters:

id - Username for user account which is being looked up.

Returns:

Response with user details.

Throws:

TppEngineClientException - Thrown when client request fails or user does not exist.

consentStatus

public io.getlime.core.rest.model.base.response.ObjectResponse<UserConsentDetailResponse> consentStatus(String userId,
                                                                                                        String consentId,
                                                                                                        String clientId)
                                                                                                 throws TppEngineClientException

Lookup consent status for given user and app.

Parameters:

userId - Username for user account which is being looked up.

consentId - Identifier of a consent.

clientId - Identifier of a TPP app.

Returns:

Response with details of consent for given user and TPP app.

Throws:

TppEngineClientException - Thrown when client request fails or user does not exist.

giveConsent

public io.getlime.core.rest.model.base.response.ObjectResponse<GiveConsentResponse> giveConsent(GiveConsentRequest request)
                                                                                         throws TppEngineClientException

Give consent according to request parameters.

Parameters:

request - Consent information.

Returns:

Information about newly created consent.

Throws:

TppEngineClientException - Thrown when client request fails or authentication fails.

rejectConsent

public io.getlime.core.rest.model.base.response.Response rejectConsent(RemoveConsentRequest request)
                                                                throws TppEngineClientException

Reject consent according to request parameters.

Parameters:

request - Consent information.

Returns:

Static OK response. In case consent didn't exist, this operation is no-op.

Throws:

TppEngineClientException - Thrown when client request fails or authentication fails.

fetchAppInfo

public io.getlime.core.rest.model.base.response.ObjectResponse<TppAppDetailResponse> fetchAppInfo(String clientId)
                                                                                           throws TppEngineClientException

Lookup information about a provided app.

Parameters:

clientId - Identifier of a TPP app.

Returns:

Response with details TPP app with given client ID.

Throws:

TppEngineClientException - Thrown when client request fails or app does not exist.