HttpRequest (common 0.2.2 API)

java.lang.Object
- xyz.cofe.http.HttpRequest

```
public class HttpRequest
extends Object
```
Http Запрос

Author:

Kamnev Georgiy (nt.gocha@gmail.com)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HttpRequest.RequestCreated
Событие - создан HttpRequest объект

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpRequest.RequestCreated` Событие - создан HttpRequest объект

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`async`
`protected Integer`	`connectTimeout`
`protected ContentBuffer`	`contentBuffer`
`protected long`	`contentOffsetStart`
`protected Func1<Object,URLConnection>`	`data`
`protected boolean`	`followRedirect`
`protected HttpListenersHelper`	`httpListenerHelper`
`long`	`id` Идентификатор объекта в пределах приложения
`protected long`	`maxDownloadSize`
`protected Proxy`	`proxy` Прокси для этого запроса
`protected Integer`	`readTimeout`
`protected static AtomicLong`	`sequenceID`
`protected Object`	`sync` Объект для синхронизации

Constructor Summary

Constructors
Constructor and Description

HttpRequest(HttpRequest source)

HttpRequest(URL url, HttpClient httpClient)

Constructors
Constructor and Description
`HttpRequest(HttpRequest source)`
`HttpRequest(URL url, HttpClient httpClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Closeable`	`addListener(HttpListener listener)`
`Closeable`	`addListener(HttpListener listener, boolean weakLink)`
`void`	`applyHeadersTo(URLConnection connection)`
`HttpRequest`	`clone()`
`HttpResponse`	`createResponse()` Создание объекта HttpResponse
`protected void`	`fireEvent(HttpEvent event)`
`int`	`getConnectTimeout()`
`ContentBuffer`	`getContentBuffer()` Указывает буффер для content-а
`long`	`getContentOffsetStart()` Указывает с какой позиции записывать в content buffer
`Func1<Object,URLConnection>`	`getData()`
`HttpClient`	`getHttpClient()`
`HttpHeaders`	`getHttpHeaders()`
`long`	`getId()` Получение идентификатора
`Set<HttpListener>`	`getListeners()`
`long`	`getMaxDownloadSize()` Возвращает максимум загужаемых данных, по умолчанию без ограничения
`String`	`getMethod()` Возвращает HTTP метод, по умолчанию GET
`Proxy`	`getProxy()` Возвращает proxy для этого запроса.
`int`	`getReadTimeout()`
`Object`	`getSyncObject()` Возвращает объект для синхронизации
`URL`	`getUrl()` Указывает запрашиваемый адрес
`String`	`getUserAgent()`
`boolean`	`isAsync()` Указывает асинхронный режим
`boolean`	`isFollowRedirect()` Переходить по redirect
`URLConnection`	`openURLConnection()` Открытие соединение, с учетом настроек: proxy, connectTimeout, readTimeout, httpHeaders, method
`protected void`	`prepareRequiredHeaders(URLConnection connection)` Подготовка обязательных заголовков
`protected void`	`prepareUserAgent(URLConnection connection)` Указание user-agent
`void`	`removeListener(HttpListener listener)`
`void`	`setAsync(boolean async)` Указывает асинхронный режим
`void`	`setConnectTimeout(int connectTimeoutMS)`
`void`	`setContentBuffer(ContentBuffer contentBuffer)` Указывает буффер для content-а
`void`	`setContentOffsetStart(long contentOffsetStart)` Указывает с какой позиции записывать в content buffer
`void`	`setData(Func1<Object,URLConnection> data)`
`void`	`setFollowRedirect(boolean followRedirect)` Переходить по redirect
`void`	`setHttpClient(HttpClient httpClient)`
`void`	`setHttpHeaders(HttpHeaders headers)`
`void`	`setMaxDownloadSize(long maxSize)` Устанавливает максимум загужаемых данных.
`void`	`setMethod(String method)` Указывает HTTP метод
`void`	`setProxy(Proxy proxy)` Указывает proxy для этого запроса.
`void`	`setReadTimeout(int readTimeoutMS)`
`void`	`setUrl(URL url)` Указывает запрашиваемый адрес
`void`	`setUserAgent(String userAgent)`

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

- Field Detail
  - sequenceID
```
protected static final AtomicLong sequenceID
```
  - sync
```
protected final Object sync
```
    Объект для синхронизации
  - id
```
public final long id
```
    Идентификатор объекта в пределах приложения
  - connectTimeout
```
protected Integer connectTimeout
```
  - readTimeout
```
protected Integer readTimeout
```
  - httpListenerHelper
```
protected final HttpListenersHelper httpListenerHelper
```
  - async
```
protected Boolean async
```
  - proxy
```
protected Proxy proxy
```
    Прокси для этого запроса
  - contentBuffer
```
protected ContentBuffer contentBuffer
```
  - contentOffsetStart
```
protected long contentOffsetStart
```
  - maxDownloadSize
```
protected long maxDownloadSize
```
  - followRedirect
```
protected boolean followRedirect
```
  - data
```
protected Func1<Object,URLConnection> data
```
- Constructor Detail
  - HttpRequest
```
public HttpRequest(URL url,
                   HttpClient httpClient)
```
  - HttpRequest
```
public HttpRequest(HttpRequest source)
```
- Method Detail
  - getSyncObject
```
public final Object getSyncObject()
```
    Возвращает объект для синхронизации
    
    Returns:
    
    объект синхронизации
  - clone
```
public HttpRequest clone()
```
    Overrides:
    
    clone in class Object
  - getId
```
public final long getId()
```
    Получение идентификатора
    
    Returns:
    
    идентификатор запроса
  - getUrl
```
public URL getUrl()
```
    Указывает запрашиваемый адрес
    
    Returns:
    
    запрашиваемый адрес
  - setUrl
```
public void setUrl(URL url)
```
    Указывает запрашиваемый адрес
    
    Parameters:
    
    url - запрашиваемый адрес
  - getMethod
```
public String getMethod()
```
    Возвращает HTTP метод, по умолчанию GET
    
    Returns:
    
    HTTP метод
  - setMethod
```
public void setMethod(String method)
```
    Указывает HTTP метод
    
    Parameters:
    
    method - HTTP метод
  - getHttpClient
```
public HttpClient getHttpClient()
```
  - setHttpClient
```
public void setHttpClient(HttpClient httpClient)
```
  - getHttpHeaders
```
public HttpHeaders getHttpHeaders()
```
  - setHttpHeaders
```
public void setHttpHeaders(HttpHeaders headers)
```
  - applyHeadersTo
```
public void applyHeadersTo(URLConnection connection)
```
  - getUserAgent
```
public String getUserAgent()
```
  - setUserAgent
```
public void setUserAgent(String userAgent)
```
  - getConnectTimeout
```
public int getConnectTimeout()
```
  - setConnectTimeout
```
public void setConnectTimeout(int connectTimeoutMS)
```
  - getReadTimeout
```
public int getReadTimeout()
```
  - setReadTimeout
```
public void setReadTimeout(int readTimeoutMS)
```
  - getListeners
```
public Set<HttpListener> getListeners()
```
  - addListener
```
public Closeable addListener(HttpListener listener)
```
  - addListener
```
public Closeable addListener(HttpListener listener,
                             boolean weakLink)
```
  - removeListener
```
public void removeListener(HttpListener listener)
```
  - fireEvent
```
protected void fireEvent(HttpEvent event)
```
  - isAsync
```
public boolean isAsync()
```
    Указывает асинхронный режим
    
    Returns:
    
    true - асинхронный; false (по умолч) - синхронный
  - setAsync
```
public void setAsync(boolean async)
```
    Указывает асинхронный режим
    
    Parameters:
    
    async - true - асинхронный; false - синхронный
  - getProxy
```
public Proxy getProxy()
```
    Возвращает proxy для этого запроса.
    
    Returns:
    
    proxy или null
    
    See Also:
    
    setProxy(xyz.cofe.http.Proxy)
  - setProxy
```
public void setProxy(Proxy proxy)
```
    Указывает proxy для этого запроса.
    Если proxy указан, то будет использоваться он.
    Если proxy не указан, то будет использоваться Proxy из настроек клиента.
    
    Parameters:
    
    proxy - proxy или null
    
    See Also:
    
    HttpClient.setProxySelector(java.net.ProxySelector)
  - getContentBuffer
```
public ContentBuffer getContentBuffer()
```
    Указывает буффер для content-а
    
    Returns:
    
    contentBuffer буффер
  - setContentBuffer
```
public void setContentBuffer(ContentBuffer contentBuffer)
```
    Указывает буффер для content-а
    
    Parameters:
    
    contentBuffer - буффер
  - getContentOffsetStart
```
public long getContentOffsetStart()
```
    Указывает с какой позиции записывать в content buffer
    
    Returns:
    
    позиция
  - setContentOffsetStart
```
public void setContentOffsetStart(long contentOffsetStart)
```
    Указывает с какой позиции записывать в content buffer
    
    Parameters:
    
    contentOffsetStart - позиция
  - getMaxDownloadSize
```
public long getMaxDownloadSize()
```
    Возвращает максимум загужаемых данных, по умолчанию без ограничения
    
    Returns:
    
    макс загружаемых данных, maxDownloadSize < 0 - без ограничений
  - setMaxDownloadSize
```
public void setMaxDownloadSize(long maxSize)
```
    Устанавливает максимум загужаемых данных.
    
    Parameters:
    
    maxSize - макс загружаемых данных, maxSize < 0 - без ограничений
  - isFollowRedirect
```
public boolean isFollowRedirect()
```
    Переходить по redirect
    
    Returns:
    
    true - переход по redirect
  - setFollowRedirect
```
public void setFollowRedirect(boolean followRedirect)
```
    Переходить по redirect
    
    Parameters:
    
    followRedirect - true - переход по redirect
  - getData
```
public Func1<Object,URLConnection> getData()
```
  - setData
```
public void setData(Func1<Object,URLConnection> data)
```
  - prepareUserAgent
```
protected void prepareUserAgent(URLConnection connection)
```
    Указание user-agent
    
    Parameters:
    
    connection - Коннект
  - prepareRequiredHeaders
```
protected void prepareRequiredHeaders(URLConnection connection)
```
    Подготовка обязательных заголовков
    
    Parameters:
    
    connection - Открытое соединение
    
    See Also:
    
    prepareUserAgent(java.net.URLConnection)
  - openURLConnection
```
public URLConnection openURLConnection()
                                throws IOException
```
    Открытие соединение, с учетом настроек:
    proxy, connectTimeout, readTimeout, httpHeaders, method
    
    Returns:
    
    соединение
    
    Throws:
    
    IOException - не может открыть соединение
  - createResponse
```
public HttpResponse createResponse()
```
    Создание объекта HttpResponse
    
    Returns:
    
    объекта HttpResponse
    
    See Also:
    
    HttpResponse

Class HttpRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sequenceID

sync

id

connectTimeout

readTimeout

httpListenerHelper

async

proxy

contentBuffer

contentOffsetStart

maxDownloadSize

followRedirect

data

Constructor Detail

HttpRequest

HttpRequest

Method Detail

getSyncObject

clone

getId

getUrl

setUrl

getMethod

setMethod

getHttpClient

setHttpClient

getHttpHeaders

setHttpHeaders

applyHeadersTo

getUserAgent

setUserAgent

getConnectTimeout

setConnectTimeout

getReadTimeout

setReadTimeout

getListeners

addListener

addListener

removeListener

fireEvent

isAsync

setAsync

getProxy

setProxy

getContentBuffer

setContentBuffer

getContentOffsetStart

setContentOffsetStart

getMaxDownloadSize

setMaxDownloadSize

isFollowRedirect

setFollowRedirect

getData

setData

prepareUserAgent

prepareRequiredHeaders

openURLConnection

createResponse