org.spincast.plugins.httpclient.builders

Class EntitySenderRequestBuilderBase<T extends IEntitySenderRequestBuilderBase<?>>

java.lang.Object

org.spincast.plugins.httpclient.builders.SpincastHttpRequestBuilderBase<T>

org.spincast.plugins.httpclient.builders.EntitySenderRequestBuilderBase<T>

All Implemented Interfaces:

IEntitySenderRequestBuilderBase<T>, IHttpRequestBuilder<T>

Direct Known Subclasses:

PatchRequestBuilder, PostRequestBuilder, PutRequestBuilder

public abstract class EntitySenderRequestBuilderBase<T extends IEntitySenderRequestBuilderBase<?>>
extends SpincastHttpRequestBuilderBase<T>
implements IEntitySenderRequestBuilderBase<T>

Implementation for the builders that can send an entity, or upload files..

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EntitySenderRequestBuilderBase.EntityType

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
EntitySenderRequestBuilderBase(String url, ICookieFactory cookieFactory, IHttpResponseFactory spincastHttpResponseFactory, IJsonManager jsonManager, IXmlManager xmlManager, ISpincastHttpClientUtils spincastHttpClientUtils, ISpincastHttpClientConfig spincastHttpClientConfig) Constructor

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.
protected List<org.spincast.shaded.org.apache.http.NameValuePair>	convertToNameValuePair(Map<String,List<String>> params)
protected org.spincast.shaded.org.apache.http.client.methods.HttpRequestBase	createMethodSpecificHttpRequest(String url) Creates the HttpRequestBase depending on the HTTP method.
protected org.spincast.shaded.org.apache.http.HttpEntity	getEntity()
protected List<FileToUpload>	getEntityFileUploads()
protected Map<String,List<String>>	getEntityFormDatas()
protected String	getEntityFormDatasEncoding()
protected String	getEntityStringEncoding()
protected EntitySenderRequestBuilderBase.EntityType	getEntityType()
protected abstract org.spincast.shaded.org.apache.http.client.methods.HttpEntityEnclosingRequestBase	getHttpEntityEnclosingRequestBase(String url)
protected IJsonManager	getJsonManager()
protected IXmlManager	getXmlManager()
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>> formDatas) Sets the Form datas entity.
T	setEntityJson(Object object) Sets a Json entity to be sent.
T	setEntityString(String entityString, String contentType) Sets a String entity.
T	setEntityXml(Object object) Sets a XML entity to be sent.

Methods inherited from class org.spincast.plugins.httpclient.builders.SpincastHttpRequestBuilderBase

addCookie, addCookie, addCookies, addHeaderValue, addHeaderValues, addHTMLAcceptHeader, addJsonAcceptHeader, addPlainTextAcceptHeader, addXMLAcceptHeader, convertToApacheCookie, createHttpClient, createHttpClientBuilder, disableSslCertificateErrors, getCookieEncoding, getCookieFactory, getCookieStore, getHeaders, getHttpAuthPassword, getHttpAuthUsername, getHttpClient, getHttpClientBuilder, getHttpRequestExecutor, getRequestConfig, getSpincastHttpClientConfig, getSpincastHttpClientUtils, getSpincastHttpResponseFactory, getUrl, isDisableSslCertificateErrors, send, sendGetRawResponse, setCookieStore, setHeaders, setHeaderValues, setHttpAuthCredentials, setHttpClientBuilder, setRequestConfig

Methods inherited from class java.lang.Object

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

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

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

EntitySenderRequestBuilderBase

public EntitySenderRequestBuilderBase(String url,
                                      ICookieFactory cookieFactory,
                                      IHttpResponseFactory spincastHttpResponseFactory,
                                      IJsonManager jsonManager,
                                      IXmlManager xmlManager,
                                      ISpincastHttpClientUtils spincastHttpClientUtils,
                                      ISpincastHttpClientConfig spincastHttpClientConfig)

Constructor

