public class DefaultGoPluginApiResponse extends GoPluginApiResponse
| Modifier and Type | Field and Description |
|---|---|
static int |
BAD_REQUEST |
static int |
INTERNAL_ERROR |
static int |
SUCCESS_RESPONSE_CODE |
static int |
VALIDATION_FAILED |
| Constructor and 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
|
| Modifier and Type | Method and 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
|
public static final int SUCCESS_RESPONSE_CODE
public static final int VALIDATION_FAILED
public static final int BAD_REQUEST
public static final int INTERNAL_ERROR
public DefaultGoPluginApiResponse(int responseCode)
responseCode - Response code for the responsepublic DefaultGoPluginApiResponse(int responseCode,
java.lang.String responseBody)
responseCode - Response code for the responseresponseBody - Body of the responsepublic DefaultGoPluginApiResponse(int responseCode,
java.lang.String responseBody,
java.util.Map<java.lang.String,java.lang.String> responseHeaders)
responseCode - Response code for the responseresponseBody - Body of the responseresponseHeaders - The headers of the responsepublic static DefaultGoPluginApiResponse incompleteRequest(java.lang.String responseBody)
responseBody - Response bodypublic static DefaultGoPluginApiResponse badRequest(java.lang.String responseBody)
responseBody - Response bodypublic static DefaultGoPluginApiResponse error(java.lang.String responseBody)
responseBody - Response bodypublic static DefaultGoPluginApiResponse success(java.lang.String responseBody)
responseBody - Json formatted response bodypublic void addResponseHeader(java.lang.String name,
java.lang.String value)
name - Name of the headervalue - Value of the headerpublic void setResponseBody(java.lang.String responseBody)
responseBody - Json formatted response body represented as stringpublic int responseCode()
responseCode in class GoPluginApiResponsepublic java.util.Map<java.lang.String,java.lang.String> responseHeaders()
responseHeaders in class GoPluginApiResponsepublic java.lang.String responseBody()
responseBody in class GoPluginApiResponseCopyright © 2019 ThoughtWorks, Inc. GoCD Version: 19.2.0-8641