com.thoughtworks.go.plugin.api.response

Class GoPluginApiResponse

java.lang.Object

com.thoughtworks.go.plugin.api.response.GoPluginApiResponse

Direct Known Subclasses:

DefaultGoPluginApiResponse

public abstract class GoPluginApiResponse
extends java.lang.Object

Provides an abstraction for api response sent from plugin to Go

Constructor Summary

Constructors

Constructor and Description
GoPluginApiResponse()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	responseBody() Provides json formatted response body
abstract int	responseCode() Provides response code for the request sent
abstract java.util.Map<java.lang.String,java.lang.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 Detail

GoPluginApiResponse

public GoPluginApiResponse()

Method Detail

responseCode

public abstract int responseCode()

Provides response code for the request sent

Returns:

responseHeaders

public abstract 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

Returns:

request headers as a Map

responseBody

public abstract java.lang.String responseBody()

Provides json formatted response body

Returns:

response body