Index (jcabi-http 1.0 API)

A B C D F G H I J L M N O P Q R S T U V W X

A

ApacheRequest - Class in com.jcabi.http.request: Implementation of Request, based on Apache HTTP client.
ApacheRequest(URL) - Constructor for class com.jcabi.http.request.ApacheRequest: Public ctor.
ApacheRequest(URI) - Constructor for class com.jcabi.http.request.ApacheRequest: Public ctor.
ApacheRequest(String) - Constructor for class com.jcabi.http.request.ApacheRequest: Public ctor.
as(Class<T>) - Method in interface com.jcabi.http.Response: Convert it to another type, by encapsulation.
assertBody(Matcher<String>) - Method in class com.jcabi.http.response.RestResponse: Verifies HTTP response body content against provided matcher, and throws AssertionError in case of mismatch.
assertHeader(String, Matcher<Iterable<String>>) - Method in class com.jcabi.http.response.RestResponse: Verifies HTTP header against provided matcher, and throws AssertionError in case of mismatch.
assertHeader(String, String) - Method in class com.jcabi.http.response.RestResponse: Verifies HTTP header against provided matcher, and throws AssertionError in case of mismatch.
assertJson(String) - Method in class com.jcabi.http.response.JsonResponse: Verifies the JSON data against the element identifier argument, and throws AssertionError in case of mismatch.
assertStatus(int) - Method in class com.jcabi.http.response.RestResponse: Verifies HTTP response status code against the provided absolute value, and throws AssertionError in case of mismatch.
assertStatus(Matcher<Integer>) - Method in class com.jcabi.http.response.RestResponse: Verifies HTTP response status code against the provided matcher, and throws AssertionError in case of mismatch.
assertThat(Matcher<Response>) - Method in class com.jcabi.http.response.RestResponse: Assert using custom matcher.
assertXPath(String) - Method in class com.jcabi.http.response.XmlResponse: Verifies HTTP response body XHTML/XML content against XPath query, and throws AssertionError in case of mismatch.

B

back() - Method in interface com.jcabi.http.RequestBody: Get back to the request it's related to.
back() - Method in interface com.jcabi.http.RequestURI: Get back to the request it's related to.
back() - Method in interface com.jcabi.http.Response: Get back to the request it's related to.
BasicAuthWire - Class in com.jcabi.http.wire: Wire with HTTP basic authentication based on user info of URI.
BasicAuthWire(Wire) - Constructor for class com.jcabi.http.wire.BasicAuthWire: Public ctor.
binary() - Method in interface com.jcabi.http.Response: Raw body as a an array of bytes.
body() - Method in interface com.jcabi.http.mock.MkAnswer: HTTP response body.
body() - Method in class com.jcabi.http.mock.MkAnswer.Simple
body() - Method in interface com.jcabi.http.mock.MkQuery: HTTP request body.
body() - Method in class com.jcabi.http.request.ApacheRequest
body() - Method in interface com.jcabi.http.Request: Get request body.
body() - Method in class com.jcabi.http.request.FakeRequest
body() - Method in class com.jcabi.http.request.JdkRequest
body() - Method in interface com.jcabi.http.Response: Get body as a string, assuming it's UTF-8 (if there is something else that can't be translated into a UTF-8 string a runtime exception will be thrown).

C

CachingWire - Class in com.jcabi.http.wire: Wire that caches GET requests (for five minutes).
CachingWire(Wire) - Constructor for class com.jcabi.http.wire.CachingWire: Public ctor.
com.jcabi.http - package com.jcabi.http: RESTful client, for tests (but not only).
com.jcabi.http.mock - package com.jcabi.http.mock: Mock of Servlet Container.
com.jcabi.http.request - package com.jcabi.http.request: Requests.
com.jcabi.http.response - package com.jcabi.http.response: Responses.
com.jcabi.http.wire - package com.jcabi.http.wire: Wires.
cookie(String) - Method in class com.jcabi.http.response.RestResponse: Get one cookie by name.
CookieOptimizingWire - Class in com.jcabi.http.wire: Wire that compresses cookies before sending.
CookieOptimizingWire(Wire) - Constructor for class com.jcabi.http.wire.CookieOptimizingWire: Public ctor.

D

DELETE - Static variable in interface com.jcabi.http.Request: DELETE method name.

F

