com.thoughtworks.go.plugin.api.response

Class DefaultGoApiResponse

java.lang.Object

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

com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse

public class DefaultGoApiResponse
extends GoApiResponse

Default implementation of GoApiResponse

Field Summary

Fields

Modifier and Type	Field and Description
static int	INTERNAL_ERROR
static int	REDIRECT_RESPONSE_CODE
static int	SUCCESS_RESPONSE_CODE
static int	VALIDATION_ERROR

Constructor Summary

Constructors

Constructor and Description
DefaultGoApiResponse(int responseCode) Constructs DefaultGoApiResponse with response code

Method Summary

Modifier and Type	Method and Description
void	addResponseHeader(String name, String value) Adds new response header.
static DefaultGoApiResponse	badRequest(String responseBody) Creates an instance DefaultGoApiResponse which represents bad request with response code 400
static DefaultGoApiResponse	error(String responseBody) Creates an instance DefaultGoApiResponse which represents error request with response code 500
static DefaultGoApiResponse	incompleteRequest(String responseBody) Creates an instance DefaultGoApiResponse which represents incomplete request with response code 412
String	responseBody() Provides json formatted response body
int	responseCode() Provides response code for the request sent
Map<String,String>	responseHeaders() Provides response headers as key value pair for the response.
void	setResponseBody(String responseBody) Sets response body
static DefaultGoApiResponse	success(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

Field Detail

SUCCESS_RESPONSE_CODE

public static final int SUCCESS_RESPONSE_CODE

See Also:

Constant Field Values

REDIRECT_RESPONSE_CODE

public static final int REDIRECT_RESPONSE_CODE

See Also:

Constant Field Values

INTERNAL_ERROR

public static final int INTERNAL_ERROR

See Also:

Constant Field Values

VALIDATION_ERROR

public static final int VALIDATION_ERROR

See Also:

Constant Field Values

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(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(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(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(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(String name,
                              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(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 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

Specified by:

responseHeaders in class GoApiResponse

Returns:

request headers as a Map

responseBody

public String responseBody()

Provides json formatted response body

Specified by:

responseBody in class GoApiResponse

Returns:

response body