Field Detail

• public java.lang.String userAgent

Property Detail

• static FWLog fwLog

• java.util.List<RequestHook> hooks

  List of hooks that should be called on a request before sending.

Constructor Detail

• REST(RESTConfig restConfig)

  Constructor

Method Detail

• java.lang.Object doRequest(HTTPRequest rawRequest)

  Executes the request with an . Result will be parsed by the .

  Parameters:

  request - HTTPRequest instance to be executed

  Returns:

  result of the request

• groovyx.net.http.HTTPBuilder getHttpBuilder()

  This method returns an initialized groovyx.net.http.HTTPBuilder instance for the extended use cases.

  Returns:

  initialized HTTPBuilder instance

• HTTPRequest newRequest(java.util.Map requestParams = [:])

  Creates new request

   HTTPRequest request = restClient.newRequest([
     method      : 'GET',
     contentType : 'JSON',
     path        : '/my/path/',
     query       : [ parameter1 : 'value1' ],
     content     : 'request body goes here',
     headers     : [ 'Cookie' : 'shared-cookie;' ]
   ])
   

  Parameters:

  requestParams

  Returns:

  initialized HTTP request instance

• HTTPRequest prepareRequest(HTTPRequest rawRequest)

  Checking that the request has required values and is ready to be executed Additional actions (like OAuth processing) will be applied to the request

  Parameters:

  rawRequest - an HTTPRequest instance

  Returns:

  HTTPRequest instance

• java.lang.Object request(@org.jetbrains.annotations.NotNull java.lang.String method, @org.jetbrains.annotations.NotNull java.lang.String path, @org.jetbrains.annotations.Nullable java.util.Map<java.lang.String, java.lang.String> queryParams = null, @org.jetbrains.annotations.Nullable java.lang.String content = null)

  A handy shortcut for subsequent newRequest() and doRequest()) calls defaultContentType should be set first ( with setResponseContentType() )

  Parameters:

  method

  path

  queryParams

  content

• void setResponseContentType(java.lang.String defaultContentType)

  Set new default content type to be set for the requests without a contentType set.

  Parameters:

  defaultContentType - string that represents groovyx.net.http.ContentType object