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

Class GoApiResponse

java.lang.Object

com.thoughtworks.go.plugin.api.response.GoApiResponse

Direct Known Subclasses:

DefaultGoApiResponse

public abstract class GoApiResponse
extends Object

Provides an abstraction for api response sent from Go to plugin

Constructor Summary

Constructors

Constructor	Description
GoApiResponse()

Method Summary

Modifier and Type	Method	Description
abstract String	responseBody()	Provides json formatted response body
abstract int	responseCode()	Provides response code for the request sent
abstract Map<String,String>	responseHeaders()	Provides response headers as key value pair for the response.

Methods inherited from class java.lang.Object

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

Constructor Details

GoApiResponse

public GoApiResponse()

Method Details

responseCode

public abstract int responseCode()

Provides response code for the request sent

Returns:

responseHeaders

public abstract Map<String,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

Returns:

request headers as a Map

responseBody

public abstract String responseBody()

Provides json formatted response body

Returns:

response body