org.zaproxy.zap.spider.parser

Class SpiderResourceFound.Builder

java.lang.Object

org.zaproxy.zap.spider.parser.SpiderResourceFound.Builder

Enclosing class:

SpiderResourceFound

public static class SpiderResourceFound.Builder
extends Object

Builder of SpiderResourceFound.

Method Summary

Modifier and Type	Method and Description
SpiderResourceFound	build() Builds a new SpiderResourceFound, with the configurations previously set.
SpiderResourceFound.Builder	setBody(String body) Sets the request body for the resource found.
SpiderResourceFound.Builder	setDepth(int depth) Sets the spider depth for the resource found.
SpiderResourceFound.Builder	setHeaders(List<HttpHeaderField> headers) Sets additional request headers for the resource found.
SpiderResourceFound.Builder	setMessage(HttpMessage message) Sets the message where the resource was found.
SpiderResourceFound.Builder	setMethod(String method) Sets the method for the resource found.
SpiderResourceFound.Builder	setShouldIgnore(boolean shouldIgnore) Sets a flag whether the resource should be ignored.
SpiderResourceFound.Builder	setUri(String uri) Sets the URI for the resource found.

Methods inherited from class java.lang.Object

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

Method Detail

setMessage

public SpiderResourceFound.Builder setMessage(HttpMessage message)

Sets the message where the resource was found.

Parameters:

message - HTTP message where the resource as found (null allowed).

Returns:

the builder.

setDepth

public SpiderResourceFound.Builder setDepth(int depth)

Sets the spider depth for the resource found.

Parameters:

depth - Spider depth for resource.

Returns:

the builder.

Throws:

IllegalArgumentException - if the given parameter is negative.

setMethod

public SpiderResourceFound.Builder setMethod(String method)

Sets the method for the resource found.

Parameters:

method - Method for resource found.

Returns:

the builder.

Throws:

IllegalArgumentException - if the given parameter is null.

setUri

public SpiderResourceFound.Builder setUri(String uri)

Sets the URI for the resource found.

Parameters:

uri - URI for resource found.

Returns:

the builder.

Throws:

IllegalArgumentException - if the given parameter is null.

setBody

public SpiderResourceFound.Builder setBody(String body)

Sets the request body for the resource found.

Parameters:

body - Body for resource found.

Returns:

the builder.

Throws:

IllegalArgumentException - if the given parameter is null.

setShouldIgnore

public SpiderResourceFound.Builder setShouldIgnore(boolean shouldIgnore)

Sets a flag whether the resource should be ignored.

Parameters:

shouldIgnore - Flag for resource found to be ignored.

Returns:

the builder.

setHeaders

public SpiderResourceFound.Builder setHeaders(List<HttpHeaderField> headers)

Sets additional request headers for the resource found. Only valid header fields (i.e. name not null and not empty, value not null) will be added.

Parameters:

headers - Additional request headers for resource found.

Returns:

the builder.

Throws:

IllegalArgumentException - if the given parameter is null or an element is null.

build

public SpiderResourceFound build()

Builds a new SpiderResourceFound, with the configurations previously set.

Returns:

a new SpiderResourceFound.