Package com.persequor.extension.rest

Interface IHttpClient

public interface IHttpClient

Method Summary

Modifier and Type	Method	Description
HttpResponse	delete(String path, HttpHeaders headers)	Send a HTTP DELETE request to the specified URL
HttpResponse	delete(String path, HttpHeaders headers, IRequestConfig config)	Send a HTTP DELETE request to the specified URL
HttpResponse	get(String path, HttpHeaders headers)	Send a HTTP GET request to the specified URL
HttpResponse	get(String path, HttpHeaders headers, IRequestConfig config)	Send a HTTP GET request to the specified URL
HttpResponse	head(String path, HttpHeaders headers)	Send a HTTP HEAD request to the specified URL
HttpResponse	head(String path, HttpHeaders headers, IRequestConfig config)	Send a HTTP HEAD request to the specified URL
HttpResponse	patch(String path, HttpContent content, HttpHeaders headers)	Send a HTTP PATCH request to the specified URL
HttpResponse	patch(String path, HttpContent content, HttpHeaders headers, IRequestConfig config)	Send a HTTP PATCH request to the specified URL
HttpResponse	post(String path, Model content, HttpHeaders headers)	Send a HTTP POST request to the specified URL.
HttpResponse	post(String path, Model content, HttpHeaders headers, IRequestConfig config)	Send a HTTP POST request to the specified URL.
HttpResponse	post(String path, HttpContent content, HttpHeaders headers)	Send a HTTP POST request to the specified URL
HttpResponse	post(String path, HttpContent content, HttpHeaders headers, IRequestConfig config)	Send a HTTP POST request to the specified URL
HttpResponse	put(String path, HttpContent content, HttpHeaders headers)	Send a HTTP PUT request to the specified URL
HttpResponse	put(String path, HttpContent content, HttpHeaders headers, IRequestConfig config)	Send a HTTP PUT request to the specified URL
void	setAdditionalConfig(AdditionalHttpClientConfig additionalConfig)

Method Details

get

HttpResponse get(String path,
 HttpHeaders headers,
 IRequestConfig config)
          throws IOException,
HttpResponseException

Send a HTTP GET request to the specified URL

Parameters:

path - URL of the endpoint

headers - request header object

config - request specific config

Returns:

the endpoint's response to the request

Throws:

IOException - throws IOException in case of failure to construct an URL or send the request

HttpResponseException

See Also:

• HttpHeaders
• HttpResponse

get

HttpResponse get(String path,
 HttpHeaders headers)
          throws IOException,
HttpResponseException

Send a HTTP GET request to the specified URL

Parameters:

path - URL of the endpoint

headers - request header object

Returns:

the endpoint's response to the request

Throws:

IOException - throws IOException in case of failure to construct an URL or send the request

HttpResponseException

See Also:

• HttpHeaders
• HttpResponse

post

HttpResponse post(String path,
 HttpContent content,
 HttpHeaders headers,
 IRequestConfig config)
           throws IOException,
HttpResponseException

Send a HTTP POST request to the specified URL

Parameters:

path - URL of the endpoint

content - request body

config - request specific config

headers - request header object

Returns:

the endpoint's response to the request

Throws:

IOException - throws IOException in case of failure to construct an URL or send the request

HttpResponseException

See Also:

• HttpContent
• HttpHeaders
• HttpResponse

post

HttpResponse post(String path,
 HttpContent content,
 HttpHeaders headers)
           throws IOException,
HttpResponseException

Send a HTTP POST request to the specified URL

Parameters:

path - URL of the endpoint

content - request body

headers - request header object

Returns:

the endpoint's response to the request

Throws:

IOException - throws IOException in case of failure to construct an URL or send the request

HttpResponseException

See Also:

• HttpContent
• HttpHeaders
• HttpResponse

post

HttpResponse post(String path,
 Model content,
 HttpHeaders headers,
 IRequestConfig config)
           throws IOException,
HttpResponseException,
SerializationException

Send a HTTP POST request to the specified URL. This method is specifically intended to support EPCIS models

Parameters:

path - URL of the endpoint

content - request body

config - request specific config

headers - request header object

Returns:

the endpoint's response to the request

Throws:

IOException - throws IOException in case of failure to construct an URL or send the request

SerializationException - throws SerializationException if content could not be serialized to a String

HttpResponseException

See Also:

