com.cognifide.gradle.aem.common.http

Class HttpClient

com.cognifide.gradle.aem.common.http.HttpClient

Direct Known Subclasses:

InstanceHttpClient

public class HttpClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpClient.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static HttpClient.Companion	Companion

Constructor Summary

Constructors

Constructor and Description
HttpClient(AemExtension aem)

Method Summary

Modifier and Type	Method and Description
com.jayway.jsonpath.DocumentContext	asJson(org.apache.http.HttpResponse response)
com.jayway.jsonpath.DocumentContext	asJson(java.lang.String jsonString)
<T> T	asObjectFromJson(org.apache.http.HttpResponse response, java.lang.Class<T> clazz)
java.io.InputStream	asStream(org.apache.http.HttpResponse response)
java.lang.String	asString(org.apache.http.HttpResponse response)
java.lang.String	baseUrl(java.lang.String uri) Fix for HttpClient's: 'escaped absolute path not valid' https://stackoverflow.com/questions/13652681/httpclient-invalid-uri-escaped-absolute-path-not-valid
void	checkHtml(org.apache.http.HttpResponse response, kotlin.jvm.functions.Function1<? super org.jsoup.nodes.Document,java.lang.Boolean> validator)
void	checkStatus(org.apache.http.HttpResponse response, kotlin.ranges.IntRange statusCodes)
void	checkStatus(org.apache.http.HttpResponse response, int statusCode)
void	checkStatus(org.apache.http.HttpResponse response, java.util.List<java.lang.Integer> statusCodes)
void	checkText(org.apache.http.HttpResponse response, java.lang.String containedText, boolean ignoreCase)
org.apache.http.HttpEntity	createEntityMultipart(java.util.Map<java.lang.String,? extends java.lang.Object> params)
org.apache.http.HttpEntity	createEntityUrlencoded(java.util.Map<java.lang.String,? extends java.lang.Object> params)
void	delete(java.lang.String uri)
<T> T	delete(java.lang.String uri, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)
<T> T	delete(java.lang.String uri, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler, kotlin.jvm.functions.Function1<? super org.apache.http.client.methods.HttpDelete,kotlin.Unit> options)
<T> T	execute(org.apache.http.client.methods.HttpRequestBase method, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)
void	execute(org.apache.http.client.methods.HttpRequestBase method)
<T> T	fileTransfer(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.file.transfer.http.HttpFileTransfer,? extends T> operation)
void	get(java.lang.String uri)
<T> T	get(java.lang.String uri, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)
<T> T	get(java.lang.String uri, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler, kotlin.jvm.functions.Function1<? super org.apache.http.client.methods.HttpGet,kotlin.Unit> options)
boolean	getAuthorizationPreemptive()
java.lang.String	getBaseUrl()
java.lang.String	getBasicPassword()
java.lang.String	getBasicUser()
org.apache.http.impl.client.CloseableHttpClient	getClient()
kotlin.jvm.functions.Function1<org.apache.http.impl.client.HttpClientBuilder,kotlin.Unit>	getClientBuilder()
boolean	getConnectionIgnoreSsl()
boolean	getConnectionRetries()
int	getConnectionTimeout()
java.lang.String	getProxyHost()
java.lang.Integer	getProxyPort()
java.lang.String	getProxyScheme()
kotlin.jvm.functions.Function1<org.apache.http.client.methods.HttpRequestBase,kotlin.Unit>	getRequestConfigurer()
kotlin.jvm.functions.Function1<org.apache.http.HttpResponse,kotlin.Unit>	getResponseChecker()
boolean	getResponseChecks()
kotlin.jvm.functions.Function1<org.apache.http.HttpResponse,kotlin.Unit>	getResponseHandler()
void	head(java.lang.String uri)
<T> T	head(java.lang.String uri, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)
<T> T	head(java.lang.String uri, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler, kotlin.jvm.functions.Function1<? super org.apache.http.client.methods.HttpHead,kotlin.Unit> options)
void	patch(java.lang.String path)
<T> T	patch(java.lang.String uri, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)
<T> T	patch(java.lang.String uri, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler, kotlin.jvm.functions.Function1<? super org.apache.http.client.methods.HttpPatch,kotlin.Unit> options)
void	post(java.lang.String url, java.util.Map<java.lang.String,? extends java.lang.Object> params)
<T> T	post(java.lang.String uri, java.util.Map<java.lang.String,? extends java.lang.Object> params, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)
<T> T	post(java.lang.String uri, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)
<T> T	post(java.lang.String uri, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler, kotlin.jvm.functions.Function1<? super org.apache.http.client.methods.HttpPost,kotlin.Unit> options)
void	postMultipart(java.lang.String uri, java.util.Map<java.lang.String,? extends java.lang.Object> params)
<T> T	postMultipart(java.lang.String uri, java.util.Map<java.lang.String,? extends java.lang.Object> params, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)
void	postUrlencoded(java.lang.String uri, java.util.Map<java.lang.String,? extends java.lang.Object> params)
<T> T	postUrlencoded(java.lang.String uri, java.util.Map<java.lang.String,? extends java.lang.Object> params, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)
void	put(java.lang.String uri)
<T> T	put(java.lang.String uri, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)
<T> T	put(java.lang.String uri, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler, kotlin.jvm.functions.Function1<? super org.apache.http.client.methods.HttpPut,kotlin.Unit> options)
<T> T	request(java.lang.String method, java.lang.String uri, kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)
void	setAuthorizationPreemptive(boolean p)
void	setBaseUrl(java.lang.String p)
void	setBasicPassword(java.lang.String p)
void	setBasicUser(java.lang.String p)
void	setClientBuilder(kotlin.jvm.functions.Function1<? super org.apache.http.impl.client.HttpClientBuilder,kotlin.Unit> p)
void	setConnectionIgnoreSsl(boolean p)
void	setConnectionRetries(boolean p)
void	setConnectionTimeout(int p)
void	setProxyHost(java.lang.String p)
void	setProxyPort(java.lang.Integer p)
void	setProxyScheme(java.lang.String p)
void	setRequestConfigurer(kotlin.jvm.functions.Function1<? super org.apache.http.client.methods.HttpRequestBase,kotlin.Unit> p)
void	setResponseChecker(kotlin.jvm.functions.Function1<? super org.apache.http.HttpResponse,kotlin.Unit> p)
void	setResponseChecks(boolean p)
void	setResponseHandler(kotlin.jvm.functions.Function1<? super org.apache.http.HttpResponse,kotlin.Unit> p)
void	throwStatusException(org.apache.http.HttpResponse response)

