DefaultRequest.DefaultRequestBuilder (Atlassian HttpClientProject 1.0.3 API)

java.lang.Object
- com.atlassian.httpclient.apache.httpcomponents.DefaultRequest.DefaultRequestBuilder

All Implemented Interfaces:

Buildable<Request>, Common<Request.Builder>, Request.Builder

Enclosing class:

DefaultRequest
```
public static class DefaultRequest.DefaultRequestBuilder
extends Object
implements Request.Builder
```

Constructor Summary

Constructors
Constructor and Description

DefaultRequestBuilder(HttpClient httpClient)

Constructors
Constructor and Description
`DefaultRequestBuilder(HttpClient httpClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DefaultRequest`	`build()`
`ResponsePromise`	`delete()` Executes this request through the `HttpClient` service as a `DELETE` operation.
`ResponsePromise`	`execute(Request.Method method)` Executes this request through the `HttpClient` service using the given HTTP method.
`ResponsePromise`	`get()` Executes this request through the `HttpClient` service as a `GET` operation.
`ResponsePromise`	`head()` Executes this request through the `HttpClient` service as a `HEAD` operation.
`ResponsePromise`	`options()` Executes this request through the `HttpClient` service as a `OPTIONS` operation.
`ResponsePromise`	`post()` Executes this request through the `HttpClient` service as a `POST` operation.
`ResponsePromise`	`put()` Executes this request through the `HttpClient` service as a `PUT` operation.
`DefaultRequest.DefaultRequestBuilder`	`setAccept(String accept)` Sets the Accept header for the request.
`DefaultRequest.DefaultRequestBuilder`	`setAttribute(String name, String value)` Sets an attribute on the request.
`DefaultRequest.DefaultRequestBuilder`	`setAttributes(Map<String,String> properties)` Sets attributes on the request.
`DefaultRequest.DefaultRequestBuilder`	`setCacheDisabled()` Bypasses the cache for this request
`DefaultRequest.DefaultRequestBuilder`	`setContentCharset(String contentCharset)` Sets the charset for this object's entity, if any.
`DefaultRequest.DefaultRequestBuilder`	`setContentLength(long contentLength)` Set the content length for the message.
`DefaultRequest.DefaultRequestBuilder`	`setContentType(String contentType)` Sets the IANA media type, for the current entity, if any.
`DefaultRequest.DefaultRequestBuilder`	`setEntity(EntityBuilder entityBuilder)` Sets the entity and any associated headers from an entity builder.
`DefaultRequest.DefaultRequestBuilder`	`setEntity(String entity)` Sets this object's entity stream from a string.
`DefaultRequest.DefaultRequestBuilder`	`setEntityStream(InputStream entityStream)` Sets this object's entity as an input stream.
`DefaultRequest.DefaultRequestBuilder`	`setEntityStream(InputStream entityStream, String charset)` Sets this object's entity as an input stream, encoded with the specified charset.
`DefaultRequest.DefaultRequestBuilder`	`setHeader(String name, String value)` Sets an HTTP header on this object.
`DefaultRequest.DefaultRequestBuilder`	`setHeaders(Map<String,String> headers)` Copies the specified map of HTTP headers into this object.
`void`	`setMethod(Request.Method method)`
`DefaultRequest.DefaultRequestBuilder`	`setUri(URI uri)` Sets this request's URI.
`ResponsePromise`	`trace()` Executes this request through the `HttpClient` service as a `TRACE` operation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultRequestBuilder
```
public DefaultRequestBuilder(HttpClient httpClient)
```
- Method Detail
  - setUri
```
public DefaultRequest.DefaultRequestBuilder setUri(URI uri)
```
    Description copied from interface: Request.Builder
    
    Sets this request's URI. Must not be null by the time the request is executed.
    
    Specified by:
    
    setUri in interface Request.Builder
    
    Parameters:
    
    uri - The URI
    
    Returns:
    
    This object, for builder-style chaining
  - setAccept
```
public DefaultRequest.DefaultRequestBuilder setAccept(String accept)
```
    Description copied from interface: Request.Builder
    
    Sets the Accept header for the request.
    
    Specified by:
    
    setAccept in interface Request.Builder
    
    Parameters:
    
    accept - An accept header expression containing media types, ranges, and/or quality factors
    
    Returns:
    
    This object, for builder-style chaining
  - setCacheDisabled
```
public DefaultRequest.DefaultRequestBuilder setCacheDisabled()
```
    Description copied from interface: Request.Builder
    
    Bypasses the cache for this request
    
    Specified by:
    
    setCacheDisabled in interface Request.Builder
    
    Returns:
    
    This object, for builder-style chaining
  - setAttribute