• BaseEpcisDocument
• HttpHeaders
• HttpResponse

post

HttpResponse post(String path,
 Model content,
 HttpHeaders headers)
           throws IOException,
HttpResponseException,
SerializationException

Send a HTTP POST request to the specified URL. This method is specifically intended to support EPCIS models

Parameters:

path - URL of the endpoint

content - request body

headers - request header object

Returns:

the endpoint's response to the request

Throws:

IOException - throws IOException in case of failure to construct an URL or send the request

SerializationException - throws SerializationException if content could not be serialized to a String

HttpResponseException

See Also:

• BaseEpcisDocument
• HttpHeaders
• HttpResponse

delete

HttpResponse delete(String path,
 HttpHeaders headers,
 IRequestConfig config)
             throws IOException,
HttpResponseException

Send a HTTP DELETE request to the specified URL

Parameters:

path - URL

headers - request header object

config - request specific config

Returns:

the endpoint's response to the request

Throws:

IOException - throws IOException in case of failure to construct an URL or send the request

HttpResponseException

See Also:

• HttpHeaders
• HttpResponse

delete

HttpResponse delete(String path,
 HttpHeaders headers)
             throws IOException,
HttpResponseException

Send a HTTP DELETE request to the specified URL

Parameters:

path - URL

headers - request header object

Returns:

the endpoint's response to the request

Throws:

IOException - throws IOException in case of failure to construct an URL or send the request

HttpResponseException

See Also:

• HttpHeaders
• HttpResponse

put

HttpResponse put(String path,
 HttpContent content,
 HttpHeaders headers,
 IRequestConfig config)
          throws IOException,
HttpResponseException

Send a HTTP PUT request to the specified URL

Parameters:

path - URL of the endpoint

content - request body

config - request specific config

headers - request header object

Returns:

the endpoint's response to the request

Throws:

IOException - throws IOException in case of failure to construct an URL or send the request

HttpResponseException

See Also:

• HttpContent
• HttpHeaders
• HttpResponse

put

HttpResponse put(String path,
 HttpContent content,
 HttpHeaders headers)
          throws IOException,
HttpResponseException

Send a HTTP PUT request to the specified URL

Parameters:

path - URL of the endpoint

content - request body

headers - request header object

Returns:

the endpoint's response to the request

Throws:

IOException - throws IOException in case of failure to construct an URL or send the request

HttpResponseException

See Also:

• HttpContent
• HttpHeaders
• HttpResponse

patch

HttpResponse patch(String path,
 HttpContent content,
 HttpHeaders headers,
 IRequestConfig config)
            throws IOException,
HttpResponseException

Send a HTTP PATCH request to the specified URL

Parameters:

path - URL of the endpoint

content - request body

config - request specific config

headers - request header object

Returns:

the endpoint's response to the request

Throws:

IOException - throws IOException in case of failure to construct an URL or send the request

HttpResponseException

See Also:

• HttpContent
• HttpHeaders
• HttpResponse

patch

HttpResponse patch(String path,
 HttpContent content,
 HttpHeaders headers)
            throws IOException,
HttpResponseException

Send a HTTP PATCH request to the specified URL

Parameters:

path - URL of the endpoint

content - request body

headers - request header object

Returns:

the endpoint's response to the request

Throws:

IOException - throws IOException in case of failure to construct an URL or send the request

HttpResponseException

See Also:

• HttpContent
• HttpHeaders
• HttpResponse

head

HttpResponse head(String path,
 HttpHeaders headers,
 IRequestConfig config)
           throws IOException,
HttpResponseException

Send a HTTP HEAD request to the specified URL

Parameters:

path - URL of the endpoint

headers - request header object

config - request specific config

Returns:

the endpoint's response to the request

Throws:

IOException - throws IOException in case of failure to construct an URL or send the request

HttpResponseException

See Also:

• HttpHeaders
• HttpResponse

head

HttpResponse head(String path,
 HttpHeaders headers)
           throws IOException,
HttpResponseException

Send a HTTP HEAD request to the specified URL

Parameters:

path - URL of the endpoint

headers - request header object

Returns:

the endpoint's response to the request

Throws:

IOException - throws IOException in case of failure to construct an URL or send the request

HttpResponseException

See Also:

• HttpHeaders
• HttpResponse

setAdditionalConfig

void setAdditionalConfig(AdditionalHttpClientConfig additionalConfig)