Field Detail

Companion

public static HttpClient.Companion Companion

Constructor Detail

HttpClient

public HttpClient(@NotNull
                  AemExtension aem)

Method Detail

getConnectionTimeout

public int getConnectionTimeout()

setConnectionTimeout

public void setConnectionTimeout(int p)

getConnectionIgnoreSsl

public boolean getConnectionIgnoreSsl()

setConnectionIgnoreSsl

public void setConnectionIgnoreSsl(boolean p)

getConnectionRetries

public boolean getConnectionRetries()

setConnectionRetries

public void setConnectionRetries(boolean p)

getAuthorizationPreemptive

public boolean getAuthorizationPreemptive()

setAuthorizationPreemptive

public void setAuthorizationPreemptive(boolean p)

getBaseUrl

@NotNull
public java.lang.String getBaseUrl()

setBaseUrl

public void setBaseUrl(@NotNull
                       java.lang.String p)

getBasicUser

@Nullable
public java.lang.String getBasicUser()

setBasicUser

public void setBasicUser(@Nullable
                         java.lang.String p)

getBasicPassword

@Nullable
public java.lang.String getBasicPassword()

setBasicPassword

public void setBasicPassword(@Nullable
                             java.lang.String p)

getProxyHost

@Nullable
public java.lang.String getProxyHost()

setProxyHost

public void setProxyHost(@Nullable
                         java.lang.String p)

getProxyPort

@Nullable
public java.lang.Integer getProxyPort()

setProxyPort

public void setProxyPort(@Nullable
                         java.lang.Integer p)

getProxyScheme

@Nullable
public java.lang.String getProxyScheme()

setProxyScheme