Method Detail

getEntityStringEncoding

protected String getEntityStringEncoding()

getEntityFormDatasEncoding

protected String getEntityFormDatasEncoding()

getEntityType

protected EntitySenderRequestBuilderBase.EntityType getEntityType()

getEntity

protected org.spincast.shaded.org.apache.http.HttpEntity getEntity()

getJsonManager

protected IJsonManager getJsonManager()

getXmlManager

protected IXmlManager getXmlManager()

getEntityFormDatas

protected Map<String,List<String>> getEntityFormDatas()

getEntityFileUploads

protected List<FileToUpload> getEntityFileUploads()

addEntityFormDataValue

public T addEntityFormDataValue(String name,
                                String value)

Description copied from interface: IEntitySenderRequestBuilderBase

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.

Specified by:

addEntityFormDataValue in interface IEntitySenderRequestBuilderBase<T extends IEntitySenderRequestBuilderBase<?>>

setEntityFormData

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

Description copied from interface: IEntitySenderRequestBuilderBase

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.

Specified by:

setEntityFormData in interface IEntitySenderRequestBuilderBase<T extends IEntitySenderRequestBuilderBase<?>>

setEntityFormDatas

public T setEntityFormDatas(Map<String,List<String>> formDatas)

Description copied from interface: IEntitySenderRequestBuilderBase

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.

Specified by:

setEntityFormDatas in interface IEntitySenderRequestBuilderBase<T extends IEntitySenderRequestBuilderBase<?>>

setEntityString

public T setEntityString(String entityString,
                         String contentType)

Description copied from interface: IEntitySenderRequestBuilderBase

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.

Specified by:

setEntityString in interface IEntitySenderRequestBuilderBase<T extends IEntitySenderRequestBuilderBase<?>>

setEntityJson

public T setEntityJson(Object object)

Description copied from interface: IEntitySenderRequestBuilderBase

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.

Specified by:

setEntityJson in interface IEntitySenderRequestBuilderBase<T extends IEntitySenderRequestBuilderBase<?>>

setEntityXml

public T setEntityXml(Object object)

Description copied from interface: IEntitySenderRequestBuilderBase

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.

Specified by:

setEntityXml in interface IEntitySenderRequestBuilderBase<T extends IEntitySenderRequestBuilderBase<?>>

setEntity

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

Description copied from interface: IEntitySenderRequestBuilderBase

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.

Specified by:

setEntity in interface IEntitySenderRequestBuilderBase<T extends IEntitySenderRequestBuilderBase<?>>

addEntityFileUpload

public T addEntityFileUpload(String path,
                             String name)

Description copied from interface: IEntitySenderRequestBuilderBase

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

Specified by:

addEntityFileUpload in interface IEntitySenderRequestBuilderBase<T extends IEntitySenderRequestBuilderBase<?>>

Parameters:

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

name - the name to use for the uploaded file.

addEntityFileUpload

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

Description copied from interface: IEntitySenderRequestBuilderBase

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

Specified by:

addEntityFileUpload in interface IEntitySenderRequestBuilderBase<T extends IEntitySenderRequestBuilderBase<?>>

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.

convertToNameValuePair

protected List<org.spincast.shaded.org.apache.http.NameValuePair> convertToNameValuePair(Map<String,List<String>> params)

createMethodSpecificHttpRequest

protected org.spincast.shaded.org.apache.http.client.methods.HttpRequestBase createMethodSpecificHttpRequest(String url)

Description copied from class: SpincastHttpRequestBuilderBase

Creates the HttpRequestBase depending on the HTTP method.

Specified by:

createMethodSpecificHttpRequest in class SpincastHttpRequestBuilderBase<T extends IEntitySenderRequestBuilderBase<?>>

getHttpEntityEnclosingRequestBase

protected abstract org.spincast.shaded.org.apache.http.client.methods.HttpEntityEnclosingRequestBase getHttpEntityEnclosingRequestBase(String url)