Package com.stripe

Class StripeClient.StripeClientBuilder

java.lang.Object

com.stripe.StripeClient.StripeClientBuilder

Enclosing class:

StripeClient

public static final class StripeClient.StripeClientBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
StripeClientBuilder()	Constructs a request options builder with the global parameters (API key and client ID) as default values.

Method Summary

Modifier and Type	Method	Description
StripeClient	build()	Constructs a StripeResponseGetterOptions with the specified values.
StripeClient.StripeClientBuilder	clearApiKey()
String	getApiBase()
String	getApiKey()
Authenticator	getAuthenticator()
String	getClientId()
String	getConnectBase()
Proxy	getConnectionProxy()
int	getConnectTimeout()
String	getFilesBase()
int	getMaxNetworkRetries()
String	getMeterEventsBase()
PasswordAuthentication	getProxyCredential()
int	getReadTimeout()
String	getStripeAccount()
String	getStripeContext()
StripeClient.StripeClientBuilder	setApiBase(String address)	Set the base URL for the Stripe API.
StripeClient.StripeClientBuilder	setApiKey(String apiKey)
StripeClient.StripeClientBuilder	setAuthenticator(Authenticator authenticator)
StripeClient.StripeClientBuilder	setClientId(String clientId)	Set the client id, used for OAuth with Stripe Connect.
StripeClient.StripeClientBuilder	setConnectBase(String address)	Set the base URL for the Stripe Connect API.
StripeClient.StripeClientBuilder	setConnectionProxy(Proxy connectionProxy)	Set proxy to tunnel all Stripe connections.
StripeClient.StripeClientBuilder	setConnectTimeout(int timeout)	Sets the timeout value that will be used for making new connections to the Stripe API (in milliseconds).
StripeClient.StripeClientBuilder	setFilesBase(String address)	Set the base URL for the Stripe Files API.
StripeClient.StripeClientBuilder	setMaxNetworkRetries(int maxNetworkRetries)	Sets the maximum number of times the request will be retried in the event of a failure.
StripeClient.StripeClientBuilder	setMeterEventsBase(String address)	Set the base URL for the Stripe Meter Events API.
StripeClient.StripeClientBuilder	setProxyCredential(PasswordAuthentication proxyCredential)	Provide credential for proxy authorization if required.
StripeClient.StripeClientBuilder	setReadTimeout(int timeout)	Sets the timeout value that will be used when reading data from an established connection to the Stripe API (in milliseconds).
StripeClient.StripeClientBuilder	setStripeAccount(String account)
StripeClient.StripeClientBuilder	setStripeContext(StripeContext context)
StripeClient.StripeClientBuilder	setStripeContext(String context)

Methods inherited from class java.lang.Object

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

Constructor Details

StripeClientBuilder

public StripeClientBuilder()

Constructs a request options builder with the global parameters (API key and client ID) as default values.

Method Details

getAuthenticator

public Authenticator getAuthenticator()

setAuthenticator

public StripeClient.StripeClientBuilder setAuthenticator(Authenticator authenticator)

getApiKey

public String getApiKey()

setApiKey

public StripeClient.StripeClientBuilder setApiKey(String apiKey)

clearApiKey

public StripeClient.StripeClientBuilder clearApiKey()

getClientId

public String getClientId()

setClientId

public StripeClient.StripeClientBuilder setClientId(String clientId)

Set the client id, used for OAuth with Stripe Connect.

Parameters:

clientId - client ID

getConnectTimeout

public int getConnectTimeout()

setConnectTimeout

public StripeClient.StripeClientBuilder setConnectTimeout(int timeout)

Sets the timeout value that will be used for making new connections to the Stripe API (in milliseconds).

Parameters:

timeout - timeout value in milliseconds

getReadTimeout

public int getReadTimeout()

setReadTimeout

public StripeClient.StripeClientBuilder setReadTimeout(int timeout)

Sets the timeout value that will be used when reading data from an established connection to the Stripe API (in milliseconds).

Note that this value should be set conservatively because some API requests can take time and a short timeout increases the likelihood of causing a problem in the backend.

Parameters:

timeout - timeout value in milliseconds

getMaxNetworkRetries

public int getMaxNetworkRetries()

setMaxNetworkRetries

public StripeClient.StripeClientBuilder setMaxNetworkRetries(int maxNetworkRetries)

Sets the maximum number of times the request will be retried in the event of a failure.

Parameters:

maxNetworkRetries - the number of times to retry the request

getConnectionProxy

public Proxy getConnectionProxy()

setConnectionProxy

public StripeClient.StripeClientBuilder setConnectionProxy(Proxy connectionProxy)

Set proxy to tunnel all Stripe connections.

Parameters:

connectionProxy - proxy host and port setting

getProxyCredential

public PasswordAuthentication getProxyCredential()

setProxyCredential

public StripeClient.StripeClientBuilder setProxyCredential(PasswordAuthentication proxyCredential)

Provide credential for proxy authorization if required.

Parameters:

proxyCredential - proxy required userName and password

setApiBase

public StripeClient.StripeClientBuilder setApiBase(String address)

Set the base URL for the Stripe API. By default this is "https://api.stripe.com".

This only affects requests made with a BaseAddress of API. Use setFilesBase(java.lang.String) or setConnectBase(java.lang.String) to interpect requests with other bases.

getApiBase

public String getApiBase()

setFilesBase

public StripeClient.StripeClientBuilder setFilesBase(String address)

Set the base URL for the Stripe Files API. By default this is "https://files.stripe.com".

This only affects requests made with a BaseAddress of FILES.

getFilesBase

public String getFilesBase()

setConnectBase

public StripeClient.StripeClientBuilder setConnectBase(String address)

Set the base URL for the Stripe Connect API. By default this is "https://connect.stripe.com".

This only affects requests made with a BaseAddress of CONNECT.

getConnectBase

public String getConnectBase()

setMeterEventsBase

public StripeClient.StripeClientBuilder setMeterEventsBase(String address)

Set the base URL for the Stripe Meter Events API. By default this is "https://events.stripe.com".

This only affects requests made with a BaseAddress of EVENTMES.

getMeterEventsBase

public String getMeterEventsBase()

setStripeAccount

public StripeClient.StripeClientBuilder setStripeAccount(String account)

getStripeAccount

public String getStripeAccount()

setStripeContext

public StripeClient.StripeClientBuilder setStripeContext(String context)

setStripeContext

public StripeClient.StripeClientBuilder setStripeContext(StripeContext context)

getStripeContext

public String getStripeContext()

build

public StripeClient build()

Constructs a StripeResponseGetterOptions with the specified values.