Package sonia.scm.net.ahc

Class AdvancedHttpRequestWithBody

java.lang.Object

sonia.scm.net.ahc.BaseHttpRequest<AdvancedHttpRequestWithBody>

sonia.scm.net.ahc.AdvancedHttpRequestWithBody

public class AdvancedHttpRequestWithBody
extends BaseHttpRequest<AdvancedHttpRequestWithBody>

Http request with body.

Since:

1.46

Field Summary

Fields inherited from class sonia.scm.net.ahc.BaseHttpRequest

client

Method Summary

Modifier and Type	Method	Description
AdvancedHttpRequestWithBody	contentLength(long length)	Sets the content length for the request.
AdvancedHttpRequestWithBody	contentType(String contentType)	Sets the content type for the request.
AdvancedHttpRequestWithBody	fileContent(File file)	Sets the content of the file as request content.
FormContentBuilder	formContent()	Returns a FormContentBuilder.
Content	getContent()	Returns the content or the request.
AdvancedHttpRequestWithBody	jsonContent(Object object)	Transforms the given object to a json string and set this string as request content.
AdvancedHttpRequestWithBody	rawContent(byte[] data)	Sets the raw data as request content.
AdvancedHttpRequestWithBody	rawContent(com.google.common.io.ByteSource source)	Sets the raw data as request content.
protected AdvancedHttpRequestWithBody	self()	Implementing classes should return this.
AdvancedHttpRequestWithBody	stringContent(String content)	Sets the string as request content.
AdvancedHttpRequestWithBody	stringContent(String content, Charset charset)	Sets the string as request content.
AdvancedHttpRequestWithBody	transformedContent(String contentType, Object object)	Transforms the given object to a string and set this string as request content.
AdvancedHttpRequestWithBody	xmlContent(Object object)	Transforms the given object to a xml string and set this string as request content.

Methods inherited from class sonia.scm.net.ahc.BaseHttpRequest

acceptStatusCodes, basicAuth, bearerAuth, decodeGZip, disableCertificateValidation, disableHostnameValidation, disableTracing, encoded, getAcceptedStatus, getHeaders, getMethod, getSpanKind, getUrl, header, headers, ignoreProxySettings, isDecodeGZip, isDisableCertificateValidation, isDisableHostnameValidation, isIgnoreProxySettings, queryString, queryStrings, request, spanKind, toString

Methods inherited from class java.lang.Object

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

Method Details

contentLength

public AdvancedHttpRequestWithBody contentLength(long length)

Sets the content length for the request.

Returns:

this

contentType

public AdvancedHttpRequestWithBody contentType(String contentType)

Sets the content type for the request.

Returns:

this

fileContent

public AdvancedHttpRequestWithBody fileContent(File file)

Sets the content of the file as request content.

Returns:

this

formContent

public FormContentBuilder formContent()

Returns a FormContentBuilder. The builder can be used to add form parameters as content for the request. Note: you have to call FormContentBuilder.build() in order to apply the form content to the request.

Returns:

form content builder

jsonContent

public AdvancedHttpRequestWithBody jsonContent(Object object)

Transforms the given object to a json string and set this string as request content.

Parameters:

object - object to transform

Returns:

this

Throws:

ContentTransformerNotFoundException - if no ContentTransformer could be found for the json content-type

rawContent

public AdvancedHttpRequestWithBody rawContent(byte[] data)

Sets the raw data as request content.

Returns:

this

rawContent

public AdvancedHttpRequestWithBody rawContent(com.google.common.io.ByteSource source)

Sets the raw data as request content.

Returns:

this

stringContent

public AdvancedHttpRequestWithBody stringContent(String content)

Sets the string as request content.

Returns:

this

stringContent

public AdvancedHttpRequestWithBody stringContent(String content,
 Charset charset)

Sets the string as request content.

Parameters:

content - string content

charset - charset of content

Returns:

this

transformedContent

public AdvancedHttpRequestWithBody transformedContent(String contentType,
 Object object)

Transforms the given object to a string and set this string as request content. The content-type is used to pick the right ContentTransformer. The method will throw an exception if no ContentTransformer for the content-type could be found.

Parameters:

contentType - content-type

object - object to transform

Returns:

this

Throws:

ContentTransformerNotFoundException - if no ContentTransformer could be found for the given content-type

xmlContent

public AdvancedHttpRequestWithBody xmlContent(Object object)

Transforms the given object to a xml string and set this string as request content.

Parameters:

object - object to transform

Returns:

this

Throws:

ContentTransformerNotFoundException - if no ContentTransformer could be found for the xml content-type

getContent

public Content getContent()

Returns the content or the request.

self

protected AdvancedHttpRequestWithBody self()

Description copied from class: BaseHttpRequest

Implementing classes should return this.

Specified by:

self in class BaseHttpRequest<AdvancedHttpRequestWithBody>

Returns:

request instance