ScrapingRequest

java.lang.Object
- com.screenscraper.http.models.ScrapingRequest

public class ScrapingRequest
extends java.lang.Object

A request that will be issued

Version:: 1.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ScrapingRequest.Builder

static class ScrapingRequest.Type
The types of requests that can be issued

Nested Classes
Modifier and Type	Class and Description
`static class`	`ScrapingRequest.Builder`
`static class`	`ScrapingRequest.Type` The types of requests that can be issued

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getActualEntity()` Returns the actual request entity that was sent, or null if it wasn't set by the client that sent the request
`java.net.URL`	`getActualRequestURL()` Gets the actual URL that was requested, or null if the client never updated it or the request hasn't been issued yet
`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 Inferred Headers for the object.
`java.lang.String`	`getLoggableName()` Returns the LoggableName for the object
`int`	`getMaxResponseLength()` Returns the MaxResponseLength for the object
`java.io.OutputStream`	`getOutputStream()` Returns the OutputStream for the object (when set output should be written here instead of to the response)
`java.util.List<RequestParameter>`	`getPostParameters()` Returns the PostParameters for the object.
`java.util.Set<ScrapingHint>`	`getRequestHints()` Returns the RequestHints for the object
`ScrapingRequest.Type`	`getType()` Returns the Type for the object
`java.lang.String`	`getUrl()` Returns the Url for the object
`boolean`	`hasHint(ScrapingHint hint)` Returns if the request has the given hint or not
`boolean`	`isMultipart()` Returns if this is a multipart request
`void`	`setActualEntity(java.lang.String actualEntity)` Sets the actual entity that was sent
`void`	`setActualRequestString(java.lang.String requestString)` Sets the request string used (this includes headers, entity, etc...).
`void`	`setActualRequestURL(java.net.URL actualRequestURL)` Sets the actual URL that was requested
`java.lang.String`	`toSentRequestString()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getUrl
```
@NotNull
public java.lang.String getUrl()
```
    Returns the Url for the object
    
    Returns:
    
    The Url for the object
  - 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
  - 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
  - getGetParameters
```
@NotNull
public java.util.List<RequestParameter> getGetParameters()
```
    Returns the GetParameters for the object. This returns the actual collection (and can be modified). This is intentional, so classes uses the request can update it with anything they may add in, such as authentication parameters, headers, etc...
    
    Returns:
    
    The GetParameters for the object
  - getPostParameters
```
@NotNull
public java.util.List<RequestParameter> getPostParameters()
```
    Returns the PostParameters for the object. This returns the actual collection (and can be modified). This is intentional, so classes uses the request can update it with anything they may add in, such as authentication parameters, headers, etc...
    
    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. This returns the actual collection (and can be modified). This is intentional, so classes uses the request can update it with anything they may add in, such as authentication parameters, headers, etc...
    
    Returns:
    
    The Headers for the object
  - getInferredHeaders
```
@NotNull
public java.util.Set<ScrapingHttpHeader> getInferredHeaders()
```
    Returns the Inferred Headers for the object. This returns the actual collection (and can be modified). This is intentional, so classes uses the request can update it with anything they may add in, such as authentication parameters, headers, etc...
    An inferred header is one screen-scraper decided to add by looking at parameters and entities. Some clients may handle this on their own, so won't need the inferred values
    
    Returns:
    
    The Headers for the object
  - getType
```
@NotNull
public ScrapingRequest.Type getType()
```
    Returns the Type for the object
    
    Returns:
    
    The Type for the object
  - getOutputStream
```
public java.io.OutputStream getOutputStream()
```
    Returns the OutputStream for the object (when set output should be written here instead of to the response)
    
    Returns:
    
    The OutputStream for the object (when set output should be written here instead of to the response)
  - isMultipart
```
public boolean isMultipart()
```
    Returns if this is a multipart request
    
    Returns:
    
    True if this is a multipart request
  - getMaxResponseLength
```
public int getMaxResponseLength()
```
    Returns the MaxResponseLength for the object
    
    Returns:
    
    The MaxResponseLength for the object
  - getRequestHints
```
@NotNull
public java.util.Set<ScrapingHint> getRequestHints()
```
    Returns the RequestHints for the object
    
    Returns:
    
    The RequestHints for the object
  - hasHint
```
public boolean hasHint(@NotNull
                       ScrapingHint hint)
```
    Returns if the request has the given hint or not
    
    Parameters:
    
    hint - The hint in question
    
    Returns:
    
    True if this hint is present for the request
  - getLoggableName
```
@NotNull
public java.lang.String getLoggableName()
```
    Returns the LoggableName for the object
    
    Returns:
    
    The LoggableName for the object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getCharacterEncoding
```
@NotNull
public java.lang.String getCharacterEncoding()
```
    Returns the CharacterEncoding for the object
    
    Returns:
    
    The CharacterEncoding for the object
  - setActualRequestString
```
public void setActualRequestString(@NotNull
                                   java.lang.String requestString)
```
    Sets the request string used (this includes headers, entity, etc...). If this isn't set a default is built from the data in the request, but it it's more
    convenient if the implementing HTTP client can provide one so it more accurately reflects the actual request that was sent
    
    Parameters:
    
    requestString - The actual request sent (or that would be sent)
  - getActualEntity
```
@Nullable
public java.lang.String getActualEntity()
```
    Returns the actual request entity that was sent, or null if it wasn't set by the client that sent the request
    
    Returns:
    
    The actual entity sent (or null if it wasn't set by the client)
  - setActualEntity
```
public void setActualEntity(@NotNull
                            java.lang.String actualEntity)
```
    Sets the actual entity that was sent
    
    Parameters:
    
    actualEntity - The actual entity that was sent
  - getActualRequestURL
```
@Nullable
public java.net.URL getActualRequestURL()
```
    Gets the actual URL that was requested, or null if the client never updated it or the request hasn't been issued yet
    
    Returns:
    
    The actual URL that was requested, or null if the client never updated it or the request hasn't been issued yet
    
    Since:
    
    7.0.8a
  - setActualRequestURL
```
public void setActualRequestURL(@Nullable
                                java.net.URL actualRequestURL)
```
    Sets the actual URL that was requested
    
    Parameters:
    
    actualRequestURL - The actual URL that was requested, or null if it couldn't be determined
    
    Since:
    
    7.0.8a
  - toSentRequestString
```
@NotNull
public java.lang.String toSentRequestString()
```

Class ScrapingRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getUrl

getBasicAuthenticationUsername

getBasicAuthenticationPassword

getBasicNtlmAuthenticationDomain

getBasicNtlmAuthenticationHost

getGetParameters

getPostParameters

getEntity

getHeaders

getInferredHeaders

getType

getOutputStream

isMultipart

getMaxResponseLength

getRequestHints

hasHint

getLoggableName

toString

getCharacterEncoding

setActualRequestString

getActualEntity

setActualEntity

getActualRequestURL

setActualRequestURL

toSentRequestString