Package com.stripe.net

Class RequestOptions.RequestOptionsBuilder

java.lang.Object

com.stripe.net.RequestOptions.RequestOptionsBuilder

Direct Known Subclasses:

RawRequestOptions.RawRequestOptionsBuilder

Enclosing class:

RequestOptions

public static class RequestOptions.RequestOptionsBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected Authenticator	authenticator
protected String	baseUrl
protected String	clientId
protected Proxy	connectionProxy
protected Integer	connectTimeout
protected String	idempotencyKey
protected Integer	maxNetworkRetries
protected PasswordAuthentication	proxyCredential
protected Integer	readTimeout
protected String	stripeAccount
protected String	stripeContext
protected String	stripeRequestTrigger
protected String	stripeVersionOverride

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
RequestOptions	build()	Constructs a RequestOptions with the specified values.
RequestOptions.RequestOptionsBuilder	clearApiKey()
RequestOptions.RequestOptionsBuilder	clearClientId()
RequestOptions.RequestOptionsBuilder	clearIdempotencyKey()
RequestOptions.RequestOptionsBuilder	clearStripeAccount()
RequestOptions.RequestOptionsBuilder	clearStripeContext()	Empties the current builder value for StripeContext, which will defer to the client options.
Authenticator	getAuthenticator()
String	getClientId()
Proxy	getConnectionProxy()
Integer	getConnectTimeout()
String	getIdempotencyKey()
Integer	getMaxNetworkRetries()
PasswordAuthentication	getProxyCredential()
Integer	getReadTimeout()
String	getStripeAccount()
String	getStripeContext()
String	getStripeRequestTrigger()
RequestOptions.RequestOptionsBuilder	setApiKey(String apiKey)	Sets the API key for bearer token authentication.
RequestOptions.RequestOptionsBuilder	setAuthenticator(Authenticator authenticator)	Sets the authenticator used to authorize requests.
RequestOptions.RequestOptionsBuilder	setBaseUrl(String baseUrl)
RequestOptions.RequestOptionsBuilder	setClientId(String clientId)
RequestOptions.RequestOptionsBuilder	setConnectionProxy(Proxy connectionProxy)
RequestOptions.RequestOptionsBuilder	setConnectTimeout(Integer timeout)	Sets the timeout value that will be used for making new connections to the Stripe API (in milliseconds).
RequestOptions.RequestOptionsBuilder	setIdempotencyKey(String idempotencyKey)
RequestOptions.RequestOptionsBuilder	setMaxNetworkRetries(Integer maxNetworkRetries)	Sets the maximum number of times the request will be retried in the event of a failure.
RequestOptions.RequestOptionsBuilder	setProxyCredential(PasswordAuthentication proxyCredential)
RequestOptions.RequestOptionsBuilder	setReadTimeout(Integer timeout)	Sets the timeout value that will be used when reading data from an established connection to the Stripe API (in milliseconds).
RequestOptions.RequestOptionsBuilder	setStripeAccount(String stripeAccount)
RequestOptions.RequestOptionsBuilder	setStripeContext(StripeContext context)
RequestOptions.RequestOptionsBuilder	setStripeContext(String context)
RequestOptions.RequestOptionsBuilder	setStripeRequestTrigger(String stripeRequestTrigger)
static RequestOptions.RequestOptionsBuilder	unsafeSetStripeVersionOverride(RequestOptions.RequestOptionsBuilder builder, String stripeVersionOverride)	This is for internal use only.

Methods inherited from class java.lang.Object

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

Field Details

authenticator

protected Authenticator authenticator

clientId

protected String clientId

idempotencyKey

protected String idempotencyKey

stripeContext

protected String stripeContext

stripeRequestTrigger

protected String stripeRequestTrigger

stripeAccount

protected String stripeAccount

stripeVersionOverride

protected String stripeVersionOverride

connectTimeout

protected Integer connectTimeout

readTimeout

protected Integer readTimeout

maxNetworkRetries

