Module com.logicommerce.sdk

Package com.logicommerce.sdk.resources

Interface Connection

public interface Connection

Connection for executing HTTP requests.

Since:

1.0.16

Author:

Logicommerce

Method Summary

Modifier and Type	Method	Description
Connection	acceptType(String acceptType)	Sets an accept type to the request.
Connection	authorization(String authorization)	Adds an authorization header to the request.
Connection	charset(Charset charset)	Defines the response charset in StandardCharsets for the request.
Connection	contentType(String contentType)	Sets a content type to the request.
Connection	cookie(String name, String value)	Adds a cookie to the request.
Response	delete()	Sends a DELETE request.
Response	get()	Sends a GET request.
Connection	header(String name, String value)	Adds a header to the request.
Connection	init(String endPoint)	Initializes the connection.
Connection	params(String params)	Adds a path parameter to the request.
Response	patch(String body)	Sends a PATCH request.
Connection	path(String path)	Defines the path for the request.
Response	post(String body)	Sends a POST request.
Response	put(String body)	Sends a PUT request.
Connection	queryParam(String name, String value)	Adds a query parameter to the request.
Connection	timeout(int timeout)	Defines the timeout in miliseconds for the request.

Method Details

init

Connection init(String endPoint)

Initializes the connection.

Parameters:

endPoint - a String object

Returns:

a Connection object

get

Response get()
      throws PluginResourceException

Sends a GET request.

Returns:

a Response object

Throws:

PluginResourceException - if any.

post

Response post(String body)
       throws PluginResourceException

Sends a POST request.

Parameters:

body - a String object

Returns:

a Response object

Throws:

PluginResourceException - if any.

put

Response put(String body)
      throws PluginResourceException

Sends a PUT request.

Parameters:

body - a String object

Returns:

a Response object

Throws:

PluginResourceException - if any.

patch

Response patch(String body)
        throws PluginResourceException

Sends a PATCH request.

Parameters:

body - a String object

Returns:

a Response object

Throws:

PluginResourceException - if any.

delete

Response delete()
         throws PluginResourceException

Sends a DELETE request.

Returns:

a Response object

Throws:

PluginResourceException - if any.

authorization

Connection authorization(String authorization)

Adds an authorization header to the request.

Parameters:

authorization - a String object

Returns:

a Connection object

path

Connection path(String path)

Defines the path for the request.

Parameters:

path - a String object

Returns:

a Connection object

contentType

Connection contentType(String contentType)

Sets a content type to the request.

Parameters:

contentType - a String object

Returns:

a Connection object

acceptType

Connection acceptType(String acceptType)

Sets an accept type to the request.

Parameters:

acceptType - a String object

Returns:

a Connection object

header

Connection header(String name,
 String value)

Adds a header to the request.

Parameters:

name - a String object

value - a String object

Returns:

a Connection object

cookie

Connection cookie(String name,
 String value)

Adds a cookie to the request.

Parameters:

name - a String object

value - a String object

Returns:

a Connection object

queryParam

Connection queryParam(String name,
 String value)

Adds a query parameter to the request.

Parameters:

name - a String object

value - a String object

Returns:

a Connection object

params

Connection params(String params)

Adds a path parameter to the request.

Parameters:

params - a String object

Returns:

a Connection object

timeout

Connection timeout(int timeout)

Defines the timeout in miliseconds for the request. Default is 3000.

Parameters:

timeout - a int in miliseconds

Returns:

a Connection object.

charset

Connection charset(Charset charset)

Defines the response charset in StandardCharsets for the request. Default is UTF-8.

Parameters:

charset - a java.nio.charset.Charset

Returns:

a Connection object.

Since:

1.3.12