io.getlime.security.powerauth.lib.dataadapter.client

Class DataAdapterClient

java.lang.Object

io.getlime.security.powerauth.lib.dataadapter.client.DataAdapterClient

public class DataAdapterClient
extends Object

Data Adapter Client provides methods for communication with the Data Adapter. It uses the RestTemplate class to handle REST API calls. HTTP client is used instead of default client so that error responses contain full response bodies.

Author:

Roman Strobl, roman.strobl@wultra.com

Constructor Summary

Constructors

Constructor and Description
DataAdapterClient(String serviceUrl) Create a new client with provided base URL.
DataAdapterClient(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<UserAuthenticationResponse>	authenticateUser(String userId, String organizationId, String password, AuthenticationContext authenticationContext, OperationContext operationContext) Perform authentication with provided username and password.
io.getlime.core.rest.model.base.response.ObjectResponse<CreateSmsAuthorizationResponse>	createAuthorizationSms(String userId, String organizationId, OperationContext operationContext, String lang, boolean resend) Create authorization SMS message with OTP authorization code.
io.getlime.core.rest.model.base.response.ObjectResponse<CreateConsentFormResponse>	createConsentForm(String userId, String organizationId, OperationContext operationContext, String lang) Create OAuth 2.0 consent form.
io.getlime.core.rest.model.base.response.ObjectResponse<DecorateOperationFormDataResponse>	decorateOperationFormData(String userId, String organizationId, OperationContext operationContext) Decorate operation form data.
io.getlime.core.rest.model.base.response.ObjectResponse<UserDetailResponse>	fetchUserDetail(String userId, String organizationId) Obtain user details for given user ID.
io.getlime.core.rest.model.base.response.ObjectResponse	formDataChangedNotification(FormDataChange formDataChange, String userId, String organizationId, OperationContext operationContext) Send a notification about form data change.
org.springframework.web.client.RestTemplate	getRestTemplate() Get default instance of REST client.
io.getlime.core.rest.model.base.response.ObjectResponse<InitConsentFormResponse>	initConsentForm(String userId, String organizationId, OperationContext operationContext) Initialize OAuth 2.0 consent form.
io.getlime.core.rest.model.base.response.ObjectResponse<UserDetailResponse>	lookupUser(String username, String organizationId, OperationContext operationContext) Lookup user account.
io.getlime.core.rest.model.base.response.ObjectResponse	operationChangedNotification(OperationChange operationChange, String userId, String organizationId, OperationContext operationContext) Send a notification about operation change.
io.getlime.core.rest.model.base.response.ObjectResponse<SaveConsentFormResponse>	saveConsentForm(String userId, String organizationId, OperationContext operationContext, List<ConsentOption> options) Save options selected by the user in the OAuth 2.0 consent form.
io.getlime.core.rest.model.base.response.ObjectResponse<ValidateConsentFormResponse>	validateConsentForm(String userId, String organizationId, OperationContext operationContext, String lang, List<ConsentOption> options) Validate options selected by the user in the OAuth 2.0 consent form.
io.getlime.core.rest.model.base.response.ObjectResponse<VerifySmsAuthorizationResponse>	verifyAuthorizationSms(String messageId, String authorizationCode, String userId, String organizationId, OperationContext operationContext) Verify OTP authorization code for previously generated SMS message.
io.getlime.core.rest.model.base.response.ObjectResponse<VerifySmsAndPasswordResponse>	verifyAuthorizationSmsAndPassword(String messageId, String authorizationCode, String userId, String organizationId, String password, AuthenticationContext authenticationContext, OperationContext operationContext) Verify OTP authorization code for previously generated SMS message together with user password.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataAdapterClient

public DataAdapterClient(String serviceUrl)

Create a new client with provided base URL.

Parameters:

serviceUrl - Base URL.

DataAdapterClient

public DataAdapterClient(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.

lookupUser

public io.getlime.core.rest.model.base.response.ObjectResponse<UserDetailResponse> lookupUser(String username,
                                                                                              String organizationId,
                                                                                              OperationContext operationContext)
                                                                                       throws DataAdapterClientErrorException

Lookup user account.

Parameters:

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

organizationId - Organization ID for which the user ID is assigned to.

operationContext - Operation context.

Returns:

Response with user details.

Throws:

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

authenticateUser

public io.getlime.core.rest.model.base.response.ObjectResponse<UserAuthenticationResponse> authenticateUser(String userId,
                                                                                                            String organizationId,
                                                                                                            String password,
                                                                                                            AuthenticationContext authenticationContext,
                                                                                                            OperationContext operationContext)
                                                                                                     throws DataAdapterClientErrorException

Perform authentication with provided username and password.

Parameters:

userId - User ID of user who is being authenticated.

organizationId - Organization ID.

password - Password for this authentication request, optionally encrypted.

authenticationContext - Authentication context.

operationContext - Operation context.

Returns:

Authentication response is returned in case of successful authentication.

Throws:

DataAdapterClientErrorException - Thrown when client request fails or authentication fails.

fetchUserDetail

public io.getlime.core.rest.model.base.response.ObjectResponse<UserDetailResponse> fetchUserDetail(String userId,
                                                                                                   String organizationId)
                                                                                            throws DataAdapterClientErrorException

Obtain user details for given user ID.

Parameters:

userId - User ID for the user to be obtained.

organizationId - Organization ID.

Returns:

A response with user details.

Throws:

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

createAuthorizationSms

public io.getlime.core.rest.model.base.response.ObjectResponse<CreateSmsAuthorizationResponse> createAuthorizationSms(String userId,
                                                                                                                      String organizationId,
                                                                                                                      OperationContext operationContext,
                                                                                                                      String lang,
                                                                                                                      boolean resend)
                                                                                                               throws DataAdapterClientErrorException

Create authorization SMS message with OTP authorization code.

Parameters:

userId - User ID.

organizationId - Organization ID.

operationContext - Operation context.

lang - Language for i18n.

resend - Whether SMS is being resent.

Returns:

Response with generated messageId.

Throws:

DataAdapterClientErrorException - Thrown when client request fails or SMS could not be delivered.

verifyAuthorizationSms

public io.getlime.core.rest.model.base.response.ObjectResponse<VerifySmsAuthorizationResponse> verifyAuthorizationSms(String messageId,
                                                                                                                      String authorizationCode,
                                                                                                                      String userId,
                                                                                                                      String organizationId,
                                                                                                                      OperationContext operationContext)
                                                                                                               throws DataAdapterClientErrorException

Verify OTP authorization code for previously generated SMS message.

Parameters:

messageId - Message ID.

authorizationCode - User entered authorization code.

userId - User ID.

organizationId - Organization ID.

operationContext - Operation context.

Returns:

Empty response returned when action succeeds.

Throws:

DataAdapterClientErrorException - Thrown when client request fails or SMS code authorization fails.

verifyAuthorizationSmsAndPassword

public io.getlime.core.rest.model.base.response.ObjectResponse<VerifySmsAndPasswordResponse> verifyAuthorizationSmsAndPassword(String messageId,
                                                                                                                               String authorizationCode,
                                                                                                                               String userId,
                                                                                                                               String organizationId,
                                                                                                                               String password,
                                                                                                                               AuthenticationContext authenticationContext,
                                                                                                                               OperationContext operationContext)
                                                                                                                        throws DataAdapterClientErrorException

Verify OTP authorization code for previously generated SMS message together with user password.

Parameters:

messageId - Message ID.

authorizationCode - User entered authorization code.

userId - User ID for this authentication request.

organizationId - Organization ID for this authentication request.

password - Password for this authentication request, optionally encrypted.

authenticationContext - Authentication context.

operationContext - Operation context.

Returns:

Empty response returned when action succeeds.

Throws:

DataAdapterClientErrorException - Thrown when client request fails or authentication/authorization fails.

decorateOperationFormData

public io.getlime.core.rest.model.base.response.ObjectResponse<DecorateOperationFormDataResponse> decorateOperationFormData(String userId,
                                                                                                                            String organizationId,
                                                                                                                            OperationContext operationContext)
                                                                                                                     throws DataAdapterClientErrorException

Decorate operation form data.

Parameters:

userId - User ID of the user for this request.

organizationId - Organization ID for this request.

operationContext - Operation context.

Returns:

Decorated operation form data.

Throws:

DataAdapterClientErrorException - Thrown when client request fails.

formDataChangedNotification

public io.getlime.core.rest.model.base.response.ObjectResponse formDataChangedNotification(FormDataChange formDataChange,
                                                                                           String userId,
                                                                                           String organizationId,
                                                                                           OperationContext operationContext)
                                                                                    throws DataAdapterClientErrorException

Send a notification about form data change.

Parameters:

formDataChange - Operation form data change.

userId - User ID.

organizationId - Organization ID.

operationContext - Operation context.

Returns:

Object response.

Throws:

DataAdapterClientErrorException - Thrown when client request fails.

operationChangedNotification

public io.getlime.core.rest.model.base.response.ObjectResponse operationChangedNotification(OperationChange operationChange,
                                                                                            String userId,
                                                                                            String organizationId,
                                                                                            OperationContext operationContext)
                                                                                     throws DataAdapterClientErrorException

Send a notification about operation change.

Parameters:

operationChange - Operation change.

userId - User ID.

organizationId - Organization ID.

operationContext - Operation context.

Returns:

Object response.

Throws:

DataAdapterClientErrorException - Thrown when client request fails.

initConsentForm

public io.getlime.core.rest.model.base.response.ObjectResponse<InitConsentFormResponse> initConsentForm(String userId,
                                                                                                        String organizationId,
                                                                                                        OperationContext operationContext)
                                                                                                 throws DataAdapterClientErrorException

Initialize OAuth 2.0 consent form.

Parameters:

userId - User ID.

organizationId - Organization ID.

operationContext - Operation context.

Returns:

Response with information whether consent form should be displayed

Throws:

DataAdapterClientErrorException - Thrown when client request fails.

createConsentForm

public io.getlime.core.rest.model.base.response.ObjectResponse<CreateConsentFormResponse> createConsentForm(String userId,
                                                                                                            String organizationId,
                                                                                                            OperationContext operationContext,
                                                                                                            String lang)
                                                                                                     throws DataAdapterClientErrorException

Create OAuth 2.0 consent form.

Parameters:

userId - User ID.

organizationId - Organization ID.

operationContext - Operation context.

lang - Language of the text in the consent form.

Returns:

Consent form with text and options to select by the user.

Throws:

DataAdapterClientErrorException - Thrown when client request fails.

validateConsentForm

public io.getlime.core.rest.model.base.response.ObjectResponse<ValidateConsentFormResponse> validateConsentForm(String userId,
                                                                                                                String organizationId,
                                                                                                                OperationContext operationContext,
                                                                                                                String lang,
                                                                                                                List<ConsentOption> options)
                                                                                                         throws DataAdapterClientErrorException

Validate options selected by the user in the OAuth 2.0 consent form.

Parameters:

userId - User ID.

organizationId - Organization ID.

operationContext - Operation context.

lang - Language of the text in the consent form.

options - Consent options selected by the user.

Returns:

Consent form validation result.

Throws:

DataAdapterClientErrorException - Thrown when client request fails.

saveConsentForm

public io.getlime.core.rest.model.base.response.ObjectResponse<SaveConsentFormResponse> saveConsentForm(String userId,
                                                                                                        String organizationId,
                                                                                                        OperationContext operationContext,
                                                                                                        List<ConsentOption> options)
                                                                                                 throws DataAdapterClientErrorException

Save options selected by the user in the OAuth 2.0 consent form.

Parameters:

userId - User ID.

organizationId - Organization ID.

operationContext - Operation context.

options - Consent options selected by the user.

Returns:

Response with indication whether consent form was successfully saved.

Throws:

DataAdapterClientErrorException - Thrown when client request fails.