com.atlassian.httpclient.api

Interface RequestFactory

All Known Subinterfaces:

HttpClient

All Known Implementing Classes:

ForwardingHttpClient

public interface RequestFactory

Convenient factory methods for creating a Request.Builder with common defaults.

Method Summary

Methods

Modifier and Type	Method and Description
Request.Builder	newRequest() Constructs a new request.
Request.Builder	newRequest(java.lang.String uri) Constructs a new Request with the specified URI.
Request.Builder	newRequest(java.lang.String url, java.lang.String contentType, java.lang.String entity) Constructs a new Request with the specified URI, contentType, and entity.
Request.Builder	newRequest(java.net.URI uri) Constructs a new Request with the specified URI.
Request.Builder	newRequest(java.net.URI uri, java.lang.String contentType, java.lang.String entity) Constructs a new Request with the specified URI, contentType, and entity.

Method Detail

newRequest

Request.Builder newRequest()

Constructs a new request. Sets the accept property to a default of "*/*".

Returns:

The new request object

newRequest

Request.Builder newRequest(java.net.URI uri)

Constructs a new Request with the specified URI. Sets the accept property to a default of "*/*".

Parameters:

uri - The endpoint URI for this request

Returns:

The new request object

newRequest

Request.Builder newRequest(java.lang.String uri)

Constructs a new Request with the specified URI. Sets the accept property to a default of "*/*".

Parameters:

uri - The endpoint URI for this request

Returns:

The new request object

newRequest

Request.Builder newRequest(java.net.URI uri,
                         java.lang.String contentType,
                         java.lang.String entity)

Constructs a new Request with the specified URI, contentType, and entity. Sets the accept property to a default of "*/*", and the content charset property to "UTF-8". This should only be used for sending textual content types, typically via the POST or PUT HTTP methods.

Parameters:

uri - The endpoint URI for this request

contentType - A textual IANA media type

entity - A string entity to send as this request's message body

Returns:

The new request object

newRequest

Request.Builder newRequest(java.lang.String url,
                         java.lang.String contentType,
                         java.lang.String entity)

Constructs a new Request with the specified URI, contentType, and entity. Sets the accept property to a default of "*/*", and the content charset property to "UTF-8". This should only be used for sending textual content types, typically via the POST or PUT HTTP methods.

Parameters:

url - The endpoint URL for this request

contentType - A textual IANA media type

entity - A string entity to send as this request's message body

Returns:

The new request object