public void setProxyScheme(@Nullable
                           java.lang.String p)

getRequestConfigurer

@NotNull
public kotlin.jvm.functions.Function1<org.apache.http.client.methods.HttpRequestBase,kotlin.Unit> getRequestConfigurer()

setRequestConfigurer

public void setRequestConfigurer(@NotNull
                                 kotlin.jvm.functions.Function1<? super org.apache.http.client.methods.HttpRequestBase,kotlin.Unit> p)

getClientBuilder

@NotNull
public kotlin.jvm.functions.Function1<org.apache.http.impl.client.HttpClientBuilder,kotlin.Unit> getClientBuilder()

setClientBuilder

public void setClientBuilder(@NotNull
                             kotlin.jvm.functions.Function1<? super org.apache.http.impl.client.HttpClientBuilder,kotlin.Unit> p)

getClient

public org.apache.http.impl.client.CloseableHttpClient getClient()

getResponseHandler

@NotNull
public kotlin.jvm.functions.Function1<org.apache.http.HttpResponse,kotlin.Unit> getResponseHandler()

setResponseHandler

public void setResponseHandler(@NotNull
                               kotlin.jvm.functions.Function1<? super org.apache.http.HttpResponse,kotlin.Unit> p)

getResponseChecks

public boolean getResponseChecks()

setResponseChecks

public void setResponseChecks(boolean p)

getResponseChecker

@NotNull
public kotlin.jvm.functions.Function1<org.apache.http.HttpResponse,kotlin.Unit> getResponseChecker()

setResponseChecker

public void setResponseChecker(@NotNull
                               kotlin.jvm.functions.Function1<? super org.apache.http.HttpResponse,kotlin.Unit> p)

request

public <T> T request(@NotNull
                     java.lang.String method,
                     @NotNull
                     java.lang.String uri,
                     @NotNull
                     kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)

get

public void get(@NotNull
                java.lang.String uri)

get

public <T> T get(@NotNull
                 java.lang.String uri,
                 @NotNull
                 kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)

get

public <T> T get(@NotNull
                 java.lang.String uri,
                 @NotNull
                 kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler,
                 @NotNull
                 kotlin.jvm.functions.Function1<? super org.apache.http.client.methods.HttpGet,kotlin.Unit> options)

head

public void head(@NotNull
                 java.lang.String uri)

head

public <T> T head(@NotNull
                  java.lang.String uri,
                  @NotNull
                  kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)

head

public <T> T head(@NotNull
                  java.lang.String uri,
                  @NotNull
                  kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler,
                  @NotNull
                  kotlin.jvm.functions.Function1<? super org.apache.http.client.methods.HttpHead,kotlin.Unit> options)

delete

public void delete(@NotNull
                   java.lang.String uri)

delete

public <T> T delete(@NotNull
                    java.lang.String uri,
                    @NotNull
                    kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)

delete

public <T> T delete(@NotNull
                    java.lang.String uri,
                    @NotNull
                    kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler,
                    @NotNull
                    kotlin.jvm.functions.Function1<? super org.apache.http.client.methods.HttpDelete,kotlin.Unit> options)

put

public void put(@NotNull
                java.lang.String uri)

put

public <T> T put(@NotNull
                 java.lang.String uri,
                 @NotNull
                 kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)

put

public <T> T put(@NotNull
                 java.lang.String uri,
                 @NotNull
                 kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler,
                 @NotNull
                 kotlin.jvm.functions.Function1<? super org.apache.http.client.methods.HttpPut,kotlin.Unit> options)

patch

public void patch(@NotNull
                  java.lang.String path)

patch

public <T> T patch(@NotNull
                   java.lang.String uri,
                   @NotNull
                   kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)

patch

public <T> T patch(@NotNull
                   java.lang.String uri,
                   @NotNull
                   kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler,
                   @NotNull
                   kotlin.jvm.functions.Function1<? super org.apache.http.client.methods.HttpPatch,kotlin.Unit> options)

post

public void post(@NotNull
                 java.lang.String url,
                 @NotNull
                 java.util.Map<java.lang.String,? extends java.lang.Object> params)

post

