Site (webmagic-core 0.6.1 API)

java.lang.Object
- us.codecraft.webmagic.Site

```
public class Site
extends Object
```
Object contains setting for crawler.

从以下版本开始:

0.1.0

作者:

code4crafter@gmail.com

另请参阅:

PageProcessor

嵌套类概要

嵌套类
限定符和类型类和说明

static interface Site.HeaderConst
已过时。

嵌套类
限定符和类型	类和说明
`static interface`	`Site.HeaderConst` 已过时。

构造器概要

构造器
构造器和说明

Site()

构造器
构造器和说明
`Site()`

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`Site`	`addCookie(String name, String value)` Add a cookie with domain `getDomain()`
`Site`	`addCookie(String domain, String name, String value)` Add a cookie with specific domain.
`Site`	`addHeader(String key, String value)` Put an Http header for downloader.
`Site`	`addStartRequest(Request startRequest)` 已过时。
`Site`	`addStartUrl(String startUrl)` 已过时。
`Site`	`enableHttpProxyPool()`
`boolean`	`equals(Object o)`
`Set<Integer>`	`getAcceptStatCode()` get acceptStatCode
`Map<String,Map<String,String>>`	`getAllCookies()` get cookies of all domains
`String`	`getCharset()` get charset set manually
`Map<String,String>`	`getCookies()` get cookies
`int`	`getCycleRetryTimes()` When cycleRetryTimes is more than 0, it will add back to scheduler and try download again.
`String`	`getDomain()` get domain
`Map<String,String>`	`getHeaders()`
`org.apache.http.HttpHost`	`getHttpProxy()`
`Proxy`	`getHttpProxyFromPool()`
`ProxyPool`	`getHttpProxyPool()`
`int`	`getRetrySleepTime()`
`int`	`getRetryTimes()` Get retry times immediately when download fail, 0 by default.
`int`	`getSleepTime()` Get the interval between the processing of two pages.
`List<Request>`	`getStartRequests()`
`List<String>`	`getStartUrls()` 已过时。
`int`	`getTimeOut()`
`String`	`getUserAgent()` get user agent
`org.apache.http.auth.UsernamePasswordCredentials`	`getUsernamePasswordCredentials()`
`int`	`hashCode()`
`boolean`	`isUseGzip()`
`static Site`	`me()` new a Site
`void`	`returnHttpProxyToPool(org.apache.http.HttpHost proxy, int statusCode)`
`Site`	`setAcceptStatCode(Set<Integer> acceptStatCode)` Set acceptStatCode.
`Site`	`setCharset(String charset)` Set charset of page manually.
`Site`	`setCycleRetryTimes(int cycleRetryTimes)` Set cycleRetryTimes times when download fail, 0 by default.
`Site`	`setDomain(String domain)` set the domain of site.
`Site`	`setHttpProxy(org.apache.http.HttpHost httpProxy)` set up httpProxy for this site
`Site`	`setHttpProxyPool(List<String[]> httpProxyList, boolean isUseLastProxy)` Set httpProxyPool, String[0]:ip, String[1]:port
`Site`	`setHttpProxyPool(ProxyPool proxyPool)` Set httpProxyPool, String[0]:ip, String[1]:port
`Site`	`setRetrySleepTime(int retrySleepTime)` Set retry sleep times when download fail, 1000 by default.
`Site`	`setRetryTimes(int retryTimes)` Set retry times when download fail, 0 by default.
`Site`	`setSleepTime(int sleepTime)` Set the interval between the processing of two pages.
`Site`	`setTimeOut(int timeOut)` set timeout for downloader in ms
`Site`	`setUseGzip(boolean useGzip)` Whether use gzip.
`Site`	`setUserAgent(String userAgent)` set user agent
`Site`	`setUsernamePasswordCredentials(org.apache.http.auth.UsernamePasswordCredentials usernamePasswordCredentials)`
`String`	`toString()`
`Task`	`toTask()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - Site
```
public Site()
```
- 方法详细资料
  - me
```
public static Site me()
```
    new a Site
    
    返回:
    
    new site
  - addCookie
```
public Site addCookie(String name,
                      String value)