protected Integer maxNetworkRetries

connectionProxy

protected Proxy connectionProxy

proxyCredential

protected PasswordAuthentication proxyCredential

baseUrl

protected String baseUrl

Constructor Details

RequestOptionsBuilder

public RequestOptionsBuilder()

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 RequestOptions.RequestOptionsBuilder setAuthenticator(Authenticator authenticator)

Sets the authenticator used to authorize requests. Use this for custom authentication strategies. For standard API key authentication, prefer setApiKey(String).

This shares a backing field with setApiKey(String) — calling one overwrites the other.

Parameters:

authenticator - the authenticator to use

setApiKey

public RequestOptions.RequestOptionsBuilder setApiKey(String apiKey)

Sets the API key for bearer token authentication. This is a convenience method equivalent to calling setAuthenticator(new BearerTokenAuthenticator(apiKey)).

This shares a backing field with setAuthenticator(Authenticator) — calling one overwrites the other.

Parameters:

apiKey - the API key; if null, clears the authenticator

clearApiKey

public RequestOptions.RequestOptionsBuilder clearApiKey()

getClientId

public String getClientId()

setClientId

public RequestOptions.RequestOptionsBuilder setClientId(String clientId)

clearClientId

public RequestOptions.RequestOptionsBuilder clearClientId()

getStripeContext

public String getStripeContext()

setStripeContext

public RequestOptions.RequestOptionsBuilder setStripeContext(String context)

setStripeContext

public RequestOptions.RequestOptionsBuilder setStripeContext(StripeContext context)

clearStripeContext

public RequestOptions.RequestOptionsBuilder clearStripeContext()

Empties the current builder value for StripeContext, which will defer to the client options.

To send no context at all, call `setContext(new StripeContext())`or set the context to an empty string.

getStripeRequestTrigger

public String getStripeRequestTrigger()

setStripeRequestTrigger

public RequestOptions.RequestOptionsBuilder setStripeRequestTrigger(String stripeRequestTrigger)

setIdempotencyKey

public RequestOptions.RequestOptionsBuilder setIdempotencyKey(String idempotencyKey)

getConnectTimeout

public Integer getConnectTimeout()

setConnectTimeout

public RequestOptions.RequestOptionsBuilder setConnectTimeout(Integer 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 Integer getReadTimeout()

setReadTimeout

public RequestOptions.RequestOptionsBuilder setReadTimeout(Integer 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 Integer getMaxNetworkRetries()

setMaxNetworkRetries

public RequestOptions.RequestOptionsBuilder setMaxNetworkRetries(Integer 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 RequestOptions.RequestOptionsBuilder setConnectionProxy(Proxy connectionProxy)

getProxyCredential

public PasswordAuthentication getProxyCredential()

setProxyCredential

public RequestOptions.RequestOptionsBuilder setProxyCredential(PasswordAuthentication proxyCredential)

clearIdempotencyKey

public RequestOptions.RequestOptionsBuilder clearIdempotencyKey()

getIdempotencyKey

public String getIdempotencyKey()

getStripeAccount

public String getStripeAccount()

setStripeAccount

public RequestOptions.RequestOptionsBuilder setStripeAccount(String stripeAccount)

clearStripeAccount

public RequestOptions.RequestOptionsBuilder clearStripeAccount()

unsafeSetStripeVersionOverride

public static RequestOptions.RequestOptionsBuilder unsafeSetStripeVersionOverride(RequestOptions.RequestOptionsBuilder builder,
 String stripeVersionOverride)

This is for internal use only. See EphemeralKey.create(Map, RequestOptions). Setting this yourself will result in a version mismatch between your request and this library's types, which can result in missing data and deserialization errors.

Static, so that it doesn't appear in IDE auto-completion alongside the other setters.

Returns:

option builder

setBaseUrl

public RequestOptions.RequestOptionsBuilder setBaseUrl(String baseUrl)

build

public RequestOptions build()

Constructs a RequestOptions with the specified values.