com.jsunsoft.http

Interface HttpRequest

public interface HttpRequest

HttpRequest is the main entry point to the API used to build and execute client requests.

HttpRequest objects are immutable they can be shared.

Method Summary

Modifier and Type	Method and Description
WebTarget	immutableTarget(String uri)
WebTarget	immutableTarget(URI uri)
WebTarget	retryableTarget(String uri, RetryContext retryContext)
WebTarget	retryableTarget(URI uri, RetryContext retryContext)
WebTarget	target(String uri) Build a new web resource target.
WebTarget	target(URI uri) Build a new web resource target.

Method Detail

target

WebTarget target(URI uri)

Build a new web resource target.

Parameters:

uri - web resource URI. Must not be null.

Returns:

web resource target bound to the provided URI.

Throws:

NullPointerException - in case the supplied argument is null.

target

WebTarget target(String uri)

Build a new web resource target.

Parameters:

uri - The string to be parsed into a URI

Returns:

Target instance

Throws:

NullPointerException - If str is null

IllegalArgumentException - If the given string violates RFC 2396

retryableTarget

@Beta
WebTarget retryableTarget(URI uri,
                                RetryContext retryContext)

Parameters:

uri - web resource URI. Must not be null.

retryContext - retryContext. Must not be null.

Returns:

Retryable WebTarget instance

Throws:

NullPointerException - in case the supplied argument is null.

retryableTarget

@Beta
WebTarget retryableTarget(String uri,
                                RetryContext retryContext)

Parameters:

uri - The string to be parsed into a URI

retryContext - retryContext. Must not be null.

Returns:

Retryable WebTarget instance

Throws:

NullPointerException - If str is null

IllegalArgumentException - If the given string violates RFC 2396

immutableTarget

@Beta
WebTarget immutableTarget(URI uri)

Parameters:

uri - web resource URI. Must not be null.

Returns:

Immutable WebTarget instance. Can be shared between threads.

Throws:

NullPointerException - in case the supplied argument is null.

immutableTarget

@Beta
WebTarget immutableTarget(String uri)

Parameters:

uri - The string to be parsed into a URI

Returns:

Immutable WebTarget instance. Can be shared between threads.

Throws:

NullPointerException - If str is null

IllegalArgumentException - If the given string violates RFC 2396