Package org.apache.hc.core5.http.io.support

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 for ClassicHttpRequest 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

Modifier and Type	Method	Description
ClassicRequestBuilder	addHeader(java.lang.String name, java.lang.String value)
ClassicRequestBuilder	addHeader(Header header)
ClassicRequestBuilder	addParameter(java.lang.String name, java.lang.String value)
ClassicRequestBuilder	addParameter(NameValuePair nvp)
ClassicRequestBuilder	addParameters(NameValuePair... nvps)
ClassicHttpRequest	build()
static ClassicRequestBuilder	copy(ClassicHttpRequest request)
static ClassicRequestBuilder	create(java.lang.String method)
static ClassicRequestBuilder	delete()
static ClassicRequestBuilder	delete(java.lang.String uri)
static ClassicRequestBuilder	delete(java.net.URI uri)
protected void	digest(ClassicHttpRequest request)
static ClassicRequestBuilder	get()
static ClassicRequestBuilder	get(java.lang.String uri)
static ClassicRequestBuilder	get(java.net.URI uri)
HttpEntity	getEntity()
static ClassicRequestBuilder	head()
static ClassicRequestBuilder	head(java.lang.String uri)
static ClassicRequestBuilder	head(java.net.URI uri)
static ClassicRequestBuilder	options()
static ClassicRequestBuilder	options(java.lang.String uri)
static ClassicRequestBuilder	options(java.net.URI uri)
static ClassicRequestBuilder	patch()
static ClassicRequestBuilder	patch(java.lang.String uri)
static ClassicRequestBuilder	patch(java.net.URI uri)
static ClassicRequestBuilder	post()
static ClassicRequestBuilder	post(java.lang.String uri)
static ClassicRequestBuilder	post(java.net.URI uri)
static ClassicRequestBuilder	put()
static ClassicRequestBuilder	put(java.lang.String uri)
static ClassicRequestBuilder	put(java.net.URI uri)
ClassicRequestBuilder	removeHeader(Header header)
ClassicRequestBuilder	removeHeaders(java.lang.String name)
ClassicRequestBuilder	setAbsoluteRequestUri(boolean absoluteRequestUri)
ClassicRequestBuilder	setAuthority(URIAuthority authority)
ClassicRequestBuilder	setCharset(java.nio.charset.Charset charset)
ClassicRequestBuilder	setEntity(byte[] content, ContentType contentType)
ClassicRequestBuilder	setEntity(java.lang.String content)
ClassicRequestBuilder	setEntity(java.lang.String content, ContentType contentType)
ClassicRequestBuilder	setEntity(HttpEntity entity)
ClassicRequestBuilder	setHeader(java.lang.String name, java.lang.String value)
ClassicRequestBuilder	setHeader(Header header)
ClassicRequestBuilder	setHeaders(Header... headers)
ClassicRequestBuilder	setHttpHost(HttpHost httpHost)
ClassicRequestBuilder	setPath(java.lang.String path)
ClassicRequestBuilder	setScheme(java.lang.String scheme)
ClassicRequestBuilder	setUri(java.lang.String uri)
ClassicRequestBuilder	setUri(java.net.URI uri)
ClassicRequestBuilder	setVersion(ProtocolVersion version)
java.lang.String	toString()
static ClassicRequestBuilder	trace()
static ClassicRequestBuilder	trace(java.lang.String uri)
static ClassicRequestBuilder	trace(java.net.URI uri)

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

Methods inherited from class java.lang.Object

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

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 class AbstractRequestBuilder<ClassicHttpRequest>

setUri

public ClassicRequestBuilder setUri(java.net.URI uri)

Overrides:

setUri in class AbstractRequestBuilder<ClassicHttpRequest>

setUri

public ClassicRequestBuilder setUri(java.lang.String uri)

Overrides:

setUri in class AbstractRequestBuilder<ClassicHttpRequest>

setScheme

public ClassicRequestBuilder setScheme(java.lang.String scheme)

Overrides:

setScheme in class AbstractRequestBuilder<ClassicHttpRequest>

setAuthority

public ClassicRequestBuilder setAuthority(URIAuthority authority)

Overrides:

setAuthority in class AbstractRequestBuilder<ClassicHttpRequest>

setHttpHost

public ClassicRequestBuilder setHttpHost(HttpHost httpHost)

Overrides:

setHttpHost in class AbstractRequestBuilder<ClassicHttpRequest>

Since:

5.1

setPath

public ClassicRequestBuilder setPath(java.lang.String path)

Overrides:

setPath in class AbstractRequestBuilder<ClassicHttpRequest>

setHeaders

public ClassicRequestBuilder setHeaders(Header... headers)

Overrides:

setHeaders in class AbstractRequestBuilder<ClassicHttpRequest>

addHeader

public ClassicRequestBuilder addHeader(Header header)

Overrides:

addHeader in class AbstractRequestBuilder<ClassicHttpRequest>

addHeader

public ClassicRequestBuilder addHeader(java.lang.String name,
                                       java.lang.String value)

Overrides:

addHeader in class AbstractRequestBuilder<ClassicHttpRequest>

removeHeader

public ClassicRequestBuilder removeHeader(Header header)

Overrides:

removeHeader in class AbstractRequestBuilder<ClassicHttpRequest>

removeHeaders

public ClassicRequestBuilder removeHeaders(java.lang.String name)

Overrides:

removeHeaders in class AbstractRequestBuilder<ClassicHttpRequest>

setHeader

public ClassicRequestBuilder setHeader(Header header)

Overrides:

setHeader in class AbstractRequestBuilder<ClassicHttpRequest>

setHeader

public ClassicRequestBuilder setHeader(java.lang.String name,
                                       java.lang.String value)

Overrides:

setHeader in class AbstractRequestBuilder<ClassicHttpRequest>

setCharset

public ClassicRequestBuilder setCharset(java.nio.charset.Charset charset)

Overrides:

setCharset in class AbstractRequestBuilder<ClassicHttpRequest>

addParameter

public ClassicRequestBuilder addParameter(NameValuePair nvp)

Overrides:

addParameter in class AbstractRequestBuilder<ClassicHttpRequest>

addParameter

public ClassicRequestBuilder addParameter(java.lang.String name,
                                          java.lang.String value)

Overrides:

addParameter in class AbstractRequestBuilder<ClassicHttpRequest>

addParameters

public ClassicRequestBuilder addParameters(NameValuePair... nvps)

Overrides:

addParameters in class AbstractRequestBuilder<ClassicHttpRequest>

setAbsoluteRequestUri

public ClassicRequestBuilder setAbsoluteRequestUri(boolean absoluteRequestUri)

Overrides:

setAbsoluteRequestUri in class AbstractRequestBuilder<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 class AbstractMessageBuilder<ClassicHttpRequest>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object