Package org.camunda.connect.httpclient

Interface HttpBaseRequest<Q extends HttpBaseRequest<?,​?>,​R extends org.camunda.connect.spi.ConnectorResponse>

  • All Superinterfaces:
    org.camunda.connect.spi.ConnectorRequest<R>
    All Known Subinterfaces:
    HttpMethodRequest<Q,​R>, HttpRequest
    All Known Implementing Classes:
    HttpRequestImpl
    public interface HttpBaseRequest<Q extends HttpBaseRequest<?,​?>,​R extends org.camunda.connect.spi.ConnectorResponse>
extends org.camunda.connect.spi.ConnectorRequest<R>

    • Field Detail

      • PARAM_NAME_REQUEST_URL

        static final java.lang.String PARAM_NAME_REQUEST_URL
        See Also:
        Constant Field Values

      • PARAM_NAME_REQUEST_HEADERS

        static final java.lang.String PARAM_NAME_REQUEST_HEADERS
        See Also:
        Constant Field Values

      • PARAM_NAME_REQUEST_METHOD

        static final java.lang.String PARAM_NAME_REQUEST_METHOD
        See Also:
        Constant Field Values

      • PARAM_NAME_REQUEST_PAYLOAD

        static final java.lang.String PARAM_NAME_REQUEST_PAYLOAD
        See Also:
        Constant Field Values

      • PARAM_NAME_REQUEST_CONFIG

        static final java.lang.String PARAM_NAME_REQUEST_CONFIG
        See Also:
        Constant Field Values

    • Method Detail

      • url

        Q url​(java.lang.String url)
        Set the url of this request.
        Parameters:
        url - the url to set
        Returns:
        this request

      • getUrl

        java.lang.String getUrl()
        Returns:
        the url of this request or null if none is set

      • header

        Q header​(java.lang.String field,
         java.lang.String value)
        Set a HTTP header for this request.
        Parameters:
        field - HTTP header field
        value - HTTP header value
        Returns:
        this request

      • getHeader

        java.lang.String getHeader​(java.lang.String field)
        Returns:
        the HTTP header field value of this request or null if not set

      • getHeaders

        java.util.Map<java.lang.String,​java.lang.String> getHeaders()
        Returns:
        the HTTP headers of this request or null if non set

      • contentType

        Q contentType​(java.lang.String contentType)
        Set the content type header for this request.
        Parameters:
        contentType - the content type
        Returns:
        this request

      • getContentType

        java.lang.String getContentType()
        Returns:
        the content-type of this request or null if non set

      • payload

        Q payload​(java.lang.String payload)
        Set the payload of this request.
        Parameters:
        payload - the payload to set
        Returns:
        this request

      • getPayload

        java.lang.String getPayload()
        Returns:
        the payload of this request or null if non set

      • method

        Q method​(java.lang.String method)
        Sets the method of this request.
        Parameters:
        method - the method to set
        Returns:
        this request

      • getMethod

        java.lang.String getMethod()
        Returns:
        the method of this request or null if not set

      • getConfigOptions

        java.util.Map<java.lang.String,​java.lang.Object> getConfigOptions()
        Returns:
        the HTTP configuration options of this request or null if non set

      • getConfigOption

        java.lang.Object getConfigOption​(java.lang.String field)
        Returns:
        the HTTP configuration option value of this request or null if non set

      • configOption

        Q configOption​(java.lang.String field,
               java.lang.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