Package com.stripe.net

Class StripeRequest

java.lang.Object

com.stripe.net.StripeRequest

public final class StripeRequest
extends Object

A request to Stripe's API.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StripeRequest(ApiResource.RequestMethod method, URL url, HttpContent content, HttpHeaders headers, Map<String,Object> params, RequestOptions options, ApiMode apiMode)

Method Summary

Modifier and Type	Method	Description
ApiMode	apiMode()	The version of the API (ApiMode.V1 or ApiMode.V2)
HttpContent	content()	The body of the request.
static StripeRequest	create(ApiResource.RequestMethod method, String url, Map<String,Object> params, RequestOptions options, ApiMode apiMode)	Initializes a new instance of the StripeRequest class.
static StripeRequest	createWithStringContent(ApiResource.RequestMethod method, String url, String content, RequestOptions options, ApiMode apiMode)	Initializes a new instance of the StripeRequest class.
boolean	equals(Object o)
int	hashCode()
HttpHeaders	headers()	The HTTP headers of the request (Authorization, Stripe-Version, Stripe-Account, Idempotency-Key...).
ApiResource.RequestMethod	method()	The HTTP method for the request (GET, POST or DELETE).
RequestOptions	options()	The special modifiers of the request.
Map<String,Object>	params()	The parameters of the request (as an unmodifiable map).
String	toString()
URL	url()	The URL for the request.
StripeRequest	withAdditionalHeader(String name, String value)	Returns a new StripeRequest instance with an additional header.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StripeRequest

protected StripeRequest(ApiResource.RequestMethod method,
 URL url,
 HttpContent content,
 HttpHeaders headers,
 Map<String,Object> params,
 RequestOptions options,
 ApiMode apiMode)

Method Details

create

public static StripeRequest create(ApiResource.RequestMethod method,
 String url,
 Map<String,Object> params,
 RequestOptions options,
 ApiMode apiMode)
                            throws StripeException

Initializes a new instance of the StripeRequest class.

Parameters:

method - the HTTP method

url - the URL of the request

params - the parameters of the request

options - the special modifiers of the request

Throws:

StripeException - if the request cannot be initialized for any reason

createWithStringContent

public static StripeRequest createWithStringContent(ApiResource.RequestMethod method,
 String url,
 String content,
 RequestOptions options,
 ApiMode apiMode)
                                             throws StripeException

Initializes a new instance of the StripeRequest class.

Parameters:

method - the HTTP method

url - the URL of the request

content - the body of the request

options - the special modifiers of the request

Throws:

StripeException - if the request cannot be initialized for any reason

withAdditionalHeader

public StripeRequest withAdditionalHeader(String name,
 String value)

Returns a new StripeRequest instance with an additional header.

Parameters:

name - the additional header's name

value - the additional header's value

Returns:

the new StripeRequest instance

method

public ApiResource.RequestMethod method()

The HTTP method for the request (GET, POST or DELETE).

url

public URL url()

The URL for the request. If this is a GET or DELETE request, the URL also includes the request parameters in its query string.

content

public HttpContent content()

The body of the request. For POST requests, this will be either a application/x-www-form-urlencoded or a multipart/form-data payload. For non-POST requests, this will be null.

headers

public HttpHeaders headers()

The HTTP headers of the request (Authorization, Stripe-Version, Stripe-Account, Idempotency-Key...).

params

public Map<String,Object> params()

The parameters of the request (as an unmodifiable map).

options

public RequestOptions options()

The special modifiers of the request.

apiMode

public ApiMode apiMode()

The version of the API (ApiMode.V1 or ApiMode.V2)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object