```
public DefaultRequest.DefaultRequestBuilder setAttribute(String name,
                                                         String value)
```
    Description copied from interface: Request.Builder
    
    Sets an attribute on the request. Attributes are request metadata that are forwarded to the analytics plugin when enabled.
    
    Specified by:
    
    setAttribute in interface Request.Builder
    
    Parameters:
    
    name - The attribute name
    
    value - The attribute value
    
    Returns:
    
    This object, for builder-style chaining
  - setAttributes
```
public DefaultRequest.DefaultRequestBuilder setAttributes(Map<String,String> properties)
```
    Description copied from interface: Request.Builder
    
    Sets attributes on the request. Attributes are request metadata that are forwarded to the analytics plugin when enabled.
    
    Specified by:
    
    setAttributes in interface Request.Builder
    
    Parameters:
    
    properties - A map of attributes
    
    Returns:
    
    This object, for builder-style chaining
  - setEntity
```
public DefaultRequest.DefaultRequestBuilder setEntity(EntityBuilder entityBuilder)
```
    Description copied from interface: Request.Builder
    
    Sets the entity and any associated headers from an entity builder.
    
    Specified by:
    
    setEntity in interface Request.Builder
    
    Parameters:
    
    entityBuilder - An entity builder
    
    Returns:
    
    This object, for builder-style chaining
  - setHeader
```
public DefaultRequest.DefaultRequestBuilder setHeader(String name,
                                                      String value)
```
    Description copied from interface: Common
    
    Sets an HTTP header on this object. If the header's name is "Content-Type", the value will be parsed into this object's content type and content charset properties, as appropriate.
    
    Specified by:
    
    setHeader in interface Common<Request.Builder>
    
    Specified by:
    
    setHeader in interface Request.Builder
    
    Parameters:
    
    name - The name of the header to be set
    
    value - The value of the header to be set
    
    Returns:
    
    This object, for builder-style chaining
  - setHeaders
```
public DefaultRequest.DefaultRequestBuilder setHeaders(Map<String,String> headers)
```
    Description copied from interface: Common
    
    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.
    
    Specified by:
    
    setHeaders in interface Common<Request.Builder>
    
    Parameters:
    
    headers - A map of HTTP headers
    
    Returns:
    
    This object, for builder-style chaining
  - setEntity
```
public DefaultRequest.DefaultRequestBuilder setEntity(String entity)
```
    Description copied from interface: Common
    
    Sets this object's entity stream from a string. Using this method of setting the entity automatically sets this object's content charset property to "UTF-8" if the entity is not null.
    
    Specified by:
    
    setEntity in interface Common<Request.Builder>
    
    Parameters:
    
    entity - An entity string
    
    Returns:
    
    This object, for builder-style chaining
  - setEntityStream
```
public DefaultRequest.DefaultRequestBuilder setEntityStream(InputStream entityStream)
```
    Description copied from interface: Common
    
    Sets this object's entity as an input stream. Invocations of this method reset this object's hasReadEntity() state to false. It is recommended to also set this object's content charset property when setting an entity stream for a textual media type (or using the overloaded form that takes both the entity stream and charset in the same call). Clients of this object should assume the HTTP standard of ISO-8859-1 (latin-1) for the content charset property if a textual media type is set but no explcit charset was provided for this message. A charset should NOT be provided for entity streams targetting binary media types.
    
    Specified by:
    
    setEntityStream in interface Common<Request.Builder>
    
    Parameters:
    
    entityStream - An entity input stream ready to be read
    
    Returns:
    
    This object, for builder-style chaining
  - setContentCharset
```
public DefaultRequest.DefaultRequestBuilder setContentCharset(String contentCharset)
```
    Description copied from interface: Common
    
    Sets the charset for this object's entity, if any. This value is ignored during headeer access if no entity is present or if the content type property is not set.
    
    Specified by:
    
    setContentCharset in interface Common<Request.Builder>
    
    Parameters:
    
    contentCharset - The entity's charset value, or null
    
    Returns:
    
    This object, for builder-style chaining
  - setContentType
```
public DefaultRequest.DefaultRequestBuilder setContentType(String contentType)
```
    Description copied from interface: Common
    
    Sets the IANA media type, for the current entity, if any. If the contentType argument also contains charset information, this method will have the side effect of parsing the charset out and storing the component parts independently. The method getContentCharset() can be used to retrieve extracted content charset, if present, and getHeader("Content-Type") can be used to retrieve the entire Content-Type header, complete with charset information, if set. The content type property is required when an entity is present.
    
    Specified by:
    
    setContentType in interface Common<Request.Builder>
    
    Parameters:
    
    contentType - An IANA media type with optional charset information
    
    Returns:
    
    This object, for builder-style chaining
  - setEntityStream
