com.jcabi.http.request

Class JdkRequest

java.lang.Object

com.jcabi.http.request.JdkRequest

All Implemented Interfaces:

Request

@Immutable
@Loggable(value=1)
public final class JdkRequest
extends Object
implements Request

Implementation of Request, based on JDK.

This implementation will be enough in most situations. However, sometimes you may need better tuning or an ability to fetch custom HTTP methods (JDK doesn't support PATCH, for example). In this case, use ApacheRequest.

The class is immutable and thread-safe.

Since:

0.8

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

Suppressed Checkstyle violations:

ClassDataAbstractionCoupling (500 lines)

Field Summary

Fields inherited from interface com.jcabi.http.Request

DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT

Constructor Summary

Constructors

Constructor and Description
JdkRequest(String uri) Public ctor.
JdkRequest(URI uri) Public ctor.
JdkRequest(URL url) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
RequestBody	body() Get request body.
Response	fetch() Execute it with a specified HTTP method.
Request	header(String name, Object value) Set request header.
Request	method(String method) Use this method.
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.
RequestURI	uri() Get destination URI.

Methods inherited from class java.lang.Object

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

Constructor Detail

JdkRequest

public JdkRequest(@NotNull(message="URL can\'t be NULL")
          URL url)

Public ctor.

Parameters:

url - The resource to work with

JdkRequest

public JdkRequest(@NotNull(message="URI can\'t be NULL")
          URI uri)

Public ctor.

Parameters:

uri - The resource to work with

JdkRequest

public JdkRequest(@NotNull(message="URI can\'t be NULL")
          String uri)

Public ctor.

Parameters:

uri - The resource to work with

Method Detail

uri

@NotNull
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(@NotNull(message="header name can\'t be NULL")
             String name,
             @NotNull(message="header value can\'t be NULL")
             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(@NotNull(message="header name can\'t be NULL")
            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

method

public Request method(@NotNull(message="method can\'t be NULL")
             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

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

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