com.github.aivancioglo.resttest.setters

Class Setters.Companion

com.github.aivancioglo.resttest.setters.Setters.Companion

Enclosing class:

Setters

public static class Setters.Companion

Method Summary

Modifier and Type	Method and Description
Setter	accept(java.lang.String mediaType) Get accept setter.
Setter	accept(ContentType contentType) Getting accept setter.
Setter	baseUri(java.lang.String baseUri) Getting baseUri setter.
Setter	basicAuth(java.lang.String userName, java.lang.String password) Use http basic authentication.
Setter	body(java.lang.String body) Get requestSpecification body setter.
Setter	body(java.io.Serializable body) Get requestSpecification body setter.
Setter	contentType(ContentType type) Get content type setter.
Setter	contentType(java.lang.String type) Get content type setter.
Setter	cookie(java.lang.String name, java.lang.String value, java.lang.String additionalValues) Get cookie setter.
Setter	cookie(java.lang.String name, java.lang.String value) Get cookie setter.
Setter	cookie(java.lang.String name) Get cookie setter.
Setter	defaultParser(Parser parser) Register a default predefined parser that will be used if no other parser (registered or pre-defined) matches the response content-type.
Setter	formParam(java.lang.String key, java.lang.Object value) Get form param setter.
Setter	header(java.lang.String name, java.lang.String value) Get header setter.
Setter	host(java.lang.String host) Get requestSpecification host setter.
Setter	jsonParam(java.lang.String key, java.lang.Object value) Get json param setter.
Setter	multiPart(java.lang.String controlName, java.lang.String fileName, java.io.InputStream stream) Get multi part setter.
Setter	multiPart(java.lang.String controlName, java.lang.String fileName, java.io.InputStream stream, java.lang.String mimeType) Get multi part setter.
Setter	multiPart(java.io.File file) Get multi part setter.
Setter	multiPart(java.lang.String controlName, java.io.File file) Get multi part setter.
Setter	multiPart(io.restassured.specification.MultiPartSpecification multiPartSpecification) Get multi part setter.
Setter	noAuth() Clear all authentication settings.
Setter	oauth1(java.lang.String consumerKey, java.lang.String consumerSecret, java.lang.String token, java.lang.String tokenSecret) Set all OAuth 1.0 authentication settings.
Setter	oauth2(java.lang.String token) Set all OAuth 2.0 authentication settings.
Setter	param(java.lang.String key, java.lang.Object value) Get param setter.
Setter	parser(java.lang.String contentType, Parser parser) Register a content-type to be parsed using a predefined parser.
Setter	path(java.lang.String path) Get requestSpecification path setter.
Setter	pathParam(java.lang.String key, java.lang.Object value) Get path param setter.
Setter	port(int port) Get requestSpecification port setter.
Setter	protocol(java.lang.String protocol) Get requestSpecification protocol setter.
Setter	queryParam(java.lang.String key, java.lang.Object value) Get query param setter.
Setter	redirects(int max) Get redirect setter.
Setter	redirects(boolean follow) Get redirect setter.
Setter	urlEncodingEnabled(boolean isEnabled) Specifies if RestTest should url encode the URL automatically. Usually, this is recommended but in some cases (e.g. the query parameters are already be encoded before you provide them to RestTest) then it's useful to disable URL encoding.

Method Detail

baseUri

public Setter baseUri(java.lang.String baseUri)

Getting baseUri setter.

Parameters:

baseUri - of request.

Returns:

Setter instance.

contentType

public Setter contentType(ContentType type)

Get content type setter.

Parameters:

type - Content type of the request.

Returns:

Setter instance.

contentType

public Setter contentType(java.lang.String type)

Get content type setter.

Parameters:

type - Content type of the request.

Returns:

Setter instance.

param

public Setter param(java.lang.String key,
                    java.lang.Object value)

Get param setter.

Parameters:

key - Key of param.

value - Value of param.

Returns:

Setter instance.

queryParam

public Setter queryParam(java.lang.String key,
                         java.lang.Object value)

Get query param setter.

Parameters:

key - Key of query param.

value - Value of query param.

Returns:

Setter instance.

formParam

public Setter formParam(java.lang.String key,
                        java.lang.Object value)

Get form param setter.

Parameters:

key - Key of form param.

value - Value of form param.

Returns:

Setter instance.

jsonParam

public Setter jsonParam(java.lang.String key,
                        java.lang.Object value)

Get json param setter.

Parameters:

key - Key of json param.

value - Value of json param.

Returns:

Setter instance.

cookie

public Setter cookie(java.lang.String name,
                     java.lang.String value,
                     java.lang.String additionalValues)

Get cookie setter.

Parameters:

name - Name of cookie.

value - Value of cookie.

additionalValues - Additional values of cookie.

Returns:

Setter instance.

cookie

public Setter cookie(java.lang.String name,
                     java.lang.String value)

Get cookie setter.

