Package org.spincast.plugins.httpclient.builders

Class HttpRequestBuilderBase<T extends HttpRequestBuilder<?>>

java.lang.Object

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

All Implemented Interfaces:

HttpRequestBuilder<T>

Direct Known Subclasses:

BodySenderRequestBuilderBaseDefault, ConnectRequestBuilderDefault, DeleteRequestBuilderDefault, GetRequestBuilderDefault, HeadRequestBuilderDefault, HttpSpincastRequestBuilderBase, OptionsRequestBuilderDefault, WebsocketRequestBuilderDefault

public abstract class HttpRequestBuilderBase<T extends HttpRequestBuilder<?>>
extends Object
implements HttpRequestBuilder<T>

Http client builders base class.

Constructor Summary

Constructors

Constructor	Description
HttpRequestBuilderBase(String url, CookieFactory cookieFactory, HttpResponseFactory spincastHttpResponseFactory, SpincastHttpClientUtils spincastHttpClientUtils, SpincastHttpClientConfig spincastHttpClientConfig)	Constructor

Method Summary

Modifier and Type	Method	Description
T	addHeaderValue(String key, String value)	Adds a value to the specified header.
T	addHeaderValues(String key, List<String> values)	Adds some values to the specified header.
T	addHTMLAcceptHeader()	Adds an Accept head for HTML.
T	addJsonAcceptHeader()	Adds an Accept head for Json.
T	addPlainTextAcceptHeader()	Adds an Accept head for plain text.
T	addXMLAcceptHeader()	Adds an Accept head for XML.
protected org.spincast.shaded.org.apache.http.cookie.Cookie	convertToApacheCookie(Cookie cookie)	Converts a Spincast cookie to an Apache one.
protected String	convertToApacheCookieTweakName(String name)
protected String	convertToApacheCookieTweakValue(String value)
protected org.spincast.shaded.org.apache.http.client.HttpClient	createHttpClient()	Creates the HTTPClient with a cookies store.
protected org.spincast.shaded.org.apache.http.impl.client.HttpClientBuilder	createHttpClientBuilder()
protected abstract org.spincast.shaded.org.apache.http.client.methods.HttpRequestBase	createMethodSpecificHttpRequest(String url)	Creates the HttpRequestBase depending on the HTTP method.
T	disableRedirectHandling()	Disables automatic handling of redirects.
T	disableSslCertificateErrors()	Disables some SSL certificates errors (such as self-signed certificate errors).
protected String	getCookieEncoding()
protected CookieFactory	getCookieFactory()
protected org.spincast.shaded.org.apache.http.client.CookieStore	getCookieStore()
protected Map<String,List<String>>	getHeaders()
protected String	getHttpAuthPassword()
protected String	getHttpAuthUsername()
protected org.spincast.shaded.org.apache.http.client.HttpClient	getHttpClient()
protected org.spincast.shaded.org.apache.http.impl.client.HttpClientBuilder	getHttpClientBuilder()
protected org.spincast.shaded.org.apache.http.protocol.HttpRequestExecutor	getHttpRequestExecutor()
protected org.spincast.shaded.org.apache.http.client.config.RequestConfig	getRequestConfig()
protected SpincastHttpClientConfig	getSpincastHttpClientConfig()
protected SpincastHttpClientUtils	getSpincastHttpClientUtils()
protected HttpResponseFactory	getSpincastHttpResponseFactory()
protected String	getUrl()
protected boolean	isDisableRedirectHandling()
protected boolean	isDisableSslCertificateErrors()
HttpResponse	send()	Sends the request and gets the HTTP response.
protected org.spincast.shaded.org.apache.http.HttpResponse	sendGetRawResponse()
T	setCookie(String name, String value)	Sets a cookie.
T	setCookie(String name, String value, boolean secure)	Sets a cookie, secure or not.
T	setCookie(Cookie cookie)	Sets a cookie.
T	setCookies(Collection<Cookie> cookies)	Sets some cookies.
protected void	setCookieStore(org.spincast.shaded.org.apache.http.client.CookieStore cookieStore)
T	setHeaders(Map<String,List<String>> headers)	Sets the headers.
T	setHeaderValues(String key, List<String> values)	Sets the values of the specified header.
T	setHttpAuthCredentials(String username, String password)	Set HTTP authentication credentials.
T	setHttpClientBuilder(org.spincast.shaded.org.apache.http.impl.client.HttpClientBuilder httpClientBuilder)	Sets a specific HttpClientBuilder to use.
T	setRequestConfig(org.spincast.shaded.org.apache.http.client.config.RequestConfig requestConfig)	Sets a custom RequestConfig to use.

