Package org.camunda.connect.httpclient
Interface HttpBaseRequest<Q extends HttpBaseRequest<?,?>,R extends ConnectorResponse>
- All Superinterfaces:
ConnectorRequest<R>
- All Known Subinterfaces:
HttpMethodRequest<Q,
,R> HttpRequest
,SoapHttpRequest
- All Known Implementing Classes:
HttpRequestImpl
,SoapHttpRequestImpl
public interface HttpBaseRequest<Q extends HttpBaseRequest<?,?>,R extends ConnectorResponse>
extends ConnectorRequest<R>
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionconfigOption
(String field, Object value) Set a HTTP request configuration option for this request.contentType
(String contentType) Set the content type header for this request.getConfigOption
(String field) getUrl()
Set a HTTP header for this request.Sets the method of this request.Set the payload of this request.Set the url of this request.Methods inherited from interface org.camunda.connect.spi.ConnectorRequest
execute, getRequestParameter, getRequestParameters, setRequestParameter, setRequestParameters
-
Field Details
-
PARAM_NAME_REQUEST_URL
- See Also:
-
PARAM_NAME_REQUEST_HEADERS
- See Also:
-
PARAM_NAME_REQUEST_METHOD
- See Also:
-
PARAM_NAME_REQUEST_PAYLOAD
- See Also:
-
HEADER_CONTENT_TYPE
- See Also:
-
PARAM_NAME_REQUEST_CONFIG
- See Also:
-
-
Method Details
-
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
Set a HTTP header for this request.- Parameters:
field
- HTTP header fieldvalue
- HTTP header value- Returns:
- this request
-
getHeader
- Returns:
- the HTTP header field value of this request or null if not set
-
getHeaders
- Returns:
- the HTTP headers of this request or null if non set
-
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
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
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
- Returns:
- the HTTP configuration options of this request or null if non set
-
getConfigOption
- Returns:
- the HTTP configuration option value of this request or null if non set
-
configOption
Set a HTTP request configuration option for this request.- Parameters:
field
- HTTP request configuration namevalue
- HTTP request configuration value- Returns:
- this request
-