Parameters:

name - Name of cookie.

value - Value of cookie.

Returns:

Setter instance.

cookie

public Setter cookie(java.lang.String name)

Get cookie setter.

Parameters:

name - Name of cookie.

Returns:

Setter instance.

header

public Setter header(java.lang.String name,
                     java.lang.String value)

Get header setter.

Parameters:

name - Name of header.

value - Value of header.

Returns:

Setter instance.

body

public Setter body(java.lang.String body)

Get requestSpecification body setter.

Parameters:

body - Body of requestSpecification.

Returns:

Setter instance.

body

public Setter body(java.io.Serializable body)

Get requestSpecification body setter.

Parameters:

body - Body of requestSpecification.

Returns:

Setter instance.

protocol

public Setter protocol(java.lang.String protocol)

Get requestSpecification protocol setter.

Parameters:

protocol - Protocol of requestSpecification.

Returns:

Setter instance.

host

public Setter host(java.lang.String host)

Get requestSpecification host setter.

Parameters:

host - Host of requestSpecification.

Returns:

Setter instance.

path

public Setter path(java.lang.String path)

Get requestSpecification path setter.

Parameters:

path - Path of requestSpecification.

Returns:

Setter instance.

port

public Setter port(int port)

Get requestSpecification port setter.

Parameters:

port - Port of requestSpecification.

Returns:

Setter instance.

pathParam

public Setter pathParam(java.lang.String key,
                        java.lang.Object value)

Get path param setter.

Parameters:

key - Key of path param.

value - Value of path param.

Returns:

Setter instance.

multiPart

public Setter multiPart(java.lang.String controlName,
                        java.lang.String fileName,
                        java.io.InputStream stream)

Get multi part setter.

Parameters:

controlName - Control name of the body part. In HTML this is the attribute name of the input tag.

fileName - File name of the content you're uploading.

stream - Stream you want to requestSpecification.

Returns:

Setter instance.

multiPart

public Setter multiPart(java.lang.String controlName,
                        java.lang.String fileName,
                        java.io.InputStream stream,
                        java.lang.String mimeType)

Get multi part setter.

Parameters:

controlName - Control name of the body part. In HTML this is the attribute name of the input tag.

fileName - File name of the content you're uploading.

stream - Stream you want to requestSpecification.

mimeType - The mime-type.

Returns:

Setter instance.

multiPart

public Setter multiPart(java.io.File file)

Get multi part setter.

Parameters:

file - File to upload.

Returns:

Setter instance.

multiPart

public Setter multiPart(java.lang.String controlName,
                        java.io.File file)

Get multi part setter.

Parameters:

file - File to upload.

controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.

Returns:

Setter instance.

multiPart

public Setter multiPart(io.restassured.specification.MultiPartSpecification multiPartSpecification)

Get multi part setter.

Parameters:

multiPartSpecification - Multi part specification of your request.

Returns:

Setter instance.

redirects

public Setter redirects(int max)

Get redirect setter.

Parameters:

max - Maximum count of redirects.

Returns:

Setter instance.

redirects

public Setter redirects(boolean follow)

Get redirect setter.

Parameters:

follow - Follow redirects.

Returns:

Setter instance.

accept

public Setter accept(java.lang.String mediaType)

Get accept setter.

Parameters:

mediaType - Media type of request.

Returns:

Setter instance.

accept

public Setter accept(ContentType contentType)

Getting accept setter.

Parameters:

contentType - Content type of request.

Returns:

Setter instance.

urlEncodingEnabled

public Setter urlEncodingEnabled(boolean isEnabled)

Specifies if RestTest should url encode the URL automatically. Usually, this is recommended but in some cases (e.g. the query parameters are already be encoded before you provide them to RestTest) then it's useful to disable URL encoding.

Parameters:

isEnabled - Is URL encoding enabled or disabled.

Returns:

Setter instance.

basicAuth

public Setter basicAuth(java.lang.String userName,
                        java.lang.String password)

Use http basic authentication.

Parameters:

userName - User name of your account.

password - Password of your account.

Returns:

Setter instance.

oauth1

public Setter oauth1(java.lang.String consumerKey,
                     java.lang.String consumerSecret,
                     java.lang.String token,
                     java.lang.String tokenSecret)

Set all OAuth 1.0 authentication settings.

Returns:

Setter instance.

oauth2

public Setter oauth2(java.lang.String token)

Set all OAuth 2.0 authentication settings.

Returns:

Setter instance.

noAuth

public Setter noAuth()

Clear all authentication settings.

Returns:

Setter instance.

parser

public Setter parser(java.lang.String contentType,
                     Parser parser)

Register a content-type to be parsed using a predefined parser.

Returns:

Setter instance.

defaultParser

public Setter defaultParser(Parser parser)

Register a default predefined parser that will be used if no other parser (registered or pre-defined) matches the response content-type.

Returns:

Setter instance.