ru.redcom.lib.integration.api.client.dadata

Class DaDataClientFactory

java.lang.Object

ru.redcom.lib.integration.api.client.dadata.DaDataClientFactory

public class DaDataClientFactory
extends java.lang.Object

Factory class for obtaining DaData client instances. Only one implementation available currently, so no any configuration options for now.

Constructor Summary

Constructors

Constructor and Description
DaDataClientFactory()

Method Summary

Modifier and Type	Method and Description
DaDataClient	getInstance(java.lang.String apiKey, java.lang.String secretKey) Terse factory method with only credentials required.
DaDataClient	getInstance(java.lang.String apiKey, java.lang.String secretKey, java.lang.String baseUri) More verbose method allowing to customize base service URI.
DaDataClient	getInstance(java.lang.String apiKey, java.lang.String secretKey, java.lang.String baseUri, org.springframework.boot.web.client.RestTemplateBuilder restTemplateBuilder) Most verbose method allowing to set both base URI and existing REST Template Builder instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

DaDataClientFactory

public DaDataClientFactory()

Method Detail

getInstance

public DaDataClient getInstance(@NonNull
                                java.lang.String apiKey,
                                @NonNull
                                java.lang.String secretKey)

Terse factory method with only credentials required.

Uses well-known default base service URI and new REST Template Builder instance.
Null or empty credentials results in IllegalArgumentException.

Parameters:

apiKey - API key

secretKey - Secret key

Returns:

DaData API client instance

getInstance

public DaDataClient getInstance(@NonNull
                                java.lang.String apiKey,
                                @NonNull
                                java.lang.String secretKey,
                                @Nullable
                                java.lang.String baseUri)

More verbose method allowing to customize base service URI.

Null baseUri value is treated as default.
Null or empty credentials results in IllegalArgumentException.

Parameters:

apiKey - API key

secretKey - Secret key

baseUri - Base URI string

Returns:

DaData API client instance

getInstance

public DaDataClient getInstance(@NonNull
                                java.lang.String apiKey,
                                @NonNull
                                java.lang.String secretKey,
                                @Nullable
                                java.lang.String baseUri,
                                @NonNull
                                org.springframework.boot.web.client.RestTemplateBuilder restTemplateBuilder)

Most verbose method allowing to set both base URI and existing REST Template Builder instance. May be useful in Spring Boot environment to reuse a preconfigured REST Template Builder bean.

Null baseUri value is treated as default.
Null or empty credentials, as well as null restTemplateBuilder results in IllegalArgumentException.

Parameters:

apiKey - API key

secretKey - Secret key

baseUri - Base URI string

restTemplateBuilder - REST Template Builder instance to use

Returns:

DaData API client instance