FakeRequest - Class in com.jcabi.http.request: Implementation of Request that always returns the same response, specified in the constructor.
FakeRequest() - Constructor for class com.jcabi.http.request.FakeRequest: Public ctor.
FakeRequest(int, String, Collection<Map.Entry<String, String>>, byte[]) - Constructor for class com.jcabi.http.request.FakeRequest: Public ctor.
fetch() - Method in class com.jcabi.http.request.ApacheRequest
fetch() - Method in class com.jcabi.http.request.FakeRequest
fetch() - Method in interface com.jcabi.http.Request: Execute it with a specified HTTP method.
fetch() - Method in class com.jcabi.http.request.JdkRequest
follow() - Method in class com.jcabi.http.response.RestResponse: Follow LOCATION header.
follow(String) - Method in class com.jcabi.http.response.WebLinkingResponse: Follow link by REL.
formParam(String, Object) - Method in interface com.jcabi.http.RequestBody: Add form param.
formParams(Map<String, String>) - Method in interface com.jcabi.http.RequestBody: Add form params.

G

GET - Static variable in interface com.jcabi.http.Request: GET method name.
get() - Method in interface com.jcabi.http.RequestBody: Get text content.
get() - Method in interface com.jcabi.http.RequestURI: Get URI.
get(Request, String, Collection<Map.Entry<String, String>>, byte[]) - Method in class com.jcabi.http.wire.CachingWire: Fetch GET request and cache it.
getKey() - Method in class com.jcabi.http.ImmutableHeader
getValue() - Method in class com.jcabi.http.ImmutableHeader

H

HEAD - Static variable in interface com.jcabi.http.Request: HEAD method name.
header(String, Object) - Method in class com.jcabi.http.request.ApacheRequest
header(String, Object) - Method in class com.jcabi.http.request.FakeRequest
header(String, Object) - Method in interface com.jcabi.http.Request: Set request header.
header(String, Object) - Method in class com.jcabi.http.request.JdkRequest
headers() - Method in interface com.jcabi.http.mock.MkAnswer: HTTP response headers.
headers() - Method in class com.jcabi.http.mock.MkAnswer.Simple
headers() - Method in interface com.jcabi.http.mock.MkQuery: Headers.
headers() - Method in interface com.jcabi.http.Response: Get a collection of all headers.
home() - Method in interface com.jcabi.http.mock.MkContainer: Get its home.
home() - Method in class com.jcabi.http.mock.MkGrizzlyContainer

I

ImmutableHeader - Class in com.jcabi.http: Immutable HTTP header.
ImmutableHeader(String, String) - Constructor for class com.jcabi.http.ImmutableHeader: Public ctor.

J

JdkRequest - Class in com.jcabi.http.request: Implementation of Request, based on JDK.
JdkRequest(URL) - Constructor for class com.jcabi.http.request.JdkRequest: Public ctor.
JdkRequest(URI) - Constructor for class com.jcabi.http.request.JdkRequest: Public ctor.
JdkRequest(String) - Constructor for class com.jcabi.http.request.JdkRequest: Public ctor.
json() - Method in class com.jcabi.http.response.JsonResponse: Read body as JSON.
JsonResponse - Class in com.jcabi.http.response: JSON response.
JsonResponse(Response) - Constructor for class com.jcabi.http.response.JsonResponse: Public ctor.
jump(URI) - Method in class com.jcabi.http.response.RestResponse: Jump to a new location.

L

links() - Method in class com.jcabi.http.response.WebLinkingResponse: Get all links provided.

M

method() - Method in interface com.jcabi.http.mock.MkQuery: HTTP method.
method(String) - Method in class com.jcabi.http.request.ApacheRequest
method(String) - Method in class com.jcabi.http.request.FakeRequest
method(String) - Method in class com.jcabi.http.request.JdkRequest
method(String) - Method in interface com.jcabi.http.Request: Use this method.
MkAnswer - Interface in com.jcabi.http.mock: Mock response.
MkAnswer.Simple - Class in com.jcabi.http.mock: Simple implementation.
MkAnswer.Simple(String) - Constructor for class com.jcabi.http.mock.MkAnswer.Simple: Public ctor.
MkAnswer.Simple(int, String) - Constructor for class com.jcabi.http.mock.MkAnswer.Simple: Public ctor.
MkAnswer.Simple(int, Iterable<Map.Entry<String, String>>, byte[]) - Constructor for class com.jcabi.http.mock.MkAnswer.Simple: Public ctor.
MkContainer - Interface in com.jcabi.http.mock: Mock version of Java Servlet container.
MkGrizzlyContainer - Class in com.jcabi.http.mock: Implementation of MkContainer based on Grizzly Server.
MkGrizzlyContainer() - Constructor for class com.jcabi.http.mock.MkGrizzlyContainer
MkQuery - Interface in com.jcabi.http.mock: Mock HTTP query/request.

