Package com.thoughtworks.go.plugin.api.request

Class GoPluginApiRequest

java.lang.Object

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

Direct Known Subclasses:

DefaultGoPluginApiRequest

public abstract class GoPluginApiRequest
extends Object

Provides an abstraction for api request sent from Go to plugin

Constructor Summary

Constructors

Constructor	Description
GoPluginApiRequest()

Method Summary

Modifier and Type	Method	Description
abstract String	extension()	Extension name of the request
abstract String	extensionVersion()	Extension version of the request
abstract String	requestBody()	Provides json formatted request body
abstract Map<String,String>	requestHeaders()	Provides request headers as key value pair for the request.
abstract String	requestName()	Name or operation supported for an extension
abstract Map<String,String>	requestParameters()	Provides request parameters as key value pair for the request

Methods inherited from class java.lang.Object

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

Constructor Details

GoPluginApiRequest

public GoPluginApiRequest()

Method Details

extension

public abstract String extension()

Extension name of the request

Returns:

extension name

extensionVersion

public abstract String extensionVersion()

Extension version of the request

Returns:

extension version

requestName

public abstract String requestName()

Name or operation supported for an extension

Returns:

name of the request

requestParameters

public abstract Map<String,String> requestParameters()

Provides request parameters as key value pair for the request

Returns:

map of request parameters

requestHeaders

public abstract Map<String,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

Returns:

map of request headers

requestBody

public abstract String requestBody()

Provides json formatted request body

Returns:

request body