public <T> T post(@NotNull
                  java.lang.String uri,
                  @NotNull
                  java.util.Map<java.lang.String,? extends java.lang.Object> params,
                  @NotNull
                  kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)

postUrlencoded

public void postUrlencoded(@NotNull
                           java.lang.String uri,
                           @NotNull
                           java.util.Map<java.lang.String,? extends java.lang.Object> params)

postUrlencoded

public <T> T postUrlencoded(@NotNull
                            java.lang.String uri,
                            @NotNull
                            java.util.Map<java.lang.String,? extends java.lang.Object> params,
                            @NotNull
                            kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)

postMultipart

public void postMultipart(@NotNull
                          java.lang.String uri,
                          @NotNull
                          java.util.Map<java.lang.String,? extends java.lang.Object> params)

postMultipart

public <T> T postMultipart(@NotNull
                           java.lang.String uri,
                           @NotNull
                           java.util.Map<java.lang.String,? extends java.lang.Object> params,
                           @NotNull
                           kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)

post

public <T> T post(@NotNull
                  java.lang.String uri,
                  @NotNull
                  kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)

post

public <T> T post(@NotNull
                  java.lang.String uri,
                  @NotNull
                  kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler,
                  @NotNull
                  kotlin.jvm.functions.Function1<? super org.apache.http.client.methods.HttpPost,kotlin.Unit> options)

asStream

@NotNull
public java.io.InputStream asStream(@NotNull
                                              org.apache.http.HttpResponse response)

asJson

@NotNull
public com.jayway.jsonpath.DocumentContext asJson(@NotNull
                                                            org.apache.http.HttpResponse response)

asJson

@NotNull
public com.jayway.jsonpath.DocumentContext asJson(@NotNull
                                                            java.lang.String jsonString)

asString

@NotNull
public java.lang.String asString(@NotNull
                                           org.apache.http.HttpResponse response)

asObjectFromJson

public <T> T asObjectFromJson(@NotNull
                              org.apache.http.HttpResponse response,
                              @NotNull
                              java.lang.Class<T> clazz)

checkStatus

public void checkStatus(@NotNull
                        org.apache.http.HttpResponse response,
                        @NotNull
                        kotlin.ranges.IntRange statusCodes)

checkStatus

public void checkStatus(@NotNull
                        org.apache.http.HttpResponse response,
                        int statusCode)

checkStatus

public void checkStatus(@NotNull
                        org.apache.http.HttpResponse response,
                        @NotNull
                        java.util.List<java.lang.Integer> statusCodes)

throwStatusException

public void throwStatusException(@NotNull
                                 org.apache.http.HttpResponse response)

checkText

public void checkText(@NotNull
                      org.apache.http.HttpResponse response,
                      @NotNull
                      java.lang.String containedText,
                      boolean ignoreCase)

checkHtml

public void checkHtml(@NotNull
                      org.apache.http.HttpResponse response,
                      @NotNull
                      kotlin.jvm.functions.Function1<? super org.jsoup.nodes.Document,java.lang.Boolean> validator)

baseUrl

@NotNull
public java.lang.String baseUrl(@NotNull
                                          java.lang.String uri)

Fix for HttpClient's: 'escaped absolute path not valid' https://stackoverflow.com/questions/13652681/httpclient-invalid-uri-escaped-absolute-path-not-valid

execute

public <T> T execute(@NotNull
                     org.apache.http.client.methods.HttpRequestBase method,
                     @NotNull
                     kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.common.http.HttpClient,? super org.apache.http.HttpResponse,? extends T> handler)

execute

public void execute(@NotNull
                    org.apache.http.client.methods.HttpRequestBase method)

createEntityUrlencoded

@NotNull
public org.apache.http.HttpEntity createEntityUrlencoded(@NotNull
                                                                   java.util.Map<java.lang.String,? extends java.lang.Object> params)

createEntityMultipart

@NotNull
public org.apache.http.HttpEntity createEntityMultipart(@NotNull
                                                                  java.util.Map<java.lang.String,? extends java.lang.Object> params)

fileTransfer

public <T> T fileTransfer(@NotNull
                          kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.common.file.transfer.http.HttpFileTransfer,? extends T> operation)