com.github.aivancioglo.resttest.setters

Class Setters

com.github.aivancioglo.resttest.setters.Setters

public class Setters

Abstract class for using static functions to call setters.

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 using static functions to call setters.

Method Summary

Modifier and Type	Method and Description
static Setter	accept(java.lang.String mediaType) Getting media type setter.
static Setter	accept(ContentType contentType) Getting media type setter.
static Setter	basicAuth(java.lang.String userName, java.lang.String password) Use http basic authentication.
static Setter	body(java.lang.String body) Getting requestSpecification body setter.
static Setter	body(java.io.Serializable body) Getting requestSpecification body setter.
static Setter	contentType(ContentType type) Getting content type setter.
static Setter	contentType(java.lang.String type) Getting content type setter.
static Setter	cookie(java.lang.String name, java.lang.String value, java.lang.String additionalValues) Getting cookie setter.
static Setter	cookie(java.lang.String name, java.lang.String value) Getting cookie setter.
static Setter	cookie(java.lang.String name) Getting cookie setter.
static Setter	formParam(java.lang.String key, java.lang.Object value) Getting form param setter.
static Setter	header(java.lang.String name, java.lang.String value) Getting header setter.
static Setter	host(java.lang.String host) Getting requestSpecification host setter.
static Setter	multiPart(java.lang.String controlName, java.lang.String fileName, java.io.InputStream stream) Getting multi part setter.
static Setter	multiPart(java.lang.String controlName, java.lang.String fileName, java.io.InputStream stream, java.lang.String mimeType) Getting multi part setter.
static Setter	multiPart(java.io.File file) Getting multi part setter.
static Setter	multiPart(java.lang.String controlName, java.io.File file) Getting multi part setter.
static Setter	multiPart(io.restassured.specification.MultiPartSpecification multiPartSpecification) Getting 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) Getting param setter.
static Setter	path(java.lang.String path) Getting requestSpecification path setter.
static Setter	pathParam(java.lang.String key, java.lang.Object value) Getting path param setter.
static Setter	port(int port) Getting requestSpecification port setter.
static Setter	protocol(java.lang.String protocol) Getting requestSpecification protocol setter.
static Setter	queryParam(java.lang.String key, java.lang.Object value) Getting query param setter.
static Setter	redirects(int max) Getting redirect setter.
static Setter	redirects(boolean follow) Getting redirect setter.
static Setter	urlEncodingEnabled(boolean isEnabled) Specifies if RestTest should url encode the URL automatically. Usually this is a 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 using static functions to call setters.

Method Detail

contentType

public static Setter contentType(ContentType type)

Getting content type setter.

Parameters:

type - of content.

Returns:

Setter instance.

contentType

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

Getting content type setter.

Parameters:

type - of content.

Returns:

Setter instance.

param

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

Getting param setter.

Parameters:

key - of param.

value - of param.

Returns:

Setter instance.

queryParam

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

Getting query param setter.

Parameters:

key - of query param.

value - of query param.

Returns:

Setter instance.

formParam

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

Getting form param setter.

Parameters:

key - of form param.

value - of form param.

Returns:

Setter instance.

cookie

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

Getting cookie setter.

Parameters:

name - of header.

value - of header.

Returns:

Setter instance.

cookie

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

Getting cookie setter.

Parameters:

name - of header.

value - of header.

Returns:

Setter instance.

cookie

public static Setter cookie(java.lang.String name)

Getting cookie setter.

Parameters:

name - of header.

Returns:

Setter instance.

header

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

Getting header setter.

Parameters:

name - of header.

value - of header.

Returns:

Setter instance.

body

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

Getting requestSpecification body setter.

Parameters:

body - of requestSpecification.

Returns:

Setter instance.

body

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

Getting requestSpecification body setter.

Parameters:

body - of requestSpecification.

Returns:

Setter instance.

protocol

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

Getting requestSpecification protocol setter.

Parameters:

protocol - of requestSpecification.

Returns:

Setter instance.

host

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

Getting requestSpecification host setter.

Parameters:

host - of requestSpecification.

Returns:

Setter instance.

path

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

Getting requestSpecification path setter.

Parameters:

path - of requestSpecification.

Returns:

Setter instance.

port

public static Setter port(int port)

Getting requestSpecification port setter.

Parameters:

port - of requestSpecification.

Returns:

Setter instance.

pathParam

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

Getting path param setter.

Parameters:

key - of path param.

value - of path param.

Returns:

Setter instance.

multiPart

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

Getting multi part setter.

Parameters:

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

fileName - of the content you're uploading.

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)

Getting multi part setter.

Parameters:

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

fileName - of the content you're uploading.

stream - you want to requestSpecification.

mimeType - The mime-type

Returns:

Setter instance.

multiPart

public static Setter multiPart(java.io.File file)

Getting multi part setter.

Parameters:

file - to upload

Returns:

Setter instance.

multiPart

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

Getting multi part setter.

Parameters:

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)

Getting multi part setter.

Parameters:

multiPartSpecification - of yur request.

Returns:

Setter instance.

redirects

public static Setter redirects(int max)

Getting redirect setter.

Parameters:

max - count of redirects.

Returns:

Setter instance.

redirects

public static Setter redirects(boolean follow)

Getting redirect setter.

Parameters:

follow - redirects.

Returns:

Setter instance.

accept

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

Getting media type setter.

Parameters:

mediaType - of request.

Returns:

Setter instance.

accept

public static Setter accept(ContentType contentType)

Getting media type setter.

Parameters:

contentType - of request.

Returns:

Setter instance.

urlEncodingEnabled

public static Setter urlEncodingEnabled(boolean isEnabled)

Specifies if RestTest should url encode the URL automatically. Usually this is a 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 - URL encoding or disabled.

Returns:

Setter instance.

basicAuth

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

Use http basic authentication.

Parameters:

userName - of your account.

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.