ai.preferred.venom.request

Class BasicRequest.Builder<T extends BasicRequest.Builder<T>>

java.lang.Object

ai.preferred.venom.request.BasicRequest.Builder<T>

Enclosing class:

BasicRequest

public static class BasicRequest.Builder<T extends BasicRequest.Builder<T>>
extends Object

A builder for BasicRequest class

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(Request.Method method, String url)

Method Summary

Modifier and Type	Method and Description
T	addHeader(String name, String value) Adds header to be used
T	addHeaders(Map<String,String> headers) Add headers to be used
BasicRequest	build() Builds the request with the options specified.
static BasicRequest.Builder	delete(String url) Creates a new instance of builder with method type delete.
static BasicRequest.Builder	get(String url) Creates a new instance of builder with method type get.
static BasicRequest.Builder	head(String url) Creates a new instance of builder with method type head.
static BasicRequest.Builder	options(String url) Creates a new instance of builder with method type options.
static BasicRequest.Builder	post(String url) Creates a new instance of builder with method type post.
static BasicRequest.Builder	put(String url) Creates a new instance of builder with method type put.
T	removeHeader(String name)
T	removeHeaders()
T	setBody(String body) Sets the request body to be used.
T	setProxy(org.apache.http.HttpHost proxy) Sets the proxy to be used, this will override the proxy selected in Fetcher for this request.
T	setSleepScheduler(SleepScheduler scheduler) Sets the sleep scheduler to be used, this will override the sleep scheduler defined in AsyncCrawler for this request.
T	setUrl(String url) Sets the url to be fetched.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder(Request.Method method,
                  String url)

Method Detail

get

public static BasicRequest.Builder get(String url)

Creates a new instance of builder with method type get.

Parameters:

url - url to fetch.

Returns:

an instance of builder.

post

public static BasicRequest.Builder post(String url)

Creates a new instance of builder with method type post.

Parameters:

url - url to fetch.

Returns:

an instance of builder.

head

public static BasicRequest.Builder head(String url)

Creates a new instance of builder with method type head.

Parameters:

url - url to fetch.

Returns:

an instance of builder.

put

public static BasicRequest.Builder put(String url)

Creates a new instance of builder with method type put.

Parameters:

url - url to fetch.

Returns:

an instance of builder.

delete

public static BasicRequest.Builder delete(String url)

Creates a new instance of builder with method type delete.

Parameters:

url - url to fetch.

Returns:

an instance of builder.

options

public static BasicRequest.Builder options(String url)

Creates a new instance of builder with method type options.

Parameters:

url - url to fetch.

Returns:

an instance of builder.

setBody

public T setBody(String body)

Sets the request body to be used.

Parameters:

body - request body

Returns:

this.

setSleepScheduler

public T setSleepScheduler(SleepScheduler scheduler)

Sets the sleep scheduler to be used, this will override the sleep scheduler defined in AsyncCrawler for this request. Defaults to none.

Parameters:

scheduler - sleep scheduler to be used.

Returns:

this.

setProxy

public T setProxy(org.apache.http.HttpHost proxy)

Sets the proxy to be used, this will override the proxy selected in Fetcher for this request. Defaults to none.

Parameters:

proxy - proxy to be used.

Returns:

this.

removeHeader

public T removeHeader(String name)

removeHeaders

public T removeHeaders()

addHeaders

public T addHeaders(Map<String,String> headers)

Add headers to be used

This will merge with headers set in AsyncCrawler class. If a same key is found, this will override that header in AsyncCrawler class.

Parameters:

headers - request headers

Returns:

this.

addHeader

public T addHeader(String name,
                   String value)

Adds header to be used

This will merge with headers set in AsyncCrawler class. If a same key is found, this will override that header in AsyncCrawler class.

Parameters:

name - name/key of the header

value - value of the header

Returns:

this.

setUrl

public T setUrl(String url)

Sets the url to be fetched.

Parameters:

url - url to fetch.

Returns:

this.

build

public BasicRequest build()

Builds the request with the options specified.

Returns:

an instance of Request.