Package com.thoughtworks.go.plugin.api.response

Class DefaultGoApiResponse

  • public class DefaultGoApiResponse
extends GoApiResponse
    Default implementation of GoApiResponse

    • Constructor Summary

      Constructors 
      Constructor Description
      DefaultGoApiResponse​(int responseCode)
      Constructs DefaultGoApiResponse with response code

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addResponseHeader​(java.lang.String name, java.lang.String value)
      Adds new response header.
      static DefaultGoApiResponse badRequest​(java.lang.String responseBody)
      Creates an instance DefaultGoApiResponse which represents bad request with response code 400
      static DefaultGoApiResponse error​(java.lang.String responseBody)
      Creates an instance DefaultGoApiResponse which represents error request with response code 500
      static DefaultGoApiResponse incompleteRequest​(java.lang.String responseBody)
      Creates an instance DefaultGoApiResponse which represents incomplete request with response code 412
      java.lang.String responseBody()
      Provides json formatted response body
      int responseCode()
      Provides response code for the request sent
      java.util.Map<java.lang.String,​java.lang.String> responseHeaders()
      Provides response headers as key value pair for the response.
      void setResponseBody​(java.lang.String responseBody)
      Sets response body
      static DefaultGoApiResponse success​(java.lang.String responseBody)
      Creates an instance DefaultGoApiResponse which represents success request with response code 200

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DefaultGoApiResponse

        public DefaultGoApiResponse​(int responseCode)
        Constructs DefaultGoApiResponse with response code
        Parameters:
        responseCode - Response code for the response

    • Method Detail

      • incompleteRequest

        public static DefaultGoApiResponse incompleteRequest​(java.lang.String responseBody)
        Creates an instance DefaultGoApiResponse which represents incomplete request with response code 412
        Parameters:
        responseBody - Response body
        Returns:
        an instance of DefaultGoApiResponse

      • badRequest

        public static DefaultGoApiResponse badRequest​(java.lang.String responseBody)
        Creates an instance DefaultGoApiResponse which represents bad request with response code 400
        Parameters:
        responseBody - Response body
        Returns:
        an instance of DefaultGoApiResponse

      • error

        public static DefaultGoApiResponse error​(java.lang.String responseBody)
        Creates an instance DefaultGoApiResponse which represents error request with response code 500
        Parameters:
        responseBody - Response body
        Returns:
        an instance of DefaultGoApiResponse

      • success

        public static DefaultGoApiResponse success​(java.lang.String responseBody)
        Creates an instance DefaultGoApiResponse which represents success request with response code 200
        Parameters:
        responseBody - Json formatted response body
        Returns:
        an instance of DefaultGoApiResponse

      • addResponseHeader

        public void addResponseHeader​(java.lang.String name,
                              java.lang.String value)
        Adds new response header. Replace existing header with same name
        Parameters:
        name - Name of the header
        value - Value of the header

      • setResponseBody

        public void setResponseBody​(java.lang.String responseBody)
        Sets response body
        Parameters:
        responseBody - Json formatted response body represented as string

      • responseCode

        public int responseCode()
        Provides response code for the request sent
        Specified by:
        responseCode in class GoApiResponse
        Returns:

      • responseHeaders

        public java.util.Map<java.lang.String,​java.lang.String> responseHeaders()
        Provides response headers as key value pair for the response. Response headers can be used to send any meta information related to response
        Specified by:
        responseHeaders in class GoApiResponse
        Returns:
        request headers as a Map

      • responseBody

        public java.lang.String responseBody()
        Provides json formatted response body
        Specified by:
        responseBody in class GoApiResponse
        Returns:
        response body