Package org.sonarqube.ws.client

Class RequestWithPayload<T extends RequestWithPayload<T>>

java.lang.Object

org.sonarqube.ws.client.RequestWithPayload<T>

All Implemented Interfaces:

WsRequest

Direct Known Subclasses:

PatchRequest, PostRequest, PutRequest

public abstract class RequestWithPayload<T extends RequestWithPayload<T>>
extends Object

Since:

5.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RequestWithPayload.Part

Nested classes/interfaces inherited from interface org.sonarqube.ws.client.WsRequest

WsRequest.Method

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RequestWithPayload(String path)

Method Summary

Modifier and Type	Method	Description
String	getBody()
Optional<String>	getContentType()
Headers	getHeaders()
String	getMediaType()
Parameters	getParameters()
Map<String,String>	getParams()	In case of multi value parameters, returns the first value
Map<String,RequestWithPayload.Part>	getParts()
String	getPath()
OptionalInt	getTimeOutInMs()
OptionalInt	getWriteTimeOutInMs()
boolean	hasBody()
T	setBody(String body)
T	setContentType(String contentType)
<T extends SELF> T	setHeader(String name, String value)
<T extends SELF> T	setMediaType(String s)	Expected media type of response.
<T extends SELF> T	setParam(String key, Boolean value)
<T extends SELF> T	setParam(String key, Float value)
<T extends SELF> T	setParam(String key, Integer value)
<T extends SELF> T	setParam(String key, Long value)
<T extends SELF> T	setParam(String key, String value)
<T extends SELF> T	setParam(String key, Collection<? extends Object> values)
T	setPart(String name, RequestWithPayload.Part part)
<T extends SELF> T	setTimeOutInMs(int timeOutInMs)
<T extends SELF> T	setWriteTimeOutInMs(int writeTimeOutInMs)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sonarqube.ws.client.WsRequest

getMethod

Constructor Details

RequestWithPayload

protected RequestWithPayload(String path)

Method Details

setBody

public T setBody(String body)

getBody

public String getBody()

hasBody

public boolean hasBody()

setContentType

public T setContentType(String contentType)

getContentType

public Optional<String> getContentType()

setPart

public T setPart(String name,
 RequestWithPayload.Part part)

getParts

public Map<String,RequestWithPayload.Part> getParts()

getPath

public String getPath()

Specified by:

getPath in interface WsRequest

getMediaType

public String getMediaType()

Specified by:

getMediaType in interface WsRequest

getTimeOutInMs

public OptionalInt getTimeOutInMs()

Specified by:

getTimeOutInMs in interface WsRequest

setTimeOutInMs

public <T extends SELF> T setTimeOutInMs(int timeOutInMs)

getWriteTimeOutInMs

public OptionalInt getWriteTimeOutInMs()

Specified by:

getWriteTimeOutInMs in interface WsRequest

setWriteTimeOutInMs

public <T extends SELF> T setWriteTimeOutInMs(int writeTimeOutInMs)

setMediaType

public <T extends SELF> T setMediaType(String s)

Expected media type of response. Default is MediaTypes.JSON.

setParam

public <T extends SELF> T setParam(String key,
 @Nullable
 String value)

setParam

public <T extends SELF> T setParam(String key,
 @Nullable
 Integer value)

setParam

public <T extends SELF> T setParam(String key,
 @Nullable
 Long value)

setParam

public <T extends SELF> T setParam(String key,
 @Nullable
 Float value)

setParam

public <T extends SELF> T setParam(String key,
 @Nullable
 Boolean value)

setParam

public <T extends SELF> T setParam(String key,
 @Nullable
 Collection<? extends Object> values)

getParams

public Map<String,String> getParams()

Description copied from interface: WsRequest

In case of multi value parameters, returns the first value

Specified by:

getParams in interface WsRequest

getParameters

public Parameters getParameters()

Specified by:

getParameters in interface WsRequest

getHeaders

public Headers getHeaders()

Specified by:

getHeaders in interface WsRequest

setHeader

public <T extends SELF> T setHeader(String name,
 @Nullable
 String value)