org.camunda.connect.httpclient

Interface HttpBaseRequest<Q extends HttpBaseRequest<?,?>,R extends ConnectorResponse>

All Superinterfaces:

ConnectorRequest<R>

All Known Subinterfaces:

HttpMethodRequest<Q,R>, HttpRequest

All Known Implementing Classes:

HttpRequestImpl

public interface HttpBaseRequest<Q extends HttpBaseRequest<?,?>,R extends ConnectorResponse>
extends ConnectorRequest<R>

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEADER_CONTENT_TYPE
static String	PARAM_NAME_REQUEST_CONFIG
static String	PARAM_NAME_REQUEST_HEADERS
static String	PARAM_NAME_REQUEST_METHOD
static String	PARAM_NAME_REQUEST_PAYLOAD
static String	PARAM_NAME_REQUEST_URL

Method Summary

Methods

Modifier and Type	Method and Description
Q	configOption(String field, Object value) Set a HTTP request configuration option for this request.
Q	contentType(String contentType) Set the content type header for this request.
Object	getConfigOption(String field)
Map<String,Object>	getConfigOptions()
String	getContentType()
String	getHeader(String field)
Map<String,String>	getHeaders()
String	getMethod()
String	getPayload()
String	getUrl()
Q	header(String field, String value) Set a HTTP header for this request.
Q	method(String method) Sets the method of this request.
Q	payload(String payload) Set the payload of this request.
Q	url(String url) Set the url of this request.

Methods inherited from interface org.camunda.connect.spi.ConnectorRequest

execute, getRequestParameter, getRequestParameters, setRequestParameter, setRequestParameters

Field Detail

PARAM_NAME_REQUEST_URL

static final String PARAM_NAME_REQUEST_URL

See Also:

Constant Field Values

PARAM_NAME_REQUEST_HEADERS

static final String PARAM_NAME_REQUEST_HEADERS

See Also:

Constant Field Values

PARAM_NAME_REQUEST_METHOD

static final String PARAM_NAME_REQUEST_METHOD

See Also:

Constant Field Values

PARAM_NAME_REQUEST_PAYLOAD

static final String PARAM_NAME_REQUEST_PAYLOAD

See Also:

Constant Field Values

HEADER_CONTENT_TYPE

static final String HEADER_CONTENT_TYPE

See Also:

Constant Field Values

PARAM_NAME_REQUEST_CONFIG

static final String PARAM_NAME_REQUEST_CONFIG

See Also:

Constant Field Values

Method Detail

url

Q url(String url)

Set the url of this request.

Parameters:

url - the url to set

Returns:

this request

getUrl

String getUrl()

Returns:

the url of this request or null if none is set

header

Q header(String field,
       String value)

Set a HTTP header for this request.

Parameters:

field - HTTP header field

value - HTTP header value

Returns:

this request

getHeader

String getHeader(String field)

Returns:

the HTTP header field value of this request or null if not set

getHeaders

Map<String,String> getHeaders()

Returns:

the HTTP headers of this request or null if non set

contentType

Q contentType(String contentType)

Set the content type header for this request.

Parameters:

contentType - the content type

Returns:

this request

getContentType

String getContentType()

Returns:

the content-type of this request or null if non set

payload

Q payload(String payload)

Set the payload of this request.

Parameters:

payload - the payload to set

Returns:

this request

getPayload

String getPayload()

Returns:

the payload of this request or null if non set

method

Q method(String method)

Sets the method of this request.

Parameters:

method - the method to set

Returns:

this request

getMethod

String getMethod()

Returns:

the method of this request or null if not set

getConfigOptions

Map<String,Object> getConfigOptions()

Returns:

the HTTP configuration options of this request or null if non set

getConfigOption

Object getConfigOption(String field)

Returns:

the HTTP configuration option value of this request or null if non set

configOption

Q configOption(String field,
             Object value)

Set a HTTP request configuration option for this request.

Parameters:

field - HTTP request configuration name

value - HTTP request configuration value

Returns:

this request