io.restassured.internal.filter

Class FormAuthFilter

java.lang.Object

io.restassured.internal.filter.FormAuthFilter

All Implemented Interfaces:

groovy.lang.GroovyObject, Filter, AuthFilter

public class FormAuthFilter
extends Object
implements AuthFilter, groovy.lang.GroovyObject

Constructor Summary

Constructors

Constructor and Description
FormAuthFilter()

Method Summary

Modifier and Type	Method and Description
static void	applySessionFilterFromOriginalRequestIfDefined(FilterableRequestSpecification requestSpec, RequestSpecification loginRequestSpec)
Response	filter(FilterableRequestSpecification requestSpec, FilterableResponseSpecification responseSpec, FilterContext ctx) Filter the incoming request and response specifications and outgoing response.
FormAuthConfig	getFormAuthConfig()
groovy.lang.MetaClass	getMetaClass()
Object	getPassword()
SessionConfig	getSessionConfig()
Object	getUserName()
static Object	nullIfException(groovy.lang.Closure closure)
void	setFormAuthConfig(FormAuthConfig value)
void	setMetaClass(groovy.lang.MetaClass mc)
void	setPassword(Object value)
void	setSessionConfig(SessionConfig value)
void	setUserName(Object value)
static Object	throwIfException(groovy.lang.Closure closure)

Methods inherited from class java.lang.Object

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

Methods inherited from interface groovy.lang.GroovyObject

getProperty, invokeMethod, setProperty

Constructor Detail

FormAuthFilter

public FormAuthFilter()

Method Detail

getUserName

public Object getUserName()

setUserName

public void setUserName(Object value)

getPassword

public Object getPassword()

setPassword

public void setPassword(Object value)

getFormAuthConfig

public FormAuthConfig getFormAuthConfig()

setFormAuthConfig

public void setFormAuthConfig(FormAuthConfig value)

getSessionConfig

public SessionConfig getSessionConfig()

setSessionConfig

public void setSessionConfig(SessionConfig value)

filter

public Response filter(FilterableRequestSpecification requestSpec,
                       FilterableResponseSpecification responseSpec,
                       FilterContext ctx)

Description copied from interface: Filter

Filter the incoming request and response specifications and outgoing response. You need to call FilterContext.next(FilterableRequestSpecification, FilterableResponseSpecification) when you're done otherwise the request will not be delivered. It's of course possible to abort the filter chain execution by returning a Response directly.

Specified by:

filter in interface Filter

Parameters:

requestSpec - The incoming request spec

responseSpec - The incoming response spec

ctx - The filter context. You need to call FilterContext.next(FilterableRequestSpecification, FilterableResponseSpecification) when you're done otherwise the request will not be delivered.

Returns:

The response

applySessionFilterFromOriginalRequestIfDefined

public static void applySessionFilterFromOriginalRequestIfDefined(FilterableRequestSpecification requestSpec,
                                                                  RequestSpecification loginRequestSpec)

throwIfException

public static Object throwIfException(groovy.lang.Closure closure)

nullIfException

public static Object nullIfException(groovy.lang.Closure closure)

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

setMetaClass

public void setMetaClass(groovy.lang.MetaClass mc)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject