Class ClassicRequestBuilder
- java.lang.Object
-
- org.apache.hc.core5.http.support.AbstractMessageBuilder<T>
-
- org.apache.hc.core5.http.support.AbstractRequestBuilder<ClassicHttpRequest>
-
- org.apache.hc.core5.http.io.support.ClassicRequestBuilder
-
public class ClassicRequestBuilder extends AbstractRequestBuilder<ClassicHttpRequest>
Builder forClassicHttpRequest
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
setEntity(HttpEntity)
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 HttpEntity
entity
-
Constructor Summary
Constructors Constructor Description ClassicRequestBuilder(java.lang.String method)
ClassicRequestBuilder(java.lang.String method, java.lang.String uri)
ClassicRequestBuilder(java.lang.String method, java.net.URI uri)
ClassicRequestBuilder(Method method)
ClassicRequestBuilder(Method method, java.lang.String uri)
ClassicRequestBuilder(Method method, java.net.URI uri)
-
Method Summary
-
Methods inherited from class org.apache.hc.core5.http.support.AbstractRequestBuilder
digest, getAuthority, getCharset, getMethod, getParameters, getPath, getScheme, getUri, isAbsoluteRequestUri
-
Methods inherited from class org.apache.hc.core5.http.support.AbstractMessageBuilder
digest, getFirstHeader, getFirstHeaders, getHeaders, getHeaders, getLastHeader, getVersion, setHeaders
-
-
-
-
Field Detail
-
entity
private HttpEntity entity
-
-
Constructor Detail
-
ClassicRequestBuilder
ClassicRequestBuilder(java.lang.String method)
-
ClassicRequestBuilder
ClassicRequestBuilder(Method method)
-
ClassicRequestBuilder
ClassicRequestBuilder(java.lang.String method, java.net.URI uri)
-
ClassicRequestBuilder
ClassicRequestBuilder(Method method, java.net.URI uri)
-
ClassicRequestBuilder
ClassicRequestBuilder(Method method, java.lang.String uri)
-
ClassicRequestBuilder
ClassicRequestBuilder(java.lang.String method, java.lang.String uri)
-
-
Method Detail
-
create
public static ClassicRequestBuilder create(java.lang.String method)
-
get
public static ClassicRequestBuilder get()
-
get
public static ClassicRequestBuilder get(java.net.URI uri)
-
get
public static ClassicRequestBuilder get(java.lang.String uri)
-
head
public static ClassicRequestBuilder head()
-
head
public static ClassicRequestBuilder head(java.net.URI uri)
-
head
public static ClassicRequestBuilder head(java.lang.String uri)
-
patch
public static ClassicRequestBuilder patch()
-
patch
public static ClassicRequestBuilder patch(java.net.URI uri)
-
patch
public static ClassicRequestBuilder patch(java.lang.String uri)
-
post
public static ClassicRequestBuilder post()
-
post
public static ClassicRequestBuilder post(java.net.URI uri)
-
post
public static ClassicRequestBuilder post(java.lang.String uri)
-
put
public static ClassicRequestBuilder put()
-
put
public static ClassicRequestBuilder put(java.net.URI uri)
-
put
public static ClassicRequestBuilder put(java.lang.String uri)
-
delete
public static ClassicRequestBuilder delete()
-
delete
public static ClassicRequestBuilder delete(java.net.URI uri)
-
delete
public static ClassicRequestBuilder delete(java.lang.String uri)
-
trace
public static ClassicRequestBuilder trace()
-
trace
public static ClassicRequestBuilder trace(java.net.URI uri)
-
trace
public static ClassicRequestBuilder trace(java.lang.String uri)
-
options
public static ClassicRequestBuilder options()
-
options
public static ClassicRequestBuilder options(java.net.URI uri)
-
options
public static ClassicRequestBuilder options(java.lang.String uri)
-
copy
public static ClassicRequestBuilder copy(ClassicHttpRequest request)
- Since:
- 5.1
-
digest
protected void digest(ClassicHttpRequest request)
-
setVersion
public ClassicRequestBuilder setVersion(ProtocolVersion version)
- Overrides:
setVersion
in classAbstractRequestBuilder<ClassicHttpRequest>
-
setUri
public ClassicRequestBuilder setUri(java.net.URI uri)
- Overrides:
setUri
in classAbstractRequestBuilder<ClassicHttpRequest>
-
setUri
public ClassicRequestBuilder setUri(java.lang.String uri)
- Overrides:
setUri
in classAbstractRequestBuilder<ClassicHttpRequest>
-
setScheme
public ClassicRequestBuilder setScheme(java.lang.String scheme)
- Overrides:
setScheme
in classAbstractRequestBuilder<ClassicHttpRequest>
-
setAuthority
public ClassicRequestBuilder setAuthority(URIAuthority authority)
- Overrides:
setAuthority
in classAbstractRequestBuilder<ClassicHttpRequest>
-
setHttpHost
public ClassicRequestBuilder setHttpHost(HttpHost httpHost)
- Overrides:
setHttpHost
in classAbstractRequestBuilder<ClassicHttpRequest>
- Since:
- 5.1
-
setPath
public ClassicRequestBuilder setPath(java.lang.String path)
- Overrides:
setPath
in classAbstractRequestBuilder<ClassicHttpRequest>
-
setHeaders
public ClassicRequestBuilder setHeaders(Header... headers)
- Overrides:
setHeaders
in classAbstractRequestBuilder<ClassicHttpRequest>
-
addHeader
public ClassicRequestBuilder addHeader(Header header)
- Overrides:
addHeader
in classAbstractRequestBuilder<ClassicHttpRequest>
-
addHeader
public ClassicRequestBuilder addHeader(java.lang.String name, java.lang.String value)
- Overrides:
addHeader
in classAbstractRequestBuilder<ClassicHttpRequest>
-
removeHeader
public ClassicRequestBuilder removeHeader(Header header)
- Overrides:
removeHeader
in classAbstractRequestBuilder<ClassicHttpRequest>
-
removeHeaders
public ClassicRequestBuilder removeHeaders(java.lang.String name)
- Overrides:
removeHeaders
in classAbstractRequestBuilder<ClassicHttpRequest>
-
setHeader
public ClassicRequestBuilder setHeader(Header header)
- Overrides:
setHeader
in classAbstractRequestBuilder<ClassicHttpRequest>
-
setHeader
public ClassicRequestBuilder setHeader(java.lang.String name, java.lang.String value)
- Overrides:
setHeader
in classAbstractRequestBuilder<ClassicHttpRequest>
-
setCharset
public ClassicRequestBuilder setCharset(java.nio.charset.Charset charset)
- Overrides:
setCharset
in classAbstractRequestBuilder<ClassicHttpRequest>
-
addParameter
public ClassicRequestBuilder addParameter(NameValuePair nvp)
- Overrides:
addParameter
in classAbstractRequestBuilder<ClassicHttpRequest>
-
addParameter
public ClassicRequestBuilder addParameter(java.lang.String name, java.lang.String value)
- Overrides:
addParameter
in classAbstractRequestBuilder<ClassicHttpRequest>
-
addParameters
public ClassicRequestBuilder addParameters(NameValuePair... nvps)
- Overrides:
addParameters
in classAbstractRequestBuilder<ClassicHttpRequest>
-
setAbsoluteRequestUri
public ClassicRequestBuilder setAbsoluteRequestUri(boolean absoluteRequestUri)
- Overrides:
setAbsoluteRequestUri
in classAbstractRequestBuilder<ClassicHttpRequest>
-
getEntity
public HttpEntity getEntity()
-
setEntity
public ClassicRequestBuilder setEntity(HttpEntity entity)
-
setEntity
public ClassicRequestBuilder setEntity(java.lang.String content, ContentType contentType)
-
setEntity
public ClassicRequestBuilder setEntity(java.lang.String content)
-
setEntity
public ClassicRequestBuilder setEntity(byte[] content, ContentType contentType)
-
build
public ClassicHttpRequest build()
- Specified by:
build
in classAbstractMessageBuilder<ClassicHttpRequest>
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-