com.screenscraper.http.models

Class ScrapingRequest.Builder

java.lang.Object

com.screenscraper.http.models.ScrapingRequest.Builder

Enclosing class:

ScrapingRequest

public static class ScrapingRequest.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder() Creates the builder

Method Summary

Modifier and Type	Method and Description
ScrapingRequest.Builder	addGetParameter(java.lang.String key, java.lang.String value) Sets the value
ScrapingRequest.Builder	addHeader(java.lang.String name, java.lang.String value) Sets the value
ScrapingRequest.Builder	addHint(ScrapingHint hint) Sets the value
ScrapingRequest.Builder	addInferredHeader(java.lang.String name, java.lang.String value) Sets the value.
ScrapingRequest.Builder	addPostParameter(java.lang.String key, java.io.File value) Sets the value
ScrapingRequest.Builder	addPostParameter(java.lang.String key, java.lang.String value) Sets the value
ScrapingRequest	build() Builds and returns the request object
java.lang.String	getBasicAuthenticationPassword() Returns the BasicAuthenticationPassword for the object
java.lang.String	getBasicAuthenticationUsername() Returns the BasicAuthenticationUsername for the object
java.lang.String	getBasicNtlmAuthenticationDomain() Returns the BasicNtlmAuthenticationDomain for the object
java.lang.String	getBasicNtlmAuthenticationHost() Returns the BasicNtlmAuthenticationHost for the object
java.lang.String	getCharacterEncoding() Returns the CharacterEncoding for the object
java.lang.String	getEntity() Returns the Entity for the object
java.util.List<RequestParameter>	getGetParameters() Returns the GetParameters for the object
java.util.Set<ScrapingHttpHeader>	getHeaders() Returns the Headers for the object
java.util.Set<ScrapingHttpHeader>	getInferredHeaders() Returns the InferredHeaders for the object
java.lang.String	getLoggableName() Returns the LoggableName for the object
int	getMaxResponseLength() Returns the MaxResponseLength for the object
java.util.List<RequestParameter>	getPostParameters() Returns the PostParameters for the object
java.util.Set<ScrapingHint>	getRequestHints() Returns the RequestHints for the object
java.io.OutputStream	getResponseBodyOutputStream() The response body output stream for the object.
ScrapingRequest.Type	getType() Returns the Type for the object
java.lang.String	getUrl() Returns the Url for the object
boolean	isMultipart() Returns the Multipart for the object
ScrapingRequest.Builder	setBasicAuthenticationPassword(java.lang.String basicAuthenticationPassword) Sets the value
ScrapingRequest.Builder	setBasicAuthenticationUsername(java.lang.String basicAuthenticationUsername) Sets the value
ScrapingRequest.Builder	setCharacterEncoding(java.lang.String characterEncoding) Sets the value
ScrapingRequest.Builder	setEntity(java.lang.String entity) Sets the entity
ScrapingRequest.Builder	setLoggableName(java.lang.String loggableName) Sets the name used to represent this request when logging
ScrapingRequest.Builder	setMaxResponseLength(int maxResponseLength) Sets the max length for the response
ScrapingRequest.Builder	setMultipart(boolean multipart) Sets the value
ScrapingRequest.Builder	setNtlmAuthenticationDomain(java.lang.String basicNtlmAuthenticationDomain) Sets the value
ScrapingRequest.Builder	setNtlmAuthenticationHost(java.lang.String basicNtlmAuthenticationHost) Sets the value
ScrapingRequest.Builder	setResponseBodyOutputStream(java.io.OutputStream out) Sets the response body output stream for the object.
ScrapingRequest.Builder	setType(ScrapingRequest.Type type) Sets the request type
ScrapingRequest.Builder	setUrl(java.lang.String url) Sets the url

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Creates the builder

Method Detail

setLoggableName

public ScrapingRequest.Builder setLoggableName(@Nullable
                                               java.lang.String loggableName)

Sets the name used to represent this request when logging

Parameters:

loggableName - The name for logging

Returns:

The Builder for chaining method calls

setUrl

public ScrapingRequest.Builder setUrl(@Nullable
                                      java.lang.String url)

Sets the url

Parameters:

url - The url

Returns:

The Builder for chaining method calls

setEntity

public ScrapingRequest.Builder setEntity(@Nullable
                                         java.lang.String entity)

Sets the entity

Parameters:

entity - The entity

Returns:

The Builder for chaining method calls

setType

public ScrapingRequest.Builder setType(@NotNull
                                       ScrapingRequest.Type type)

Sets the request type

Parameters:

type - The request type

Returns:

The Builder for chaining method calls

setMaxResponseLength

public ScrapingRequest.Builder setMaxResponseLength(int maxResponseLength)

Sets the max length for the response

Parameters:

maxResponseLength - The max length for the response

Returns:

The Builder for chaining method calls

setBasicAuthenticationUsername

public ScrapingRequest.Builder setBasicAuthenticationUsername(@Nullable
                                                              java.lang.String basicAuthenticationUsername)

Sets the value

Parameters:

basicAuthenticationUsername - The value

Returns:

The Builder for chaining method calls

setBasicAuthenticationPassword

public ScrapingRequest.Builder setBasicAuthenticationPassword(@Nullable
                                                              java.lang.String basicAuthenticationPassword)

Sets the value

Parameters:

basicAuthenticationPassword - The value

Returns:

The Builder for chaining method calls

setNtlmAuthenticationDomain

public ScrapingRequest.Builder setNtlmAuthenticationDomain(@Nullable
                                                           java.lang.String basicNtlmAuthenticationDomain)

Sets the value

Parameters:

basicNtlmAuthenticationDomain - The value

Returns:

The Builder for chaining method calls

setNtlmAuthenticationHost

public ScrapingRequest.Builder setNtlmAuthenticationHost(@Nullable
                                                         java.lang.String basicNtlmAuthenticationHost)

Sets the value

Parameters:

basicNtlmAuthenticationHost - The value

Returns:

The Builder for chaining method calls

setCharacterEncoding

public ScrapingRequest.Builder setCharacterEncoding(@NotNull
                                                    java.lang.String characterEncoding)

Sets the value

Parameters:

characterEncoding - The value

Returns:

The Builder for chaining method calls

addGetParameter

public ScrapingRequest.Builder addGetParameter(@NotNull
                                               java.lang.String key,
                                               @NotNull
                                               java.lang.String value)

Sets the value

Parameters:

key - The key

value - The value

Returns:

The Builder for chaining method calls

addPostParameter

public ScrapingRequest.Builder addPostParameter(@NotNull
                                                java.lang.String key,
                                                @NotNull
                                                java.lang.String value)

Sets the value

Parameters:

key - The key

value - The value

Returns:

The Builder for chaining method calls

addPostParameter

public ScrapingRequest.Builder addPostParameter(@NotNull
                                                java.lang.String key,
                                                @NotNull
                                                java.io.File value)

Sets the value

Parameters:

key - The key

value - The value

Returns:

The Builder for chaining method calls

addHint

public ScrapingRequest.Builder addHint(@NotNull
                                       ScrapingHint hint)

Sets the value

Parameters:

hint - The value

Returns:

The Builder for chaining method calls

setMultipart

public ScrapingRequest.Builder setMultipart(boolean multipart)

Sets the value

Parameters:

multipart - The value

Returns:

The Builder for chaining method calls

addInferredHeader

public ScrapingRequest.Builder addInferredHeader(@NotNull
                                                 java.lang.String name,
                                                 @NotNull
                                                 java.lang.String value)

Sets the value. An inferred header is one that we set a value based on other parameters, but clients may choose to ignore or override (it wasn't explicitly set anywhere)

Parameters:

name - The name

value - The value

Returns:

The Builder for chaining method calls

addHeader

public ScrapingRequest.Builder addHeader(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String value)

Sets the value

Parameters:

name - The name

value - The value

Returns:

The Builder for chaining method calls

build

public ScrapingRequest build()

Builds and returns the request object

Returns:

The actual request object to issue

getBasicAuthenticationUsername

@Nullable
public java.lang.String getBasicAuthenticationUsername()

Returns the BasicAuthenticationUsername for the object

Returns:

The BasicAuthenticationUsername for the object

getBasicAuthenticationPassword

@Nullable
public java.lang.String getBasicAuthenticationPassword()

Returns the BasicAuthenticationPassword for the object

Returns:

The BasicAuthenticationPassword for the object

getCharacterEncoding

@NotNull
public java.lang.String getCharacterEncoding()

Returns the CharacterEncoding for the object

Returns:

The CharacterEncoding for the object

isMultipart

public boolean isMultipart()

Returns the Multipart for the object

Returns:

The Multipart for the object

getUrl

@Nullable
public java.lang.String getUrl()

Returns the Url for the object

Returns:

The Url for the object

getGetParameters

@NotNull
public java.util.List<RequestParameter> getGetParameters()

Returns the GetParameters for the object

Returns:

The GetParameters for the object

getPostParameters

@NotNull
public java.util.List<RequestParameter> getPostParameters()

Returns the PostParameters for the object

Returns:

The PostParameters for the object

getEntity

@Nullable
public java.lang.String getEntity()

Returns the Entity for the object

Returns:

The Entity for the object

getHeaders

@NotNull
public java.util.Set<ScrapingHttpHeader> getHeaders()

Returns the Headers for the object

Returns:

The Headers for the object

getType

@NotNull
public ScrapingRequest.Type getType()

Returns the Type for the object

Returns:

The Type for the object

getLoggableName

@Nullable
public java.lang.String getLoggableName()

Returns the LoggableName for the object

Returns:

The LoggableName for the object

setResponseBodyOutputStream

public ScrapingRequest.Builder setResponseBodyOutputStream(@Nullable
                                                           java.io.OutputStream out)

Sets the response body output stream for the object. When set to a non-null value, the response will be written to this stream INSTEAD of to a response object. Note this stream should be closed externally

Parameters:

out - The new output stream for the response body (excluding headers)

Returns:

The output stream for the response body for the object

getResponseBodyOutputStream

@Nullable
public java.io.OutputStream getResponseBodyOutputStream()

The response body output stream for the object. When set to a non-null value, the response will be written to this stream INSTEAD of to a response object

Returns:

The output stream for the response body for the object

getInferredHeaders

@NotNull
public java.util.Set<ScrapingHttpHeader> getInferredHeaders()

Returns the InferredHeaders for the object

Returns:

The InferredHeaders for the object

getRequestHints

@NotNull
public java.util.Set<ScrapingHint> getRequestHints()

Returns the RequestHints for the object

Returns:

The RequestHints for the object

getBasicNtlmAuthenticationDomain

@Nullable
public java.lang.String getBasicNtlmAuthenticationDomain()

Returns the BasicNtlmAuthenticationDomain for the object

Returns:

The BasicNtlmAuthenticationDomain for the object

getBasicNtlmAuthenticationHost

@Nullable
public java.lang.String getBasicNtlmAuthenticationHost()

Returns the BasicNtlmAuthenticationHost for the object

Returns:

The BasicNtlmAuthenticationHost for the object

getMaxResponseLength

public int getMaxResponseLength()

Returns the MaxResponseLength for the object

Returns:

The MaxResponseLength for the object