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

Authentication services provides services 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@lime-company.eu

Constructor Summary

Constructors

Constructor and Description
DataAdapterClient() Default constructor.
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<AuthenticationResponse>	authenticateUser(String username, String password, OperationContext operationContext) Perform authentication with provided username and password.
io.getlime.core.rest.model.base.response.ObjectResponse<CreateSMSAuthorizationResponse>	createAuthorizationSMS(String userId, OperationContext operationContext, String lang) Create authorization SMS message with OTP authorization code.
io.getlime.core.rest.model.base.response.ObjectResponse<DecorateOperationFormDataResponse>	decorateOperationFormData(String userId, OperationContext operationContext) Decorate operation form data.
io.getlime.core.rest.model.base.response.ObjectResponse<UserDetailResponse>	fetchUserDetail(String userId) Obtain user details for given user ID.
io.getlime.core.rest.model.base.response.ObjectResponse	formDataChangedNotification(FormDataChange formDataChange, String userId, OperationContext operationContext) Send a notification about form data change.
io.getlime.core.rest.model.base.response.ObjectResponse	operationChangedNotification(OperationChange operationChange, String userId, OperationContext operationContext) Send a notification about operation change.
io.getlime.core.rest.model.base.response.Response	verifyAuthorizationSMS(String messageId, String authorizationCode, OperationContext operationContext) Verify OTP authorization code for previously generated SMS message.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataAdapterClient

public DataAdapterClient()

Default constructor.

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

authenticateUser

public io.getlime.core.rest.model.base.response.ObjectResponse<AuthenticationResponse> authenticateUser(String username,
                                                                                                        String password,
                                                                                                        OperationContext operationContext)
                                                                                                 throws DataAdapterClientErrorException

Perform authentication with provided username and password.

Parameters:

username - username for user who is being authenticated

password - password as a string

operationContext - operation context

Returns:

a Response with either AuthenticationResponse or DataAdapterError given the result of the operation

Throws:

DataAdapterClientErrorException - Thrown when client request fails.

fetchUserDetail

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

Obtain user details for given user ID.

Parameters:

userId - User ID for the user to be obtained.

Returns:

A response with user details.

Throws:

DataAdapterClientErrorException - Thrown when client request fails.

createAuthorizationSMS

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

Create authorization SMS message with OTP authorization code.

Parameters:

userId - User ID.

operationContext - Operation context.

lang - Language for i18n.

Returns:

Response with generated messageId.

Throws:

DataAdapterClientErrorException - Thrown when client request fails.

verifyAuthorizationSMS

public io.getlime.core.rest.model.base.response.Response verifyAuthorizationSMS(String messageId,
                                                                                String authorizationCode,
                                                                                OperationContext operationContext)
                                                                         throws DataAdapterClientErrorException

Verify OTP authorization code for previously generated SMS message.

Parameters:

messageId - Message ID.

authorizationCode - User entered authorization code.

operationContext - Operation context.

Returns:

Empty response returned when action succeeds.

Throws:

DataAdapterClientErrorException - Thrown when client request fails.

decorateOperationFormData

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

Decorate operation form data.

Parameters:

userId - User ID of the user 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,
                                                                                           OperationContext operationContext)
                                                                                    throws DataAdapterClientErrorException

Send a notification about form data change.

Parameters:

formDataChange - Operation form data change.

userId - User 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,
                                                                                            OperationContext operationContext)
                                                                                     throws DataAdapterClientErrorException

Send a notification about operation change.

Parameters:

operationChange - Operation change.

userId - User ID.

operationContext - Operation context.

Returns:

Object response.

Throws:

DataAdapterClientErrorException - Thrown when client request fails.