com.github.aivancioglo.resttest.setters

Class Setters

com.github.aivancioglo.resttest.setters.Setters

public class Setters

Abstract class for calling setters using static functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Setters.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static Setters.Companion	Companion

Constructor Summary

Constructors

Constructor and Description
Setters() Abstract class for calling setters using static functions.

Method Summary

Modifier and Type	Method and Description
static Setter	accept(java.lang.String mediaType) Get accept setter.
static Setter	accept(ContentType contentType) Getting accept setter.
static Setter	baseUri(java.lang.String baseUri) Getting baseUri setter.
static Setter	basicAuth(java.lang.String userName, java.lang.String password) Use http basic authentication.
static Setter	body(java.lang.String body) Get requestSpecification body setter.
static Setter	body(java.io.Serializable body) Get requestSpecification body setter.
static Setter	contentType(ContentType type) Get content type setter.
static Setter	contentType(java.lang.String type) Get content type setter.
static Setter	cookie(java.lang.String name, java.lang.String value, java.lang.String additionalValues) Get cookie setter.
static Setter	cookie(java.lang.String name, java.lang.String value) Get cookie setter.
static Setter	cookie(java.lang.String name) Get cookie setter.
static 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.
static Setter	formParam(java.lang.String key, java.lang.Object value) Get form param setter.
static Setter	header(java.lang.String name, java.lang.String value) Get header setter.
static Setter	host(java.lang.String host) Get requestSpecification host setter.
static Setter	jsonParam(java.lang.String key, java.lang.Object value) Get json param setter.
static Setter	multiPart(java.lang.String controlName, java.lang.String fileName, java.io.InputStream stream) Get multi part setter.
static Setter	multiPart(java.lang.String controlName, java.lang.String fileName, java.io.InputStream stream, java.lang.String mimeType) Get multi part setter.
static Setter	multiPart(java.io.File file) Get multi part setter.
static Setter	multiPart(java.lang.String controlName, java.io.File file) Get multi part setter.
static Setter	multiPart(io.restassured.specification.MultiPartSpecification multiPartSpecification) Get multi part setter.
static Setter	noAuth() Clear all authentication settings.
static 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.
static Setter	oauth2(java.lang.String token) Set all OAuth 2.0 authentication settings.
static Setter	param(java.lang.String key, java.lang.Object value) Get param setter.
static Setter	parser(java.lang.String contentType, Parser parser) Register a content-type to be parsed using a predefined parser.
static Setter	path(java.lang.String path) Get requestSpecification path setter.
static Setter	pathParam(java.lang.String key, java.lang.Object value) Get path param setter.
static Setter	port(int port) Get requestSpecification port setter.
static Setter	protocol(java.lang.String protocol) Get requestSpecification protocol setter.
static Setter	queryParam(java.lang.String key, java.lang.Object value) Get query param setter.
static Setter	redirects(int max) Get redirect setter.
static Setter	redirects(boolean follow) Get redirect setter.
static 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.

Field Detail

Companion

public static Setters.Companion Companion

Constructor Detail

Setters

public Setters()

Abstract class for calling setters using static functions.

Method Detail

baseUri

public static Setter baseUri(java.lang.String baseUri)

Getting baseUri setter.

Parameters:

baseUri - of request.

Returns:

Setter instance.

contentType

public static Setter contentType(ContentType type)

Get content type setter.

Parameters:

type - Content type of the request.

Returns:

Setter instance.

contentType

public static Setter contentType(java.lang.String type)

Get content type setter.

Parameters:

type - Content type of the request.

Returns:

Setter instance.

param

public static 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 static 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 static 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 static 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 static 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 static 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 static Setter cookie(java.lang.String name)

Get cookie setter.

Parameters:

name - Name of cookie.

Returns:

Setter instance.

header

public static 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 static Setter body(java.lang.String body)

Get requestSpecification body setter.

Parameters:

body - Body of requestSpecification.

Returns:

Setter instance.

body

public static Setter body(java.io.Serializable body)

Get requestSpecification body setter.

Parameters:

body - Body of requestSpecification.

Returns:

Setter instance.

protocol

public static Setter protocol(java.lang.String protocol)

Get requestSpecification protocol setter.

Parameters:

protocol - Protocol of requestSpecification.

Returns:

Setter instance.

host

public static Setter host(java.lang.String host)

Get requestSpecification host setter.

Parameters:

host - Host of requestSpecification.

Returns:

Setter instance.

path

public static Setter path(java.lang.String path)

Get requestSpecification path setter.

Parameters:

path - Path of requestSpecification.

Returns:

Setter instance.

port

public static Setter port(int port)

Get requestSpecification port setter.

Parameters:

port - Port of requestSpecification.

Returns:

Setter instance.

pathParam

public static 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 static 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 static 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 static Setter multiPart(java.io.File file)

Get multi part setter.

Parameters:

file - File to upload.

Returns:

Setter instance.

multiPart

public static 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 static Setter multiPart(io.restassured.specification.MultiPartSpecification multiPartSpecification)

Get multi part setter.

Parameters:

multiPartSpecification - Multi part specification of your request.

Returns:

Setter instance.

redirects

public static Setter redirects(int max)

Get redirect setter.

Parameters:

max - Maximum count of redirects.

Returns:

Setter instance.

redirects

public static Setter redirects(boolean follow)

Get redirect setter.

Parameters:

follow - Follow redirects.

Returns:

Setter instance.

accept

public static Setter accept(java.lang.String mediaType)

Get accept setter.

Parameters:

mediaType - Media type of request.

Returns:

Setter instance.

accept

public static Setter accept(ContentType contentType)

Getting accept setter.

Parameters:

contentType - Content type of request.

Returns:

Setter instance.

urlEncodingEnabled

public static 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 static 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 static 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 static Setter oauth2(java.lang.String token)

Set all OAuth 2.0 authentication settings.

Returns:

Setter instance.

noAuth

public static Setter noAuth()

Clear all authentication settings.

Returns:

Setter instance.

parser

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

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

Returns:

Setter instance.

defaultParser

public static 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.