org.spincast.plugins.httpclient.builders

Class SpincastRequestBuilderBase<T extends IRequestBuilderBase<?>>

java.lang.Object

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

All Implemented Interfaces:

IRequestBuilderBase<T>

Direct Known Subclasses:

ConnectRequestBuilder, DeleteRequestBuilder, EntitySenderRequestBuilderBase, GetRequestBuilder, HeadRequestBuilder, OptionsRequestBuilder, TraceRequestBuilder

public abstract class SpincastRequestBuilderBase<T extends IRequestBuilderBase<?>>
extends Object
implements IRequestBuilderBase<T>

Http client builders base class.

Constructor Summary

Constructors

Constructor and Description
SpincastRequestBuilderBase(String url, ICookieFactory cookieFactory, IHttpResponseFactory spincastHttpResponseFactory) Constructor

Method Summary

Modifier and Type	Method and Description
T	addCookie(ICookie cookie) Adds a cookie.
T	addCookie(String name, String value) Adds a cookie.
T	addCookies(Collection<ICookie> cookies) Adds some cookies.
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.
protected org.spincast.shaded.org.apache.http.cookie.Cookie	convertToApacheCookie(ICookie cookie) Converts a Spincast cookie to an Apache one.
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	disableSslCertificateErrors() Disables SSL certificates errors (such as self-signed certificate errors).
protected String	getCookieEncoding()
protected ICookieFactory	getCookieFactory()
protected org.spincast.shaded.org.apache.http.client.CookieStore	getCookieStore()
protected Map<String,List<String>>	getHeaders()
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.client.config.RequestConfig	getRequestConfig()
protected IHttpResponseFactory	getSpincastHttpResponseFactory()
protected String	getUrl()
protected boolean	isDisableSslCertificateErrors()
IHttpResponse	send() Sends the request and gets the response.
protected org.spincast.shaded.org.apache.http.HttpResponse	sendGetRawResponse()
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	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 Detail

SpincastRequestBuilderBase

public SpincastRequestBuilderBase(String url,
                                  ICookieFactory cookieFactory,
                                  IHttpResponseFactory spincastHttpResponseFactory)

Constructor

Method Detail

getSpincastHttpResponseFactory

protected IHttpResponseFactory getSpincastHttpResponseFactory()

isDisableSslCertificateErrors

protected boolean isDisableSslCertificateErrors()

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()

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: IRequestBuilderBase

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

Specified by:

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

disableSslCertificateErrors

public T disableSslCertificateErrors()

Description copied from interface: IRequestBuilderBase

Disables 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 IRequestBuilderBase<T extends IRequestBuilderBase<?>>

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 ICookieFactory getCookieFactory()

getUrl

protected String getUrl()

getCookieStore

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

addCookie

public T addCookie(String name,
                   String value)

Description copied from interface: IRequestBuilderBase

Adds a cookie.

Specified by:

addCookie in interface IRequestBuilderBase<T extends IRequestBuilderBase<?>>

addCookie

public T addCookie(ICookie cookie)

Description copied from interface: IRequestBuilderBase

Adds a cookie.

Specified by:

addCookie in interface IRequestBuilderBase<T extends IRequestBuilderBase<?>>

addCookies

public T addCookies(Collection<ICookie> cookies)

Description copied from interface: IRequestBuilderBase

Adds some cookies.

Specified by:

addCookies in interface IRequestBuilderBase<T extends IRequestBuilderBase<?>>

convertToApacheCookie

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

Converts a Spincast cookie to an Apache one.

setHeaders

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

Description copied from interface: IRequestBuilderBase

Sets the headers. Existing headers will be overwritten.

Specified by:

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

addHeaderValue

public T addHeaderValue(String key,
                        String value)

Description copied from interface: IRequestBuilderBase

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

Specified by:

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

addHeaderValues

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

Description copied from interface: IRequestBuilderBase

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

Specified by:

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

setHeaderValues

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

Description copied from interface: IRequestBuilderBase

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

Specified by:

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

getHeaders

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

setRequestConfig

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

Description copied from interface: IRequestBuilderBase

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

Specified by:

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

getRequestConfig

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

getCookieEncoding

protected String getCookieEncoding()

send

public IHttpResponse send()

Description copied from interface: IRequestBuilderBase

Sends the request and gets the response.

Specified by:

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

Returns:

A object containg the parsed information of the response.

sendGetRawResponse

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

Returns:

the raw, unparsed HttpClient's HttpResponse

createMethodSpecificHttpRequest

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

Creates the HttpRequestBase depending on the HTTP method.