N

next(MkAnswer) - Method in interface com.jcabi.http.mock.MkContainer: Give this answer on the next request.
next(MkAnswer) - Method in class com.jcabi.http.mock.MkGrizzlyContainer
normalize(String) - Static method in class com.jcabi.http.ImmutableHeader: Normalize key.

O

OneMinuteWire - Class in com.jcabi.http.wire: Wire that throws an IOException if a request takes longer than a minute.
OneMinuteWire(Wire) - Constructor for class com.jcabi.http.wire.OneMinuteWire: Public ctor.
OPTIONS - Static variable in interface com.jcabi.http.Request: OPTIONS method name.

P

PATCH - Static variable in interface com.jcabi.http.Request: PATCH method name.
path(String) - Method in interface com.jcabi.http.RequestURI: Add URI path.
POST - Static variable in interface com.jcabi.http.Request: POST method name.
PUT - Static variable in interface com.jcabi.http.Request: PUT method name.

Q

queries() - Method in interface com.jcabi.http.mock.MkContainer: How many queries we have left.
queries() - Method in class com.jcabi.http.mock.MkGrizzlyContainer
queryParam(String, Object) - Method in interface com.jcabi.http.RequestURI: Add query param.
queryParams(Map<String, String>) - Method in interface com.jcabi.http.RequestURI: Add query params.

R

reason() - Method in interface com.jcabi.http.Response: Get status line reason phrase.
registerNs(String, String) - Method in class com.jcabi.http.response.XmlResponse: Register this new namespace.
rel(String) - Method in class com.jcabi.http.response.XmlResponse: Follow XML link.
Request - Interface in com.jcabi.http: RESTful request.
RequestBody - Interface in com.jcabi.http: Request body.
RequestBody.Printable - Class in com.jcabi.http: Printer of byte array.
RequestURI - Interface in com.jcabi.http: Request URI.
reset(String) - Method in class com.jcabi.http.request.ApacheRequest
reset(String) - Method in class com.jcabi.http.request.FakeRequest
reset(String) - Method in class com.jcabi.http.request.JdkRequest
reset(String) - Method in interface com.jcabi.http.Request: Remove all headers with this name.
Response - Interface in com.jcabi.http: RESTful response returned by Request.fetch().
RestResponse - Class in com.jcabi.http.response: REST response.
RestResponse(Response) - Constructor for class com.jcabi.http.response.RestResponse: Public ctor.
RetryWire - Class in com.jcabi.http.wire: Wire that retries a few times before giving up and throwing exception.
RetryWire(Wire) - Constructor for class com.jcabi.http.wire.RetryWire: Public ctor.

S

send(Request, String, String, Collection<Map.Entry<String, String>>, byte[]) - Method in class com.jcabi.http.wire.BasicAuthWire: Send request and return response.
send(Request, String, String, Collection<Map.Entry<String, String>>, byte[]) - Method in class com.jcabi.http.wire.CachingWire: Send request and return response.
send(Request, String, String, Collection<Map.Entry<String, String>>, byte[]) - Method in class com.jcabi.http.wire.CookieOptimizingWire: Send request and return response.
send(Request, String, String, Collection<Map.Entry<String, String>>, byte[]) - Method in class com.jcabi.http.wire.OneMinuteWire: Send request and return response.
send(Request, String, String, Collection<Map.Entry<String, String>>, byte[]) - Method in class com.jcabi.http.wire.RetryWire: Send request and return response.
send(Request, String, String, Collection<Map.Entry<String, String>>, byte[]) - Method in interface com.jcabi.http.Wire: Send request and return response.
send(Request, String, String, Collection<Map.Entry<String, String>>, byte[]) - Method in class com.jcabi.http.wire.UserAgentWire: Send request and return response.
send(Request, String, String, Collection<Map.Entry<String, String>>, byte[]) - Method in class com.jcabi.http.wire.VerboseWire: Send request and return response.
set(String) - Method in interface com.jcabi.http.RequestBody: Set text content.
set(JsonStructure) - Method in interface com.jcabi.http.RequestBody: Set JSON content.
set(byte[]) - Method in interface com.jcabi.http.RequestBody: Set byte array content.
set(URI) - Method in interface com.jcabi.http.RequestURI: Set URI.
setValue(String) - Method in class com.jcabi.http.ImmutableHeader
start() - Method in interface com.jcabi.http.mock.MkContainer: Start it on the first available TCP port.
start(int) - Method in interface com.jcabi.http.mock.MkContainer: Start it on a provided port.
start() - Method in class com.jcabi.http.mock.MkGrizzlyContainer
start(int) - Method in class com.jcabi.http.mock.MkGrizzlyContainer
status() - Method in class com.jcabi.http.mock.MkAnswer.Simple
status() - Method in interface com.jcabi.http.mock.MkAnswer: HTTP response status.
status() - Method in interface com.jcabi.http.Response: Get status of the response as a positive integer number.
stop() - Method in interface com.jcabi.http.mock.MkContainer: Stop container.
stop() - Method in class com.jcabi.http.mock.MkGrizzlyContainer