```
    Add a cookie with domain getDomain()
    
    参数:
    
    name - name
    
    value - value
    
    返回:
    
    this
  - addCookie
```
public Site addCookie(String domain,
                      String name,
                      String value)
```
    Add a cookie with specific domain.
    
    参数:
    
    domain - domain
    
    name - name
    
    value - value
    
    返回:
    
    this
  - setUserAgent
```
public Site setUserAgent(String userAgent)
```
    set user agent
    
    参数:
    
    userAgent - userAgent
    
    返回:
    
    this
  - getCookies
```
public Map<String,String> getCookies()
```
    get cookies
    
    返回:
    
    get cookies
  - getAllCookies
```
public Map<String,Map<String,String>> getAllCookies()
```
    get cookies of all domains
    
    返回:
    
    get cookies
  - getUserAgent
```
public String getUserAgent()
```
    get user agent
    
    返回:
    
    user agent
  - getDomain
```
public String getDomain()
```
    get domain
    
    返回:
    
    get domain
  - setDomain
```
public Site setDomain(String domain)
```
    set the domain of site.
    
    参数:
    
    domain - domain
    
    返回:
    
    this
  - setCharset
```
public Site setCharset(String charset)
```
    Set charset of page manually.
    When charset is not set or set to null, it can be auto detected by Http header.
    
    参数:
    
    charset - charset
    
    返回:
    
    this
  - getCharset
```
public String getCharset()
```
    get charset set manually
    
    返回:
    
    charset
  - getTimeOut
```
public int getTimeOut()
```
  - setTimeOut
```
public Site setTimeOut(int timeOut)
```
    set timeout for downloader in ms
    
    参数:
    
    timeOut - timeOut
    
    返回:
    
    this
  - setAcceptStatCode
```
public Site setAcceptStatCode(Set<Integer> acceptStatCode)
```
    Set acceptStatCode.
    When status code of http response is in acceptStatCodes, it will be processed.
    {200} by default.
    It is not necessarily to be set.
    
    参数:
    
    acceptStatCode - acceptStatCode
    
    返回:
    
    this
  - getAcceptStatCode
```
public Set<Integer> getAcceptStatCode()
```
    get acceptStatCode
    
    返回:
    
    acceptStatCode
  - getStartUrls
```
@Deprecated
public List<String> getStartUrls()
```
    已过时。
    
    get start urls
    
    返回:
    
    start urls
    
    另请参阅:
    
    getStartRequests()
  - getStartRequests
```
public List<Request> getStartRequests()
```
  - addStartUrl
```
public Site addStartUrl(String startUrl)
```
    已过时。
    
    Add a url to start url.
    Because urls are more a Spider's property than Site, move it to Spider.addUrl(String...)}
    
    参数:
    
    startUrl - startUrl
    
    返回:
    
    this
    
    另请参阅:
    
    Spider.addUrl(String...)
  - addStartRequest
```
public Site addStartRequest(Request startRequest)
```
    已过时。
    
    Add a url to start url.
    Because urls are more a Spider's property than Site, move it to Spider.addRequest(Request...)}
    
    参数:
    
    startRequest - startRequest
    
    返回:
    
    this
    
    另请参阅:
    
    Spider.addRequest(Request...)
  - setSleepTime
```
public Site setSleepTime(int sleepTime)
```
    Set the interval between the processing of two pages.
    Time unit is micro seconds.
    
    参数:
    
    sleepTime - sleepTime
    
    返回:
    
    this
  - getSleepTime
```
public int getSleepTime()
```
    Get the interval between the processing of two pages.
    Time unit is micro seconds.
    
    返回:
    
    the interval between the processing of two pages,
  - getRetryTimes
```
public int getRetryTimes()
```
    Get retry times immediately when download fail, 0 by default.
    
    返回:
    
    retry times when download fail
  - getHeaders
```
public Map<String,String> getHeaders()
```
  - addHeader
```
public Site addHeader(String key,
                      String value)