Methods inherited from class java.lang.Object

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

Constructor Details

HttpRequestBuilderBase

public HttpRequestBuilderBase(String url,
 CookieFactory cookieFactory,
 HttpResponseFactory spincastHttpResponseFactory,
 SpincastHttpClientUtils spincastHttpClientUtils,
 SpincastHttpClientConfig spincastHttpClientConfig)

Constructor

Method Details

getSpincastHttpResponseFactory

protected HttpResponseFactory getSpincastHttpResponseFactory()

isDisableSslCertificateErrors

protected boolean isDisableSslCertificateErrors()

isDisableRedirectHandling

protected boolean isDisableRedirectHandling()

getSpincastHttpClientUtils

protected SpincastHttpClientUtils getSpincastHttpClientUtils()

getSpincastHttpClientConfig

protected SpincastHttpClientConfig getSpincastHttpClientConfig()

createHttpClient

protected org.spincast.shaded.org.apache.http.client.HttpClient createHttpClient()

Creates the HTTPClient with a cookies store.

getHttpClientBuilder

protected org.spincast.shaded.org.apache.http.impl.client.HttpClientBuilder getHttpClientBuilder()

getHttpRequestExecutor

protected org.spincast.shaded.org.apache.http.protocol.HttpRequestExecutor getHttpRequestExecutor()

createHttpClientBuilder

protected org.spincast.shaded.org.apache.http.impl.client.HttpClientBuilder createHttpClientBuilder()

setHttpClientBuilder

public T setHttpClientBuilder(org.spincast.shaded.org.apache.http.impl.client.HttpClientBuilder httpClientBuilder)

Description copied from interface: HttpRequestBuilder

Sets a specific HttpClientBuilder to use. If not provided, a default one will be used.

Specified by:

setHttpClientBuilder in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

disableSslCertificateErrors

public T disableSslCertificateErrors()

Description copied from interface: HttpRequestBuilder

Disables some SSL certificates errors (such as self-signed certificate errors).

SSL certificate errors are not disabled by default.

Be sure you know what you are doing if you disable this! It may lead to some security concerns!

Specified by:

disableSslCertificateErrors in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

disableRedirectHandling

public T disableRedirectHandling()

Description copied from interface: HttpRequestBuilder

Disables automatic handling of redirects.

By default, the client will automatically follow a redirect response. Calling this will allow you to get the actual redirect HTTP status.

Specified by:

disableRedirectHandling in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

setCookieStore

protected void setCookieStore(org.spincast.shaded.org.apache.http.client.CookieStore cookieStore)

getHttpClient

protected org.spincast.shaded.org.apache.http.client.HttpClient getHttpClient()

getCookieFactory

protected CookieFactory getCookieFactory()

getUrl

protected String getUrl()

getCookieStore

protected org.spincast.shaded.org.apache.http.client.CookieStore getCookieStore()

setCookie

public T setCookie(String name,
 String value)

Description copied from interface: HttpRequestBuilder

Sets a cookie. Secure by default (HTTPS only)!

Specified by:

setCookie in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

setCookie

public T setCookie(String name,
 String value,
 boolean secure)

