Class SimpleRequestBuilder
- java.lang.Object
-
- org.apache.hc.core5.http.support.AbstractMessageBuilder<T>
-
- org.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
- org.apache.hc.client5.http.async.methods.SimpleRequestBuilder
-
public class SimpleRequestBuilder extends org.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
Builder forSimpleHttpRequest
instances.Please note that this class treats parameters differently depending on composition of the request: if the request has a content entity explicitly set with
setBody(SimpleBody)
or it is not an entity enclosing method (such as POST or PUT), parameters will be added to the query component of the request URI. Otherwise, parameters will be added as a URL encoded entity.- Since:
- 5.0
-
-
Field Summary
Fields Modifier and Type Field Description private SimpleBody
body
private RequestConfig
requestConfig
-
Constructor Summary
Constructors Constructor Description SimpleRequestBuilder(java.lang.String method)
SimpleRequestBuilder(java.lang.String method, java.lang.String uri)
SimpleRequestBuilder(java.lang.String method, java.net.URI uri)
SimpleRequestBuilder(org.apache.hc.core5.http.Method method)
SimpleRequestBuilder(org.apache.hc.core5.http.Method method, java.lang.String uri)
SimpleRequestBuilder(org.apache.hc.core5.http.Method method, java.net.URI uri)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SimpleRequestBuilder
addHeader(java.lang.String name, java.lang.String value)
SimpleRequestBuilder
addHeader(org.apache.hc.core5.http.Header header)
SimpleRequestBuilder
addParameter(java.lang.String name, java.lang.String value)
SimpleRequestBuilder
addParameter(org.apache.hc.core5.http.NameValuePair nvp)
SimpleRequestBuilder
addParameters(org.apache.hc.core5.http.NameValuePair... nvps)
SimpleHttpRequest
build()
static SimpleRequestBuilder
copy(SimpleHttpRequest request)
static SimpleRequestBuilder
copy(org.apache.hc.core5.http.HttpRequest request)
static SimpleRequestBuilder
create(java.lang.String method)
static SimpleRequestBuilder
create(org.apache.hc.core5.http.Method method)
static SimpleRequestBuilder
delete()
static SimpleRequestBuilder
delete(java.lang.String uri)
static SimpleRequestBuilder
delete(java.net.URI uri)
protected void
digest(SimpleHttpRequest request)
protected void
digest(org.apache.hc.core5.http.HttpRequest request)
static SimpleRequestBuilder
get()
static SimpleRequestBuilder
get(java.lang.String uri)
static SimpleRequestBuilder
get(java.net.URI uri)
SimpleBody
getBody()
RequestConfig
getRequestConfig()
static SimpleRequestBuilder
head()
static SimpleRequestBuilder
head(java.lang.String uri)
static SimpleRequestBuilder
head(java.net.URI uri)
static SimpleRequestBuilder
options()
static SimpleRequestBuilder
options(java.lang.String uri)
static SimpleRequestBuilder
options(java.net.URI uri)
static SimpleRequestBuilder
patch()
static SimpleRequestBuilder
patch(java.lang.String uri)
static SimpleRequestBuilder
patch(java.net.URI uri)
static SimpleRequestBuilder
post()
static SimpleRequestBuilder
post(java.lang.String uri)
static SimpleRequestBuilder
post(java.net.URI uri)
static SimpleRequestBuilder
put()
static SimpleRequestBuilder
put(java.lang.String uri)
static SimpleRequestBuilder
put(java.net.URI uri)
SimpleRequestBuilder
removeHeader(org.apache.hc.core5.http.Header header)
SimpleRequestBuilder
removeHeaders(java.lang.String name)
SimpleRequestBuilder
setAbsoluteRequestUri(boolean absoluteRequestUri)
SimpleRequestBuilder
setAuthority(org.apache.hc.core5.net.URIAuthority authority)
SimpleRequestBuilder
setBody(byte[] content, org.apache.hc.core5.http.ContentType contentType)
SimpleRequestBuilder
setBody(java.lang.String content, org.apache.hc.core5.http.ContentType contentType)
SimpleRequestBuilder
setBody(SimpleBody body)
SimpleRequestBuilder
setCharset(java.nio.charset.Charset charset)
SimpleRequestBuilder
setHeader(java.lang.String name, java.lang.String value)
SimpleRequestBuilder
setHeader(org.apache.hc.core5.http.Header header)
SimpleRequestBuilder
setHeaders(org.apache.hc.core5.http.Header... headers)
SimpleRequestBuilder
setHttpHost(org.apache.hc.core5.http.HttpHost httpHost)
SimpleRequestBuilder
setPath(java.lang.String path)
SimpleRequestBuilder
setRequestConfig(RequestConfig requestConfig)
SimpleRequestBuilder
setScheme(java.lang.String scheme)
SimpleRequestBuilder
setUri(java.lang.String uri)
SimpleRequestBuilder
setUri(java.net.URI uri)
SimpleRequestBuilder
setVersion(org.apache.hc.core5.http.ProtocolVersion version)
java.lang.String
toString()
static SimpleRequestBuilder
trace()
static SimpleRequestBuilder
trace(java.lang.String uri)
static SimpleRequestBuilder
trace(java.net.URI uri)
-
Methods inherited from class org.apache.hc.core5.http.support.AbstractRequestBuilder
getAuthority, getCharset, getMethod, getParameters, getPath, getScheme, getUri, isAbsoluteRequestUri
-
-
-
-
Field Detail
-
body
private SimpleBody body
-
requestConfig
private RequestConfig requestConfig
-
-
Constructor Detail
-
SimpleRequestBuilder
SimpleRequestBuilder(java.lang.String method)
-
SimpleRequestBuilder
SimpleRequestBuilder(org.apache.hc.core5.http.Method method)
-
SimpleRequestBuilder
SimpleRequestBuilder(java.lang.String method, java.net.URI uri)
-
SimpleRequestBuilder
SimpleRequestBuilder(org.apache.hc.core5.http.Method method, java.net.URI uri)
-
SimpleRequestBuilder
SimpleRequestBuilder(org.apache.hc.core5.http.Method method, java.lang.String uri)
-
SimpleRequestBuilder
SimpleRequestBuilder(java.lang.String method, java.lang.String uri)
-
-
Method Detail
-
create
public static SimpleRequestBuilder create(java.lang.String method)
-
create
public static SimpleRequestBuilder create(org.apache.hc.core5.http.Method method)
-
get
public static SimpleRequestBuilder get()
-
get
public static SimpleRequestBuilder get(java.net.URI uri)
-
get
public static SimpleRequestBuilder get(java.lang.String uri)
-
head
public static SimpleRequestBuilder head()
-
head
public static SimpleRequestBuilder head(java.net.URI uri)
-
head
public static SimpleRequestBuilder head(java.lang.String uri)
-
patch
public static SimpleRequestBuilder patch()
-
patch
public static SimpleRequestBuilder patch(java.net.URI uri)
-
patch
public static SimpleRequestBuilder patch(java.lang.String uri)
-
post
public static SimpleRequestBuilder post()
-
post
public static SimpleRequestBuilder post(java.net.URI uri)
-
post
public static SimpleRequestBuilder post(java.lang.String uri)
-
put
public static SimpleRequestBuilder put()
-
put
public static SimpleRequestBuilder put(java.net.URI uri)
-
put
public static SimpleRequestBuilder put(java.lang.String uri)
-
delete
public static SimpleRequestBuilder delete()
-
delete
public static SimpleRequestBuilder delete(java.net.URI uri)
-
delete
public static SimpleRequestBuilder delete(java.lang.String uri)
-
trace
public static SimpleRequestBuilder trace()
-
trace
public static SimpleRequestBuilder trace(java.net.URI uri)
-
trace
public static SimpleRequestBuilder trace(java.lang.String uri)
-
options
public static SimpleRequestBuilder options()
-
options
public static SimpleRequestBuilder options(java.net.URI uri)
-
options
public static SimpleRequestBuilder options(java.lang.String uri)
-
copy
public static SimpleRequestBuilder copy(SimpleHttpRequest request)
- Since:
- 5.1
-
copy
public static SimpleRequestBuilder copy(org.apache.hc.core5.http.HttpRequest request)
- Since:
- 5.1
-
digest
protected void digest(SimpleHttpRequest request)
-
digest
protected void digest(org.apache.hc.core5.http.HttpRequest request)
- Overrides:
digest
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
setVersion
public SimpleRequestBuilder setVersion(org.apache.hc.core5.http.ProtocolVersion version)
- Overrides:
setVersion
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
setUri
public SimpleRequestBuilder setUri(java.net.URI uri)
- Overrides:
setUri
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
setUri
public SimpleRequestBuilder setUri(java.lang.String uri)
- Overrides:
setUri
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
setScheme
public SimpleRequestBuilder setScheme(java.lang.String scheme)
- Overrides:
setScheme
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
setAuthority
public SimpleRequestBuilder setAuthority(org.apache.hc.core5.net.URIAuthority authority)
- Overrides:
setAuthority
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
setHttpHost
public SimpleRequestBuilder setHttpHost(org.apache.hc.core5.http.HttpHost httpHost)
- Overrides:
setHttpHost
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
setPath
public SimpleRequestBuilder setPath(java.lang.String path)
- Overrides:
setPath
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
setHeaders
public SimpleRequestBuilder setHeaders(org.apache.hc.core5.http.Header... headers)
- Overrides:
setHeaders
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
addHeader
public SimpleRequestBuilder addHeader(org.apache.hc.core5.http.Header header)
- Overrides:
addHeader
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
addHeader
public SimpleRequestBuilder addHeader(java.lang.String name, java.lang.String value)
- Overrides:
addHeader
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
removeHeader
public SimpleRequestBuilder removeHeader(org.apache.hc.core5.http.Header header)
- Overrides:
removeHeader
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
removeHeaders
public SimpleRequestBuilder removeHeaders(java.lang.String name)
- Overrides:
removeHeaders
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
setHeader
public SimpleRequestBuilder setHeader(org.apache.hc.core5.http.Header header)
- Overrides:
setHeader
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
setHeader
public SimpleRequestBuilder setHeader(java.lang.String name, java.lang.String value)
- Overrides:
setHeader
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
setCharset
public SimpleRequestBuilder setCharset(java.nio.charset.Charset charset)
- Overrides:
setCharset
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
addParameter
public SimpleRequestBuilder addParameter(org.apache.hc.core5.http.NameValuePair nvp)
- Overrides:
addParameter
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
addParameter
public SimpleRequestBuilder addParameter(java.lang.String name, java.lang.String value)
- Overrides:
addParameter
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
addParameters
public SimpleRequestBuilder addParameters(org.apache.hc.core5.http.NameValuePair... nvps)
- Overrides:
addParameters
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
setAbsoluteRequestUri
public SimpleRequestBuilder setAbsoluteRequestUri(boolean absoluteRequestUri)
- Overrides:
setAbsoluteRequestUri
in classorg.apache.hc.core5.http.support.AbstractRequestBuilder<SimpleHttpRequest>
-
getBody
public SimpleBody getBody()
-
setBody
public SimpleRequestBuilder setBody(SimpleBody body)
-
setBody
public SimpleRequestBuilder setBody(java.lang.String content, org.apache.hc.core5.http.ContentType contentType)
-
setBody
public SimpleRequestBuilder setBody(byte[] content, org.apache.hc.core5.http.ContentType contentType)
-
getRequestConfig
public RequestConfig getRequestConfig()
-
setRequestConfig
public SimpleRequestBuilder setRequestConfig(RequestConfig requestConfig)
-
build
public SimpleHttpRequest build()
- Specified by:
build
in classorg.apache.hc.core5.http.support.AbstractMessageBuilder<SimpleHttpRequest>
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-