Package ru.loolzaaa.youkassa.client
Class ApiClientBuilder
- java.lang.Object
-
- ru.loolzaaa.youkassa.client.ApiClientBuilder
-
public class ApiClientBuilder extends java.lang.Object
This class implement builder pattern forApiClient
.Compared with constructor creation of
ApiClient
, this option additionally provides some sanity checks.Usage:
ApiClient client = ApiClientBuilder.newBuilder() .configureBasicAuth("shop_id", "secret_key") .build();
- See Also:
ApiClient
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiClientBuilder
apiUrl(java.lang.String apiUrl)
Sets API url endpoint for client.ApiClient
build()
CreatedApiClient
instance.ApiClientBuilder
configureBasicAuth(java.lang.String accountId, java.lang.String secretKey)
Authentication configuration via Basic auth method.ApiClientBuilder
configureOAuth(java.lang.String authToken)
Authentication configuration via OAuth method.static ApiClientBuilder
newBuilder()
Creates new builder forApiClient
.
-
-
-
Method Detail
-
apiUrl
public ApiClientBuilder apiUrl(java.lang.String apiUrl)
Sets API url endpoint for client.- Parameters:
apiUrl
- api endpoint url- Returns:
- builder itself
-
configureBasicAuth
public ApiClientBuilder configureBasicAuth(java.lang.String accountId, java.lang.String secretKey)
Authentication configuration via Basic auth method.Only one method (Basic/OAuth) of authentication can be configured.
- Parameters:
accountId
- id of yookassa shop/accountsecretKey
- secret key of yookassa shop/account- Returns:
- builder itself
- Throws:
java.lang.IllegalArgumentException
- if OAuth token not null
-
configureOAuth
public ApiClientBuilder configureOAuth(java.lang.String authToken)
Authentication configuration via OAuth method.Only one method (Basic/OAuth) of authentication can be configured.
- Parameters:
authToken
- OAuth client token- Returns:
- builder itself
- Throws:
java.lang.IllegalArgumentException
- if accountId or secretKey not null
-
build
public ApiClient build()
CreatedApiClient
instance.Construct authentication header value supplier based on configured authentication method.
- Returns:
- instance of
ApiClient
- Throws:
java.lang.IllegalArgumentException
- if authentication not configured
-
newBuilder
public static ApiClientBuilder newBuilder()
Creates new builder forApiClient
.- Returns:
- new builder instance
-
-