io.devcon5.commons.rest

Class SimpleRestClient.RequestBuilder

java.lang.Object

io.devcon5.commons.rest.SimpleRestClient.RequestBuilder

Enclosing class:

SimpleRestClient

public static class SimpleRestClient.RequestBuilder
extends Object

Builder for fluently defining a request

Method Summary

Modifier and Type	Method and Description
SimpleRestClient.RequestBuilder	accept(String contentType) Sets a custom content type as Accept header
SimpleRestClient.RequestBuilder	acceptJson() Sets the accept content type to application/json
SimpleRestClient.RequestBuilder	addHeader(String name, String value) Adds a custom header to the request
SimpleRestClient.RequestBuilder	auth(String authToken) Specifies a custom auth token to set as Authorization information on the request
SimpleRestClient.RequestBuilder	basicAuth(String username, String password) Specifies basic authentication information to be added to the request
SimpleRestClient.RequestBuilder	contentType(String contentType) Sets a custom content type as Content-Type header
SimpleRestClient.Response	delete() Finalizes and sends a DELETE request
SimpleRestClient.Response	get() Finalizes and sends a GET request
SimpleRestClient.Response	head() Finalizes and sends a HEAD request
SimpleRestClient.Response	post(io.devcon5.commons.rest.SimpleRestClient.CheckedConsumer<OutputStream> dataProvider) Finalizes and sends a POST request
SimpleRestClient.Response	put(io.devcon5.commons.rest.SimpleRestClient.CheckedConsumer<OutputStream> dataProvider) Finalizes and sends a PUT request
SimpleRestClient.RequestBuilder	sendJson() Sets the sent content's type to application/json

Methods inherited from class java.lang.Object

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

Method Detail

basicAuth

public SimpleRestClient.RequestBuilder basicAuth(String username,
                                                 String password)

Specifies basic authentication information to be added to the request

Parameters:

username - the plain text username

password - the plaintext password

Returns:

this builder

auth

public SimpleRestClient.RequestBuilder auth(String authToken)

Specifies a custom auth token to set as Authorization information on the request

Parameters:

authToken - the authToken used as 'Authorization' header

Returns:

this builder

acceptJson

public SimpleRestClient.RequestBuilder acceptJson()

Sets the accept content type to application/json

Returns:

this builder

accept

public SimpleRestClient.RequestBuilder accept(String contentType)

Sets a custom content type as Accept header

Parameters:

contentType - the accepted content type(s)

Returns:

this builder

sendJson

public SimpleRestClient.RequestBuilder sendJson()

Sets the sent content's type to application/json

Returns:

this builder

contentType

public SimpleRestClient.RequestBuilder contentType(String contentType)

Sets a custom content type as Content-Type header

Parameters:

contentType - the content type to be set

Returns:

this builder

addHeader

public SimpleRestClient.RequestBuilder addHeader(String name,
                                                 String value)

Adds a custom header to the request

Parameters:

name - the name of the header field

value - the value of the header field

Returns:

this builder

get

public SimpleRestClient.Response get()

Finalizes and sends a GET request

Returns:

the response handle

head

public SimpleRestClient.Response head()

Finalizes and sends a HEAD request

Returns:

the response handle

delete

public SimpleRestClient.Response delete()

Finalizes and sends a DELETE request

Returns:

the response handle

post

public SimpleRestClient.Response post(io.devcon5.commons.rest.SimpleRestClient.CheckedConsumer<OutputStream> dataProvider)

Finalizes and sends a POST request

Parameters:

dataProvider - a data provider that writes to the output stream of the outgoing request

Returns:

the response handle

put

public SimpleRestClient.Response put(io.devcon5.commons.rest.SimpleRestClient.CheckedConsumer<OutputStream> dataProvider)

Finalizes and sends a PUT request

Parameters:

dataProvider - a data provider that writes to the output stream of the outgoing request

Returns:

the response handle