org.spincast.plugins.httpclient.builders

Interface EntitySenderRequestBuilderBase<T extends EntitySenderRequestBuilderBase<?>>

All Superinterfaces:

HttpRequestBuilder<T>

All Known Subinterfaces:

PatchRequestBuilder, PostRequestBuilder, PutRequestBuilder

All Known Implementing Classes:

EntitySenderRequestBuilderBaseDefault, PatchRequestBuilderDefault, PostRequestBuilderDefault, PutRequestBuilderDefault

public interface EntitySenderRequestBuilderBase<T extends EntitySenderRequestBuilderBase<?>>
extends HttpRequestBuilder<T>

Builders that can send an entity, or upload files.

Method Summary

Modifier and Type	Method and Description
T	addEntityFileUpload(String path, boolean isClasspathPath, String name) Adds a file to upload.
T	addEntityFileUpload(String path, String name) Adds a file to upload.
T	addEntityFormDataValue(String name, String value) Adds a value to a Form data.
T	setEntity(org.spincast.shaded.org.apache.http.HttpEntity entity) Sets an custom HttpEntity entity to be sent.
T	setEntityFormData(String name, List<String> values) Sets a Form data entity.
T	setEntityFormDatas(Map<String,List<String>> params) Sets the Form datas entity.
T	setEntityJson(Object object) Sets a Json entity to be sent.
T	setEntityString(String entity, String contentType) Sets a String entity.
T	setEntityXml(Object object) Sets a XML entity to be sent.

Methods inherited from interface org.spincast.plugins.httpclient.HttpRequestBuilder

addCookie, addCookie, addCookie, addCookies, addHeaderValue, addHeaderValues, addHTMLAcceptHeader, addJsonAcceptHeader, addPlainTextAcceptHeader, addXMLAcceptHeader, disableSslCertificateErrors, send, setHeaders, setHeaderValues, setHttpAuthCredentials, setHttpClientBuilder, setRequestConfig

Method Detail

setEntityFormDatas

T setEntityFormDatas(Map<String,List<String>> params)

Sets the Form datas entity. A form data can contain more than one value. Overwrites any existing Form datas. Only one type of entity can be set amongs: - Form datas entity - String entity - File upload - Custom HttpEntity When you set or add an entity of a new type, the existing entity is overwritten.

setEntityFormData

T setEntityFormData(String name,
                    List<String> values)

Sets a Form data entity. A form data can contain more than one value. Overwrites the existing Form data of the same name, but keeps the other ones. Only one type of entity can be set amongs: - Form datas entity - String entity - File upload - Custom HttpEntity When you set or add an entity of a new type, the existing entity is overwritten.

addEntityFormDataValue

T addEntityFormDataValue(String name,
                         String value)

Adds a value to a Form data. Keeps the existing values. Only one type of entity can be set amongs: - Form datas entity - String entity - File upload - Custom HttpEntity When you set or add an entity of a new type, the existing entity is overwritten.

setEntityString

T setEntityString(String entity,
                  String contentType)

Sets a String entity. Only one type of entity can be set amongs: - Form datas entity - String entity - File upload - Custom HttpEntity When you set or add an entity of a new type, the existing entity is overwritten.

setEntity

T setEntity(org.spincast.shaded.org.apache.http.HttpEntity entity)

Sets an custom HttpEntity entity to be sent. Only one type of entity can be set amongs: - Form datas entity - String entity - File upload - custom HttpEntity When you set or add an entity of a new type, the existing entity is overwritten.

setEntityJson

T setEntityJson(Object object)

Sets a Json entity to be sent. The object will be converted to a Json's String representation and sent using the application/json Content-Type. Only one type of entity can be set amongs: - Form datas entity - String entity - File upload - Custom HttpEntity When you set or add an entity of a new type, the existing entity is overwritten.

setEntityXml

T setEntityXml(Object object)

Sets a XML entity to be sent. The object will be converted to a XML and sent using the application/xml Content-Type. Only one type of entity can be set amongs: - Form datas entity - String entity - File upload - Custom HttpEntity When you set or add an entity of a new type, the existing entity is overwritten.

addEntityFileUpload

T addEntityFileUpload(String path,
                      String name)

Adds a file to upload. More than one file can be uploaded at one time. The specified file is added to the existing ones. Only one type of entity can be set amongs: - Form datas entity - String entity - File upload - Custom HttpEntity

Parameters:

path - the path to the file to upload, on the file system

name - the name to use for the uploaded file.

addEntityFileUpload

T addEntityFileUpload(String path,
                      boolean isClasspathPath,
                      String name)

Adds a file to upload. More than one file can be uploaded at one time. The specified file is added to the existing ones. Only one type of entity can be set amongs: - Form datas entity - String entity - File upload - Custom HttpEntity

Parameters:

path - the path to the file to upload

isClasspathPath - if true, the path to the file to upload is on the classpath, otherwise, it's on the file system.

name - the name to use for the uploaded file.