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

Class DefaultGoPluginApiResponse

java.lang.Object

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

com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse

public class DefaultGoPluginApiResponse
extends GoPluginApiResponse

Default implementation of GoPluginApiResponse

Field Summary

Fields

Modifier and Type	Field	Description
static int	BAD_REQUEST
static int	INTERNAL_ERROR
static int	SUCCESS_RESPONSE_CODE
static int	VALIDATION_FAILED

Constructor Summary

Constructors

Constructor	Description
DefaultGoPluginApiResponse(int responseCode)	Constructs DefaultGoPluginApiResponse with response code
DefaultGoPluginApiResponse(int responseCode, java.lang.String responseBody)	Constructs DefaultGoPluginApiResponse
DefaultGoPluginApiResponse(int responseCode, java.lang.String responseBody, java.util.Map<java.lang.String,java.lang.String> responseHeaders)	Constructs DefaultGoPluginApiResponse

Method Summary

Modifier and Type	Method	Description
void	addResponseHeader(java.lang.String name, java.lang.String value)	Adds new response header.
static DefaultGoPluginApiResponse	badRequest(java.lang.String responseBody)	Creates an instance DefaultGoPluginApiResponse which represents bad request with response code 400
static DefaultGoPluginApiResponse	error(java.lang.String responseBody)	Creates an instance DefaultGoPluginApiResponse which represents error request with response code 500
static DefaultGoPluginApiResponse	incompleteRequest(java.lang.String responseBody)	Creates an instance DefaultGoPluginApiResponse 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 DefaultGoPluginApiResponse	success(java.lang.String responseBody)	Creates an instance DefaultGoPluginApiResponse 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

Field Detail

SUCCESS_RESPONSE_CODE

public static final int SUCCESS_RESPONSE_CODE

See Also:

Constant Field Values

VALIDATION_FAILED

public static final int VALIDATION_FAILED

See Also:

Constant Field Values

BAD_REQUEST

public static final int BAD_REQUEST

See Also:

Constant Field Values

INTERNAL_ERROR

public static final int INTERNAL_ERROR

See Also:

Constant Field Values

Constructor Detail

DefaultGoPluginApiResponse

public DefaultGoPluginApiResponse(int responseCode)

Constructs DefaultGoPluginApiResponse with response code

Parameters:

responseCode - Response code for the response

DefaultGoPluginApiResponse

public DefaultGoPluginApiResponse(int responseCode,
                                  java.lang.String responseBody)

Constructs DefaultGoPluginApiResponse

Parameters:

responseCode - Response code for the response

responseBody - Body of the response

DefaultGoPluginApiResponse

public DefaultGoPluginApiResponse(int responseCode,
                                  java.lang.String responseBody,
                                  java.util.Map<java.lang.String,java.lang.String> responseHeaders)

Constructs DefaultGoPluginApiResponse

Parameters:

responseCode - Response code for the response

responseBody - Body of the response

responseHeaders - The headers of the response

Method Detail

incompleteRequest

public static DefaultGoPluginApiResponse incompleteRequest(java.lang.String responseBody)

Creates an instance DefaultGoPluginApiResponse which represents incomplete request with response code 412

Parameters:

responseBody - Response body

Returns:

an instance of DefaultGoPluginApiResponse

badRequest

public static DefaultGoPluginApiResponse badRequest(java.lang.String responseBody)

Creates an instance DefaultGoPluginApiResponse which represents bad request with response code 400

Parameters:

responseBody - Response body

Returns:

an instance of DefaultGoPluginApiResponse

error

public static DefaultGoPluginApiResponse error(java.lang.String responseBody)

Creates an instance DefaultGoPluginApiResponse which represents error request with response code 500

Parameters:

responseBody - Response body

Returns:

an instance of DefaultGoPluginApiResponse

success

public static DefaultGoPluginApiResponse success(java.lang.String responseBody)

Creates an instance DefaultGoPluginApiResponse which represents success request with response code 200

Parameters:

responseBody - Json formatted response body

Returns:

an instance of DefaultGoPluginApiResponse

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 GoPluginApiResponse

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 GoPluginApiResponse

Returns:

request headers as a Map

responseBody

public java.lang.String responseBody()

Provides json formatted response body

Specified by:

responseBody in class GoPluginApiResponse

Returns:

response body