```
public DefaultRequest.DefaultRequestBuilder setEntityStream(InputStream entityStream,
                                                            String charset)
```
    Description copied from interface: Common
    
    Sets this object's entity as an input stream, encoded with the specified charset. Invocations of this method reset this object's hasReadEntity() state to false. This method should only be called for entity streams targetting textual media types -- that is, it's nonsensical to set the charset of an entity stream for binary media types (e.g. image/*, etc).
    
    Specified by:
    
    setEntityStream in interface Common<Request.Builder>
    
    Parameters:
    
    entityStream - An entity input stream ready to be read
    
    charset - The charset in which the entity stream is encoded
    
    Returns:
    
    This object, for builder-style chaining
  - setContentLength
```
public DefaultRequest.DefaultRequestBuilder setContentLength(long contentLength)
```
    Description copied from interface: Request.Builder
    
    Set the content length for the message. Use this to explicitly override the content length determined from the entity in the message (e.g. if you want to stream the entity without chunking).
    
    Specified by:
    
    setContentLength in interface Request.Builder
    
    Parameters:
    
    contentLength - The content length. This must be valid (greater than 0).
    
    Returns:
    
    This object, for builder-style chaining
  - build
```
public DefaultRequest build()
```
    Specified by:
    
    build in interface Buildable<Request>
  - get
```
public ResponsePromise get()
```
    Description copied from interface: Request.Builder
    
    Executes this request through the HttpClient service as a GET operation. The request SHOULD NOT contain an entity for the GET operation.
    
    Specified by:
    
    get in interface Request.Builder
    
    Returns:
    
    A promise object that can be used to receive the response and handle exceptions
  - post
```
public ResponsePromise post()
```
    Description copied from interface: Request.Builder
    
    Executes this request through the HttpClient service as a POST operation. The request SHOULD contain an entity for the POST operation.
    
    Specified by:
    
    post in interface Request.Builder
    
    Returns:
    
    A promise object that can be used to receive the response and handle exceptions
  - put
```
public ResponsePromise put()
```
    Description copied from interface: Request.Builder
    
    Executes this request through the HttpClient service as a PUT operation. The request SHOULD contain an entity for the PUT operation.
    
    Specified by:
    
    put in interface Request.Builder
    
    Returns:
    
    A promise object that can be used to receive the response and handle exceptions
  - delete
```
public ResponsePromise delete()
```
    Description copied from interface: Request.Builder
    
    Executes this request through the HttpClient service as a DELETE operation. The request SHOULD NOT contain an entity for the DELETE operation.
    
    Specified by:
    
    delete in interface Request.Builder
    
    Returns:
    
    A promise object that can be used to receive the response and handle exceptions
  - options
```
public ResponsePromise options()
```
    Description copied from interface: Request.Builder
    
    Executes this request through the HttpClient service as a OPTIONS operation. The request MAY contain an entity for the OPTIONS operation.
    
    Specified by:
    
    options in interface Request.Builder
    
    Returns:
    
    A promise object that can be used to receive the response and handle exceptions
  - head
```
public ResponsePromise head()
```
    Description copied from interface: Request.Builder
    
    Executes this request through the HttpClient service as a HEAD operation. The request SHOULD NOT contain an entity for the HEAD operation.
    
    Specified by:
    
    head in interface Request.Builder
    
    Returns:
    
    A promise object that can be used to receive the response and handle exceptions
  - trace
```
public ResponsePromise trace()
```
    Description copied from interface: Request.Builder
    
    Executes this request through the HttpClient service as a TRACE operation. The request SHOULD contain an entity for the TRACE operation.
    
    Specified by:
    
    trace in interface Request.Builder
    
    Returns:
    
    A promise object that can be used to receive the response and handle exceptions
  - execute
```
public ResponsePromise execute(Request.Method method)
```
    Description copied from interface: Request.Builder
    
    Executes this request through the HttpClient service using the given HTTP method.
    
    Specified by:
    
    execute in interface Request.Builder
    
    Parameters:
    
    method - the HTTP method to use.
    
    Returns:
    
    A promise object that can be used to receive the response and handle exceptions
  - setMethod
```
public void setMethod(Request.Method method)
```

Class DefaultRequest.DefaultRequestBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultRequestBuilder

Method Detail

setUri

setAccept

setCacheDisabled

setAttribute

setAttributes

setEntity

setHeader

setHeaders

setEntity

setEntityStream

setContentCharset

setContentType

setEntityStream

setContentLength

build

get

post

put

delete

options

head

trace

execute

setMethod