Description copied from interface: HttpRequestBuilder

Sets a cookie, secure or not.

Specified by:

setCookie in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

setCookie

public T setCookie(Cookie cookie)

Description copied from interface: HttpRequestBuilder

Sets a cookie.

Specified by:

setCookie in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

setCookies

public T setCookies(Collection<Cookie> cookies)

Description copied from interface: HttpRequestBuilder

Sets some cookies.

Specified by:

setCookies in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

convertToApacheCookie

protected org.spincast.shaded.org.apache.http.cookie.Cookie convertToApacheCookie(Cookie cookie)

Converts a Spincast cookie to an Apache one.

convertToApacheCookieTweakName

protected String convertToApacheCookieTweakName(String name)

convertToApacheCookieTweakValue

protected String convertToApacheCookieTweakValue(String value)

setHeaders

public T setHeaders(Map<String,List<String>> headers)

Description copied from interface: HttpRequestBuilder

Sets the headers. Existing headers will be overwritten.

Specified by:

setHeaders in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

addHeaderValue

public T addHeaderValue(String key,
 String value)

Description copied from interface: HttpRequestBuilder

Adds a value to the specified header. Existing values will be kept.

Specified by:

addHeaderValue in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

addHeaderValues

public T addHeaderValues(String key,
 List<String> values)

Description copied from interface: HttpRequestBuilder

Adds some values to the specified header. Existing values will be kept.

Specified by:

addHeaderValues in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

setHeaderValues

public T setHeaderValues(String key,
 List<String> values)

Description copied from interface: HttpRequestBuilder

Sets the values of the specified header. Existing values of this header will be overwritten.

Specified by:

setHeaderValues in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

getHeaders

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

addJsonAcceptHeader

public T addJsonAcceptHeader()

Description copied from interface: HttpRequestBuilder

Adds an Accept head for Json.

Specified by:

addJsonAcceptHeader in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

addXMLAcceptHeader

public T addXMLAcceptHeader()

Description copied from interface: HttpRequestBuilder

Adds an Accept head for XML.

Specified by:

addXMLAcceptHeader in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

addHTMLAcceptHeader

public T addHTMLAcceptHeader()

Description copied from interface: HttpRequestBuilder

Adds an Accept head for HTML.

Specified by:

addHTMLAcceptHeader in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

addPlainTextAcceptHeader

public T addPlainTextAcceptHeader()

Description copied from interface: HttpRequestBuilder

Adds an Accept head for plain text.

Specified by:

addPlainTextAcceptHeader in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

setRequestConfig

public T setRequestConfig(org.spincast.shaded.org.apache.http.client.config.RequestConfig requestConfig)

Description copied from interface: HttpRequestBuilder

Sets a custom RequestConfig to use. If not provided, a default one will be used.

Specified by:

setRequestConfig in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

getRequestConfig

protected org.spincast.shaded.org.apache.http.client.config.RequestConfig getRequestConfig()

getCookieEncoding

protected String getCookieEncoding()

setHttpAuthCredentials

public T setHttpAuthCredentials(String username,
 String password)

Description copied from interface: HttpRequestBuilder

Set HTTP authentication credentials.

Specified by:

setHttpAuthCredentials in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

getHttpAuthUsername

protected String getHttpAuthUsername()

getHttpAuthPassword

protected String getHttpAuthPassword()

sendGetRawResponse

protected org.spincast.shaded.org.apache.http.HttpResponse sendGetRawResponse()

Returns:

the raw, unparsed HttpClient's HttpResponse

send

public HttpResponse send()

Description copied from interface: HttpRequestBuilder

Sends the request and gets the HTTP response.

Specified by:

send in interface HttpRequestBuilder<T extends HttpRequestBuilder<?>>

Returns:

A object containg the parsed information of the response.

createMethodSpecificHttpRequest

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

Creates the HttpRequestBase depending on the HTTP method.