```
    Put an Http header for downloader.
    Use addCookie(String, String) for cookie and setUserAgent(String) for user-agent.
    
    参数:
    
    key - key of http header, there are some keys constant in Site.HeaderConst
    
    value - value of header
    
    返回:
    
    this
  - setRetryTimes
```
public Site setRetryTimes(int retryTimes)
```
    Set retry times when download fail, 0 by default.
    
    参数:
    
    retryTimes - retryTimes
    
    返回:
    
    this
  - getCycleRetryTimes
```
public int getCycleRetryTimes()
```
    When cycleRetryTimes is more than 0, it will add back to scheduler and try download again.
    
    返回:
    
    retry times when download fail
  - setCycleRetryTimes
```
public Site setCycleRetryTimes(int cycleRetryTimes)
```
    Set cycleRetryTimes times when download fail, 0 by default.
    
    参数:
    
    cycleRetryTimes - cycleRetryTimes
    
    返回:
    
    this
  - getHttpProxy
```
public org.apache.http.HttpHost getHttpProxy()
```
  - setHttpProxy
```
public Site setHttpProxy(org.apache.http.HttpHost httpProxy)
```
    set up httpProxy for this site
    
    参数:
    
    httpProxy - httpProxy
    
    返回:
    
    this
  - isUseGzip
```
public boolean isUseGzip()
```
  - getRetrySleepTime
```
public int getRetrySleepTime()
```
  - setRetrySleepTime
```
public Site setRetrySleepTime(int retrySleepTime)
```
    Set retry sleep times when download fail, 1000 by default.
    
    参数:
    
    retrySleepTime - retrySleepTime
    
    返回:
    
    this
  - setUseGzip
```
public Site setUseGzip(boolean useGzip)
```
    Whether use gzip.
    Default is true, you can set it to false to disable gzip.
    
    参数:
    
    useGzip - useGzip
    
    返回:
    
    this
  - toTask
```
public Task toTask()
```
  - equals
```
public boolean equals(Object o)
```
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - setHttpProxyPool
```
public Site setHttpProxyPool(ProxyPool proxyPool)
```
    Set httpProxyPool, String[0]:ip, String[1]:port
    
    参数:
    
    proxyPool - proxyPool
    
    返回:
    
    this
  - setHttpProxyPool
```
public Site setHttpProxyPool(List<String[]> httpProxyList,
                             boolean isUseLastProxy)
```
    Set httpProxyPool, String[0]:ip, String[1]:port
    
    参数:
    
    httpProxyList - httpProxyList
    
    isUseLastProxy - isUseLastProxy
    
    返回:
    
    this
  - enableHttpProxyPool
```
public Site enableHttpProxyPool()
```
  - getUsernamePasswordCredentials
```
public org.apache.http.auth.UsernamePasswordCredentials getUsernamePasswordCredentials()
```
  - setUsernamePasswordCredentials
```
public Site setUsernamePasswordCredentials(org.apache.http.auth.UsernamePasswordCredentials usernamePasswordCredentials)
```
  - getHttpProxyPool
```
public ProxyPool getHttpProxyPool()
```
  - getHttpProxyFromPool
```
public Proxy getHttpProxyFromPool()
```
  - returnHttpProxyToPool
```
public void returnHttpProxyToPool(org.apache.http.HttpHost proxy,
                                  int statusCode)
```

类 Site

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

Site

方法详细资料

me

addCookie

addCookie

setUserAgent

getCookies

getAllCookies

getUserAgent

getDomain

setDomain

setCharset

getCharset

getTimeOut

setTimeOut

setAcceptStatCode

getAcceptStatCode

getStartUrls

getStartRequests

addStartUrl

addStartRequest

setSleepTime

getSleepTime

getRetryTimes

getHeaders

addHeader

setRetryTimes

getCycleRetryTimes

setCycleRetryTimes

getHttpProxy

setHttpProxy

isUseGzip

getRetrySleepTime

setRetrySleepTime

setUseGzip

toTask

equals

hashCode

toString

setHttpProxyPool

setHttpProxyPool

enableHttpProxyPool

getUsernamePasswordCredentials

setUsernamePasswordCredentials

getHttpProxyPool

getHttpProxyFromPool

returnHttpProxyToPool