com.thoughtworks.go.plugin.api.request

Class DefaultGoPluginApiRequest

java.lang.Object

com.thoughtworks.go.plugin.api.request.GoPluginApiRequest

com.thoughtworks.go.plugin.api.request.DefaultGoPluginApiRequest

public class DefaultGoPluginApiRequest
extends GoPluginApiRequest

Default implementation of GoPluginApiRequest

Constructor Summary

Constructors

Constructor and Description
DefaultGoPluginApiRequest(java.lang.String extension, java.lang.String extensionVersion, java.lang.String requestName) Constructs DefaultGoPluginApiRequest with extension name, extension version and request name

Method Summary

Modifier and Type	Method and Description
void	addRequestHeader(java.lang.String name, java.lang.String value) Adds new request header.
void	addRequestParameter(java.lang.String name, java.lang.String value) Adds new request parameter.
java.lang.String	extension() Extension name of the request
java.lang.String	extensionVersion() Extension version of the request
java.lang.String	requestBody() Provides json formatted request body of request
java.util.Map<java.lang.String,java.lang.String>	requestHeaders() Provides request headers as key value pair for the request.
java.lang.String	requestName() Name or operation supported for an extension
java.util.Map<java.lang.String,java.lang.String>	requestParameters() Provides request parameters as key value pair for the request
void	setRequestBody(java.lang.String requestBody) Sets request body
void	setRequestHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
void	setRequestParams(java.util.Map<java.lang.String,java.lang.String> params)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultGoPluginApiRequest

public DefaultGoPluginApiRequest(java.lang.String extension,
                                 java.lang.String extensionVersion,
                                 java.lang.String requestName)

Constructs DefaultGoPluginApiRequest with extension name, extension version and request name

Parameters:

extension - Name of the extension

extensionVersion - Version of the extension

requestName - Name of request or operation supported under extension

Method Detail

setRequestBody

public void setRequestBody(java.lang.String requestBody)

Sets request body

Parameters:

requestBody - Json formatted request body represented as string

addRequestParameter

public void addRequestParameter(java.lang.String name,
                                java.lang.String value)

Adds new request parameter. Replace existing parameter with same name

Parameters:

name - Name of the parameter

value - Value of the parameter

addRequestHeader

public void addRequestHeader(java.lang.String name,
                             java.lang.String value)

Adds new request header. Replace existing header with same name

Parameters:

name - Name of the header

value - Value of the header

extension

public java.lang.String extension()

Extension name of the request

Specified by:

extension in class GoPluginApiRequest

Returns:

extension name

extensionVersion

public java.lang.String extensionVersion()

Extension version of the request

Specified by:

extensionVersion in class GoPluginApiRequest

Returns:

extension version

requestName

public java.lang.String requestName()

Name or operation supported for an extension

Specified by:

requestName in class GoPluginApiRequest

Returns:

name of the request

requestParameters

public java.util.Map<java.lang.String,java.lang.String> requestParameters()

Provides request parameters as key value pair for the request

Specified by:

requestParameters in class GoPluginApiRequest

Returns:

map of request parameters

requestHeaders

public java.util.Map<java.lang.String,java.lang.String> requestHeaders()

Provides request headers as key value pair for the request. Request headers can be used to send any meta information related to request

Specified by:

requestHeaders in class GoPluginApiRequest

Returns:

map of request headers

requestBody

public java.lang.String requestBody()

Provides json formatted request body of request

Specified by:

requestBody in class GoPluginApiRequest

Returns:

Request body

setRequestParams

public void setRequestParams(java.util.Map<java.lang.String,java.lang.String> params)

setRequestHeaders

public void setRequestHeaders(java.util.Map<java.lang.String,java.lang.String> headers)