BaseRequest (jcabi-http 1.17.2 API)

java.lang.Object
- com.jcabi.http.request.BaseRequest

All Implemented Interfaces:

Request
```
@Immutable
@Loggable(value=1)
public final class BaseRequest
extends Object
implements Request
```
Base implementation of Request.

Since:

0.8

Version:

$Id: ccdf183949267463e8c347a7de69fc4b8018bfbe $

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:
Request, Response
To do:

#87:30min Refactor this class to get rid of PMD.GodClass. This can be done if MultiPartFormBody and FormEncodedBody are pulled out. Also, the two share the same implementations for all methods besides formParam, so they can be refactored to extend an AbstractRequestBody. PMD.TooManyMethods might come together with getting rid of the first one, since maybe qulice is counting the methods in the inner classes too - if it doesn't, then it can be left.

Suppressed Checkstyle violations:

ClassDataAbstractionCoupling (500 lines)

Field Summary
- Fields inherited from interface com.jcabi.http.Request
  DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT

Method Summary

Methods
Modifier and Type	Method and Description
`RequestBody`	`body()` Get request body.
`Response`	`fetch()` Execute it with a specified HTTP method.
`Response`	`fetch(InputStream stream)` Execute this request using the content provided by the `InputStream` being passed as the request body.
`Request`	`header(String name, Object value)` Set request header.
`Request`	`method(String method)` Use this method.
`RequestBody`	`multipartBody()` Get multipart form (multipart/form-data) body.
`Request`	`reset(String name)` Remove all headers with this name.
`<T extends Wire> Request`	`through(Class<T> type, Object... args)` Send it through a decorating `Wire`.
`Request`	`timeout(int cnct, int rdd)` Use this timeout values.
`String`	`toString()`
`RequestURI`	`uri()` Get destination URI.

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

- Method Detail
  - uri
```
public RequestURI uri()
```
    Description copied from interface: Request
    
    Get destination URI.
    
    Specified by:
    
    uri in interface Request
    
    Returns:
    The destination it is currently pointing to
  - header
```
public Request header(String name,
             Object value)
```
    Description copied from interface: Request
    
    Set request header.
    
    Specified by:
    
    header in interface Request
    
    Parameters:
    name - ImmutableHeader name
    value - Value of the header to set
    
    Returns:
    New alternated request
  - reset
```
public Request reset(String name)
```
    Description copied from interface: Request
    
    Remove all headers with this name.
    
    Specified by:
    
    reset in interface Request
    
    Parameters:
    name - ImmutableHeader name
    
    Returns:
    New alternated request
  - body
```
public RequestBody body()
```
    Description copied from interface: Request
    
    Get request body.
    
    Specified by:
    
    body in interface Request
    
    Returns:
    New alternated request
  - multipartBody
```
public RequestBody multipartBody()
```
    Description copied from interface: Request
    
    Get multipart form (multipart/form-data) body.
    
    Specified by:
    
    multipartBody in interface Request
    
    Returns:
    New altered request
  - method
```
public Request method(String method)
```
    Description copied from interface: Request
    
    Use this method.
    
    Specified by:
    
    method in interface Request
    
    Parameters:
    method - The method to use
    
    Returns:
    New alternated request
  - timeout
```
public Request timeout(int cnct,
              int rdd)
```
    Description copied from interface: Request
    
    Use this timeout values.
    
    Specified by:
    
    timeout in interface Request
    
    Parameters:
    cnct - The connect timeout to use in ms
    rdd - The read timeout to use in ms
    
    Returns:
    New alternated request
  - fetch
```
public Response fetch()
               throws IOException
```
    Description copied from interface: Request
    
    Execute it with a specified HTTP method.
    
    Specified by:
    
    fetch in interface Request
    
    Returns:
    Response
    
    Throws:
    
    IOException - If fails to fetch HTTP request
  - fetch
```
public Response fetch(InputStream stream)
               throws IOException
```
    Description copied from interface: Request
    
    Execute this request using the content provided by the InputStream being passed as the request body. Note that the request MUST have an empty body when this method is being invoked, or it will throw an IllegalStateException.
    
    Specified by:
    
    fetch in interface Request
    
    Parameters:
    stream - The input stream to use
    
    Returns:
    Response
    
    Throws:
    
    IOException - If fails to fetch HTTP request
  - through
```
public <T extends Wire> Request through(Class<T> type,
                               Object... args)
```
    Description copied from interface: Request
    
    Send it through a decorating Wire.
    
    Specified by:
    
    through in interface Request
    
    Type Parameters:
    T - Type to use
    Parameters:
    type - Type of wire to use
    args - Optional arguments for the wire constructor
    
    Returns:
    New request with a wire decorated
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BaseRequest

Field Summary

Fields inherited from interface com.jcabi.http.Request

Method Summary

Methods inherited from class java.lang.Object

Method Detail

uri

header

reset

body

multipartBody

method

timeout

fetch

fetch

through

toString