T

take() - Method in interface com.jcabi.http.mock.MkContainer: Get the oldest request received (NoSuchElementException if no more elements in the list).
take() - Method in class com.jcabi.http.mock.MkGrizzlyContainer
through(Class<T>, Object...) - Method in class com.jcabi.http.request.ApacheRequest
through(Class<T>, Object...) - Method in class com.jcabi.http.request.FakeRequest
through(Class<T>, Object...) - Method in class com.jcabi.http.request.JdkRequest
through(Class<T>, Object...) - Method in interface com.jcabi.http.Request: Send it through a decorating Wire.
toString() - Method in class com.jcabi.http.mock.MkAnswer.Simple
toString() - Method in class com.jcabi.http.request.FakeRequest
toString(byte[]) - Static method in class com.jcabi.http.RequestBody.Printable: Safely print byte array.

U

uri() - Method in interface com.jcabi.http.mock.MkQuery: URI.
uri() - Method in class com.jcabi.http.request.ApacheRequest
uri() - Method in class com.jcabi.http.request.FakeRequest
uri() - Method in class com.jcabi.http.request.JdkRequest
uri() - Method in interface com.jcabi.http.Request: Get destination URI.
uri() - Method in interface com.jcabi.http.response.WebLinkingResponse.Link: Its URI.
UserAgentWire - Class in com.jcabi.http.wire: Wire with default user agent.
UserAgentWire(Wire) - Constructor for class com.jcabi.http.wire.UserAgentWire: Public ctor.
userInfo(String) - Method in interface com.jcabi.http.RequestURI: Set user info.

V

VerboseWire - Class in com.jcabi.http.wire: Verbose wire.
VerboseWire(Wire) - Constructor for class com.jcabi.http.wire.VerboseWire: Public ctor.

W

WebLinkingResponse - Class in com.jcabi.http.response: Web Linking response.
WebLinkingResponse(Response) - Constructor for class com.jcabi.http.response.WebLinkingResponse: Public ctor.
WebLinkingResponse.Link - Interface in com.jcabi.http.response: Single link.
Wire - Interface in com.jcabi.http: Wire.
withBody(String) - Method in class com.jcabi.http.mock.MkAnswer.Simple: Make a copy of this answer, with another body.
withBody(String) - Method in class com.jcabi.http.request.FakeRequest: Make a similar request, with the provided body.
withBody(byte[]) - Method in class com.jcabi.http.request.FakeRequest: Make a similar request, with the provided body.
withHeader(String, String) - Method in class com.jcabi.http.mock.MkAnswer.Simple: Make a copy of this answer, with an extra header.
withHeader(String, String) - Method in class com.jcabi.http.request.FakeRequest: Make a similar request, with the provided HTTP header.
withReason(String) - Method in class com.jcabi.http.request.FakeRequest: Make a similar request, with the provided reason line.
withStatus(int) - Method in class com.jcabi.http.mock.MkAnswer.Simple: Make a copy of this answer, with another status code.
withStatus(int) - Method in class com.jcabi.http.request.FakeRequest: Make a similar request, with the provided status code.

X

xml() - Method in class com.jcabi.http.response.XmlResponse: Get XML body.
XmlResponse - Class in com.jcabi.http.response: XML response.
XmlResponse(Response) - Constructor for class com.jcabi.http.response.XmlResponse: Public ctor.

A B C D F G H I J L M N O P Q R S T U V W X