Package com.oorian.apis

Class UrlEncodedRequest

java.lang.Object

com.oorian.apis.ApiHttpRequest

com.oorian.apis.UrlEncodedRequest

Direct Known Subclasses:

UrlEncodedPostRequest, UrlEncodedPutRequest

public abstract class UrlEncodedRequest
extends ApiHttpRequest

Abstract base class for HTTP requests with URL-encoded form parameters.

Serializes parameters in application/x-www-form-urlencoded format. Subclasses specify the HTTP method (POST or PUT).

Field Summary

Fields inherited from class com.oorian.apis.ApiHttpRequest

DELETE, GET, POST, PUT

Constructor Summary

Constructors

Constructor	Description
UrlEncodedRequest(int method, String url)	Creates a new URL-encoded request with the specified HTTP method and URL.

Method Summary

Modifier and Type	Method	Description
void	addParameter(RequestParameter param)	Adds a form parameter to this request.
void	addParameter(String name, Object value)	Adds a form parameter with the specified name and value.
protected HttpRequest.BodyPublisher	getData()

Methods inherited from class com.oorian.apis.ApiHttpRequest

addHeader, addHeaders, getCharset, getHeaders, getResponse, getUrl, getUrlConnection, send, send, setCharset, setConnectTimeout, setContentType, setReadTimeout, setUrl

Methods inherited from class java.lang.Object

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

Constructor Details

UrlEncodedRequest

public UrlEncodedRequest(int method,
 String url)

Creates a new URL-encoded request with the specified HTTP method and URL.

Parameters:

method - the HTTP method constant.

url - the target URL.

Method Details

addParameter

public void addParameter(String name,
 Object value)

Adds a form parameter with the specified name and value.

Parameters:

name - the parameter name.

value - the parameter value.

addParameter

public void addParameter(RequestParameter param)

Adds a form parameter to this request.

Parameters:

param - the request parameter to add.

getData

protected HttpRequest.BodyPublisher getData()
                                     throws HttpRequestException

Specified by:

getData in class ApiHttpRequest

Throws:

HttpRequestException