com.atlassian.httpclient.api

Interface Request.Builder

Enclosing interface:

Request

public static interface Request.Builder

Method Summary

Methods

Modifier and Type	Method and Description
B	build()
Request.Builder	delete() Sets this request's Method to DELETE
Request.Builder	get() Sets this request's Method to GET
Request.Builder	head() Sets this request's Method to HEAD
Request.Builder	options() Sets this request's Method to OPTIONS
Request.Builder	post() Sets this request's Method to POST
Request.Builder	put() Sets this request's Method to PUT
Request.Builder	setAccept(java.lang.String accept) Sets the Accept header for the request.
Request.Builder	setAttribute(java.lang.String name, java.lang.String value) Sets an attribute on the request.
Request.Builder	setAttributes(java.util.Map<java.lang.String,java.lang.String> properties) Sets attributes on the request.
B	setEntity(Entity entity)
Request.Builder	setEntity(java.lang.String entity)
B	setHeaders(Headers headers) Copies the specified map of HTTP headers into this object.
Request.Builder	setMethod(Request.Method method) Sets this request's Method
Request.Builder	trace() Sets this request's Method to TRACE
Request.Builder	uri(java.net.URI uri) Sets this request's URI.
Request.Builder	url(java.lang.String url) Sets this request's URI.

Method Detail

get

Request.Builder get()

Sets this request's Method to GET

post

Request.Builder post()

Sets this request's Method to POST

put

Request.Builder put()

Sets this request's Method to PUT

delete

Request.Builder delete()

Sets this request's Method to DELETE

options

Request.Builder options()

Sets this request's Method to OPTIONS

head

Request.Builder head()

Sets this request's Method to HEAD

trace

Request.Builder trace()

Sets this request's Method to TRACE

setMethod

Request.Builder setMethod(Request.Method method)

Sets this request's Method

uri

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

Sets this request's URI. Must not be null by the time the request is executed.

url

Request.Builder url(java.lang.String url)

Sets this request's URI. Must not be null by the time the request is executed.

setAccept

Request.Builder setAccept(java.lang.String accept)

Sets the Accept header for the request.

Parameters:

accept - An accept header expression containing media types, ranges, and/or quality factors

setAttribute

Request.Builder setAttribute(java.lang.String name,
                           java.lang.String value)

Sets an attribute on the request. Attributes are request metadata that are forwarded to the analytics plugin when enabled.

Parameters:

name - The attribute name

value - The attribute value

Returns:

This object, for builder-style chaining

setAttributes

Request.Builder setAttributes(java.util.Map<java.lang.String,java.lang.String> properties)

Sets attributes on the request. Attributes are request metadata that are forwarded to the analytics plugin when enabled.

Parameters:

properties - A map of attributes

Returns:

This object, for builder-style chaining

setEntity

Request.Builder setEntity(java.lang.String entity)

setEntity

B setEntity(Entity entity)

setHeaders

B setHeaders(Headers headers)

Copies the specified map of HTTP headers into this object. It will also parse any included Content-Type header into its constituent parts of IANA media type and content charset, updating those properties as appropriate.

Parameters:

headers - A map of HTTP headers

Returns:

This object, for builder-style chaining

build

B build()