Package com.thoughtworks.go.plugin.api.request

Class DefaultGoApiRequest

java.lang.Object
com.thoughtworks.go.plugin.api.request.GoApiRequest
com.thoughtworks.go.plugin.api.request.DefaultGoApiRequest
public class DefaultGoApiRequest extends GoApiRequest
Default implementation of GoApiRequest

  • Constructor Details

    • DefaultGoApiRequest

      public DefaultGoApiRequest(String api, String apiVersion, GoPluginIdentifier pluginIdentifier)
      Constructs DefaultGoApiRequest with api name, api version and plugin identifier
      Parameters:
      api - Name of api
      apiVersion - version of api
      pluginIdentifier - An instance of GoPluginIdentifier

  • Method Details

    • setRequestBody

      public void setRequestBody(String requestBody)
      Sets request body
      Parameters:
      requestBody - Json formatted request body represented as string

    • addRequestParameter

      public void addRequestParameter(String name, String value)
      Adds new request parameter. Replace existing parameter with same name
      Parameters:
      name - Name of the parameter
      value - Value of the parameter

    • addRequestHeader

      public void addRequestHeader(String name, String value)
      Adds new request header. Replace existing header with same name
      Parameters:
      name - Name of the header
      value - Value of the header

    • api

      public String api()
      Api name for the request
      Specified by:
      api in class GoApiRequest
      Returns:
      api name

    • apiVersion

      public String apiVersion()
      Api version of the request
      Specified by:
      apiVersion in class GoApiRequest
      Returns:
      api version

    • pluginIdentifier

      public GoPluginIdentifier pluginIdentifier()
      Provides an instance of GoPluginIdentifier for the request
      Specified by:
      pluginIdentifier in class GoApiRequest
      Returns:
      an instance of GoPluginIdentifier

    • requestParameters

      public Map<String,String> requestParameters()
      Provides request parameters as key value pair for the request
      Specified by:
      requestParameters in class GoApiRequest
      Returns:
      request parameters as a Map

    • requestHeaders

      public Map<String,String> requestHeaders()
      Provides request headers as key value pair for the request. Request headers can be used to send any meta information related to request
      Specified by:
      requestHeaders in class GoApiRequest
      Returns:
      request headers as a Map

    • requestBody

      public String requestBody()
      Provides json formatted request body
      Specified by:
      requestBody in class GoApiRequest
      Returns:
      request body