HttpResponse (http-base 0.1 API)

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

All Implemented Interfaces:

IsFinished
```
public class HttpResponse
extends Object
implements IsFinished
```
Http ответ

Author:

Kamnev Georgiy (nt.gocha@gmail.com)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpResponse.ProgressEvent`
`static class`	`HttpResponse.RedirectEvent`
`static class`	`HttpResponse.State` Состояние объекта
`static class`	`HttpResponse.StateChangedEvent`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`async`
`protected URLConnection`	`connection`
`protected xyz.cofe.cbuffer.ContentBuffer`	`contentBuffer`
`protected Charset`	`contentCharset`
`protected Long`	`contentWriterPos`
`protected AtomicBoolean`	`continueSignal`
`protected HttpRequest`	`currentRequest`
`protected xyz.cofe.collection.Func1<Object,URLConnection>`	`data`
`protected int`	`downloadBufferSize`
`protected long`	`downloadedSize`
`protected Date`	`finished`
`protected Boolean`	`followRedirect`
`protected HttpListenersHelper`	`httpListenerHelper`
`protected static HttpStatusHelper`	`httpStatusHelper`
`long`	`id` Идентификатор объекта в пределах приложения
`protected Lock`	`lock` Блокировка объекта
`protected Long`	`maxDownloadSize`
`protected AtomicBoolean`	`needPause`
`protected List<HttpResponse>`	`redirects`
`protected List<xyz.cofe.collection.Pair<URL,URL>>`	`redirectUrls`
`protected xyz.cofe.collection.Func4<Boolean,HttpHeaders,URL,URL,List<xyz.cofe.collection.Pair<URL,URL>>>`	`redirectValidate`
`protected static AtomicLong`	`sequenceID`
`protected Date`	`started`
`protected HttpResponse.State`	`state`
`protected int`	`statusCode`
`protected String`	`statusMessage`
`protected String`	`text`
`protected Thread`	`thread`
`protected String`	`threadName` Имя паралельного потока

Constructor Summary

Constructors
Modifier	Constructor and Description
	`HttpResponse(HttpRequest request, Throwable error)` Конструктор с ошибкой открытия соединения
	`HttpResponse(HttpRequest request, URLConnection connection)`
	`HttpResponse(HttpResponse source, boolean cloneHeaders, boolean cloneContentBuffer)` Конструктор копирования.
`protected`	`HttpResponse(HttpResponse source, HttpRequest req, boolean cloneHeaders, boolean cloneContentBuffer)` Конструктор копирования.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`acceptDownloaded(byte[] buffer, int off, int len)` Принимает байты из сети
`protected void`	`addError(Throwable err)`
`Closeable`	`addListener(HttpListener listener)`
`Closeable`	`addListener(HttpListener listener, boolean weakLink)`
`protected void`	`addRedirect(HttpResponse response, URL from, URL to)` Добавление в список редирект
`HttpResponse`	`clone()` Создание клона
`HttpResponse`	`clone(boolean cloneHeaders, boolean cloneBuffer)` Создание клона
`protected HttpResponse`	`clone(HttpRequest req, boolean cloneHeaders, boolean cloneBuffer)` Создание клона
`protected void`	`fireEvent(HttpEvent event)`
`xyz.cofe.cbuffer.ContentBuffer`	`getContentBuffer()`
`Charset`	`getContentCharset()`
`long`	`getContentWriterPos()`
`HttpRequest`	`getCurrentRequest()` Возвращает текущий запрос.
`xyz.cofe.collection.Func1<Object,URLConnection>`	`getData()`
`int`	`getDownloadBufferSize()`
`long`	`getDownloadedSize()` Возвращает кол-во загруженых байтов
`List<Throwable>`	`getErrors()`
`Date`	`getFinished()`
`HttpHeaders`	`getHttpHeaders()`
`long`	`getId()` Получение идентификатора
`xyz.cofe.collection.Pair<URL,URL>`	`getLastRedirectUrl()` Возвращает последнее перенаправление
`URL`	`getLastRedirectUrlTo()` Возвращает последний адрес куда было перенаправление
`Set<HttpListener>`	`getListeners()`
`Lock`	`getLock()` Получение блокировки
`long`	`getMaxDownloadSize()` Возвращает максимум загужаемых данных, по умолчанию без ограничения
`List<HttpResponse>`	`getRedirectResponses()` Получение списка ответов редиректа
`List<xyz.cofe.collection.Pair<URL,URL>>`	`getRedirectUrls()` Получение списка редиректов
`xyz.cofe.collection.Func4<Boolean,HttpHeaders,URL,URL,List<xyz.cofe.collection.Pair<URL,URL>>>`	`getRedirectValidate()` Возвращает проверку redirect.
`HttpRequest`	`getRequest()`
`Date`	`getStarted()`
`HttpResponse.State`	`getState()` Возвращает текущее состояние объекта
`int`	`getStatusCode()` Код ответа сервера
`String`	`getStatusMessage()`
`String`	`getText()`
`Thread`	`getThread()`
`String`	`getThreadName()` Имя паралельного потока
`protected boolean`	`hasContinueSignal()`
`protected boolean`	`hasPauseSignal()`
`boolean`	`isAsync()`
`boolean`	`isErrorsNotExists()` Проверяет что: есть ответ сервера статус ответа сервера в диапазоне 200 - 299 есть заголовки сервера нет ошибок - свойство errors
`boolean`	`isFinished()` Возвращает прзнак что объект завершил работу и находится в конечном состоянии
`boolean`	`isFollowRedirect()` Переходить по redirect
`Closeable`	`onFinished(xyz.cofe.collection.Func1<Object,HttpResponse> runOnFinsihed)` Вызывать код когда запрос перейдет в состояние finished.
`void`	`pause()`
`void`	`removeListener(HttpListener listener)`
`void`	`resume()`
`protected void`	`setContentWriterPos(long pos)`
`protected void`	`setCurrentRequest(HttpRequest currentRequest)` Устанавливает текущий запрос
`void`	`setData(xyz.cofe.collection.Func1<Object,URLConnection> data)`
`void`	`setDownloadBufferSize(int buffSize)`
`void`	`setFollowRedirect(boolean followRedirect)` Переходить по redirect
`protected void`	`setHttpHeaders(HttpHeaders headers)`
`void`	`setMaxDownloadSize(long maxSize)` Устанавливает максимум загужаемых данных.
`void`	`setRedirectValidate(xyz.cofe.collection.Func4<Boolean,HttpHeaders,URL,URL,List<xyz.cofe.collection.Pair<URL,URL>>> redirectValidate)` Устанавливает проверку redirect.
`protected void`	`setState(HttpResponse.State newState)` Устанавливает текущее состояние
`protected void`	`setStatusCode(int newStatusCode)`
`protected void`	`setStatusMessage(String statusMessage)`
`void`	`setThreadName(String threadName)` Имя паралельного потока
`void`	`start()` Запуск скачивания.
`protected void`	`start(HttpRequest sourceRequest, URL urlFrom, URLConnection connection)` Запускает процесс скачивания
`protected void`	`startDownloading(InputStream inputStream)`
`void`	`stop()` Остановка скаивания данных
`void`	`stop(long waitStopMS, long forceStopMS, long sleepTimeMS)` Остановка скаичвания
`void`	`waitForFinished()` Ожидание завершения загрузки.

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

- Field Detail
  - httpStatusHelper
```
protected static final HttpStatusHelper httpStatusHelper
```
  - sequenceID
```
protected static final AtomicLong sequenceID
```
  - id
```
public final long id
```
    Идентификатор объекта в пределах приложения
  - lock
```
protected final Lock lock
```
    Блокировка объекта
  - connection
```
protected URLConnection connection
```
  - data
```
protected xyz.cofe.collection.Func1<Object,URLConnection> data
```
  - httpListenerHelper
```
protected final HttpListenersHelper httpListenerHelper
```
  - downloadedSize
```
protected long downloadedSize
```
  - maxDownloadSize
```
protected Long maxDownloadSize
```
  - started
```
protected Date started
```
  - finished
```
protected Date finished
```
  - state
```
protected HttpResponse.State state
```
  - statusCode
```
protected int statusCode
```
  - statusMessage
```
protected String statusMessage
```
  - thread
```
protected Thread thread
```
  - async
```
protected Boolean async
```
  - downloadBufferSize
```
protected int downloadBufferSize
```
  - contentBuffer
```
protected xyz.cofe.cbuffer.ContentBuffer contentBuffer
```
  - contentCharset
```
protected Charset contentCharset
```
  - text
```
protected String text
```
  - contentWriterPos
```
protected Long contentWriterPos
```
  - threadName
```
protected String threadName
```
    Имя паралельного потока
  - followRedirect
```
protected Boolean followRedirect
```
  - redirects
```
protected final List<HttpResponse> redirects
```
  - redirectUrls
```
protected final List<xyz.cofe.collection.Pair<URL,URL>> redirectUrls
```
  - redirectValidate
```
protected xyz.cofe.collection.Func4<Boolean,HttpHeaders,URL,URL,List<xyz.cofe.collection.Pair<URL,URL>>> redirectValidate
```
  - currentRequest
```
protected HttpRequest currentRequest
```
  - needPause
```
protected volatile AtomicBoolean needPause
```
  - continueSignal
```
protected volatile AtomicBoolean continueSignal
```
- Constructor Detail
  - HttpResponse
```
protected HttpResponse(HttpResponse source,
                       HttpRequest req,
                       boolean cloneHeaders,
                       boolean cloneContentBuffer)
```
    Конструктор копирования.
    Копируются свойства:
    request - ссылка
    state - клон
    errors - клон
    async - клон
    downloadBufferSize - клон
    contentBuffer - клон
    contentCharset - клон
    contentWriterPos - клон
    downloadedSize - клон
    httpHeaders - клон
    started - клон
    finished - клон
    statusCode - клон
    statusMessage - клон
    text - клон
    
    Parameters:
    
    source - исходный объект
    
    cloneContentBuffer - клонировать содержимое
    
    cloneHeaders - клонировать заголовки
    
    req - Переопределить запрос
  - HttpResponse
```
public HttpResponse(HttpResponse source,
                    boolean cloneHeaders,
                    boolean cloneContentBuffer)
```
    Конструктор копирования. Вызывает более длинный конструктор
    
    Parameters:
    
    source - исходный объект
    
    cloneContentBuffer - клонировать содержимое
    
    cloneHeaders - клонировать заголовки
    
    See Also:
    
    HttpResponse(xyz.cofe.http.HttpResponse, xyz.cofe.http.HttpRequest, boolean, boolean)
  - HttpResponse
```
public HttpResponse(HttpRequest request,
                    Throwable error)
```
    Конструктор с ошибкой открытия соединения
    
    Parameters:
    
    request - запрос
    
    error - описание ошибки
  - HttpResponse
```
public HttpResponse(HttpRequest request,
                    URLConnection connection)
```
- Method Detail
  - getLock
```
public Lock getLock()
```
    Получение блокировки
    
    Returns:
    
    блокировка
  - getId
```
public final long getId()
```
    Получение идентификатора
    
    Returns:
    
    идентификатор запроса
  - clone
```
public HttpResponse clone()
```
    Создание клона
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    клон
    
    See Also:
    
    HttpResponse(xyz.cofe.http.HttpResponse, boolean, boolean)
  - clone
```
public HttpResponse clone(boolean cloneHeaders,
                          boolean cloneBuffer)
```
    Создание клона
    
    Parameters:
    
    cloneHeaders - клонировать заголовки
    
    cloneBuffer - клонировать буфер
    
    Returns:
    
    клон
    
    See Also:
    
    HttpResponse(xyz.cofe.http.HttpResponse, boolean, boolean)
  - clone
```
protected HttpResponse clone(HttpRequest req,
                             boolean cloneHeaders,
                             boolean cloneBuffer)
```
    Создание клона
    
    Parameters:
    
    req - Запрос для клона
    
    cloneHeaders - клонировать заголовки
    
    cloneBuffer - клонировать буфер
    
    Returns:
    
    клон
  - start
```
public void start()
```
    Запуск скачивания. можно вызывать когда объект находится в состоянии Prepare
  - getData
```
public xyz.cofe.collection.Func1<Object,URLConnection> getData()
```
  - setData
```
public void setData(xyz.cofe.collection.Func1<Object,URLConnection> data)
```
  - getRequest
```
public HttpRequest getRequest()
```
  - getErrors
```
public List<Throwable> getErrors()
```
  - addError
```
protected void addError(Throwable err)
```
  - 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)
```
  - getDownloadedSize
```
public long getDownloadedSize()
```
    Возвращает кол-во загруженых байтов
    
    Returns:
    
    кол-во загруженых байтов
  - getMaxDownloadSize
```
public long getMaxDownloadSize()
```
    Возвращает максимум загужаемых данных, по умолчанию без ограничения
    
    Returns:
    
    макс загружаемых данных, maxDownloadSize < 0 - без ограничений
  - setMaxDownloadSize
```
public void setMaxDownloadSize(long maxSize)
```
    Устанавливает максимум загужаемых данных.
    
    Parameters:
    
    maxSize - макс загружаемых данных, maxSize < 0 - без ограничений
  - getStarted
```
public Date getStarted()
```
  - getFinished
```
public Date getFinished()
```
  - isErrorsNotExists
```
public boolean isErrorsNotExists()
```
    Проверяет что:
    - есть ответ сервера
    - статус ответа сервера в диапазоне 200 - 299
    - есть заголовки сервера
    - нет ошибок - свойство errors
    Returns:
    
    Ответ не содержит ошибок ( в диапазоне 200-299 )
  - getState
```
public HttpResponse.State getState()
```
    Возвращает текущее состояние объекта
    
    Returns:
    
    текущее состояние
  - setState
```
protected void setState(HttpResponse.State newState)
```
    Устанавливает текущее состояние
    
    Parameters:
    
    newState - текущее состояние
  - isFinished
```
public boolean isFinished()
```
    Возвращает прзнак что объект завершил работу и находится в конечном состоянии
    
    Specified by:
    
    isFinished in interface IsFinished
    
    Returns:
    
    конечное состояние
  - getStatusCode
```
public int getStatusCode()
```
    Код ответа сервера
    
    Returns:
    
    код ответа сервера или -1 если еще не завершено
  - setStatusCode
```
protected void setStatusCode(int newStatusCode)
```
  - getStatusMessage
```
public String getStatusMessage()
```
  - setStatusMessage
```
protected void setStatusMessage(String statusMessage)
```
  - getThread
```
public Thread getThread()
```
  - isAsync
```
public boolean isAsync()
```
  - getDownloadBufferSize
```
public int getDownloadBufferSize()
```
  - setDownloadBufferSize
```
public void setDownloadBufferSize(int buffSize)
```
  - getHttpHeaders
```
public HttpHeaders getHttpHeaders()
```
  - setHttpHeaders
```
protected void setHttpHeaders(HttpHeaders headers)
```
  - getContentBuffer
```
public xyz.cofe.cbuffer.ContentBuffer getContentBuffer()
```
  - getContentCharset
```
public Charset getContentCharset()
```
  - getText
```
public String getText()
```
  - getContentWriterPos
```
public long getContentWriterPos()
```
  - setContentWriterPos
```
protected void setContentWriterPos(long pos)
```
  - getThreadName
```
public String getThreadName()
```
    Имя паралельного потока
    
    Returns:
    
    Имя паралельного потока, возможно null
  - setThreadName
```
public void setThreadName(String threadName)
```
    Имя паралельного потока
    
    Parameters:
    
    threadName - Имя паралельного потока, возможно null
  - isFollowRedirect
```
public boolean isFollowRedirect()
```
    Переходить по redirect
    
    Returns:
    
    true - переход по redirect
  - setFollowRedirect
```
public void setFollowRedirect(boolean followRedirect)
```
    Переходить по redirect
    
    Parameters:
    
    followRedirect - true - переход по redirect
  - getRedirectResponses
```
public List<HttpResponse> getRedirectResponses()
```
    Получение списка ответов редиректа
    
    Returns:
    
    список редиректов
  - getRedirectUrls
```
public List<xyz.cofe.collection.Pair<URL,URL>> getRedirectUrls()
```
    Получение списка редиректов
    
    Returns:
    
    список редиректов
  - getLastRedirectUrl
```
public xyz.cofe.collection.Pair<URL,URL> getLastRedirectUrl()
```
    Возвращает последнее перенаправление
    
    Returns:
    
    перенаправление или null
  - getLastRedirectUrlTo
```
public URL getLastRedirectUrlTo()
```
    Возвращает последний адрес куда было перенаправление
    
    Returns:
    
    куда последний раз перенаправило или null
  - addRedirect
```
protected void addRedirect(HttpResponse response,
                           URL from,
                           URL to)
```
    Добавление в список редирект
    
    Parameters:
    
    response - редирект
    
    from - откуда переход
    
    to - куда переход
  - getRedirectValidate
```
public xyz.cofe.collection.Func4<Boolean,HttpHeaders,URL,URL,List<xyz.cofe.collection.Pair<URL,URL>>> getRedirectValidate()
```
    Возвращает проверку redirect.
    
    Returns:
    
    Текущий запрос
  - setRedirectValidate
```
public void setRedirectValidate(xyz.cofe.collection.Func4<Boolean,HttpHeaders,URL,URL,List<xyz.cofe.collection.Pair<URL,URL>>> redirectValidate)
```
    Устанавливает проверку redirect.
    
    Parameters:
    
    redirectValidate - функция проверки:
    boolean fn( HttpHeaders hh, URL from, URL to, List<URL,URL> history )
  - getCurrentRequest
```
public HttpRequest getCurrentRequest()
```
    Возвращает текущий запрос. Текущий запрос может отличатся от оригинального в случаии если был redirect
    
    Returns:
    
    Текущий запрос
  - setCurrentRequest
```
protected void setCurrentRequest(HttpRequest currentRequest)
```
    Устанавливает текущий запрос
    
    Parameters:
    
    currentRequest - текущий запрос
  - start
```
protected void start(HttpRequest sourceRequest,
                     URL urlFrom,
                     URLConnection connection)
```
    Запускает процесс скачивания
    
    Parameters:
    
    sourceRequest - Исходный запрос
    
    connection - Соединение
    
    urlFrom - Исходный URL адресса
  - pause
```
public void pause()
```
  - hasPauseSignal
```
protected boolean hasPauseSignal()
```
  - resume
```
public void resume()
```
  - hasContinueSignal
```
protected boolean hasContinueSignal()
```
  - acceptDownloaded
```
protected void acceptDownloaded(byte[] buffer,
                                int off,
                                int len)
```
    Принимает байты из сети
    
    Parameters:
    
    buffer - данные
    
    off - смещение в buffer
    
    len - объем в buffer
  - startDownloading
```
protected void startDownloading(InputStream inputStream)
                         throws IOException
```
    Throws:
    
    IOException
  - stop
```
public void stop(long waitStopMS,
                 long forceStopMS,
                 long sleepTimeMS)
```
    Остановка скаичвания
    
    Parameters:
    
    waitStopMS - время через которое повторно посылается сигнал остановки
    
    forceStopMS - время через которое принудительно закрывается thread скачивания
    
    sleepTimeMS - время засыпания потока, или 0 - для передачи Thread.yield()
  - stop
```
public void stop()
```
    Остановка скаивания данных
  - waitForFinished
```
public void waitForFinished()
```
    Ожидание завершения загрузки. можно вызывать когда работает в параллельном/асинхронном режиме.
    
    See Also:
    
    getState()
  - onFinished
```
public Closeable onFinished(xyz.cofe.collection.Func1<Object,HttpResponse> runOnFinsihed)
```
    Вызывать код когда запрос перейдет в состояние finished.
    Вызов можеть производиться из другого потока (если был асихронный вызов).
    Код будет вызван не более одного раза.
    
    Parameters:
    
    runOnFinsihed - код который надо вызвать
    
    Returns:
    
    закрытие объектов

Class HttpResponse

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

httpStatusHelper

sequenceID

id

lock

connection

data

httpListenerHelper

downloadedSize

maxDownloadSize

started

finished

state

statusCode

statusMessage

thread

async

downloadBufferSize

contentBuffer

contentCharset

text

contentWriterPos

threadName

followRedirect

redirects

redirectUrls

redirectValidate

currentRequest

needPause

continueSignal

Constructor Detail

HttpResponse

HttpResponse

HttpResponse

HttpResponse

Method Detail

getLock

getId

clone

clone

clone

start

getData

setData

getRequest

getErrors

addError

getListeners

addListener

addListener

removeListener

fireEvent

getDownloadedSize

getMaxDownloadSize

setMaxDownloadSize

getStarted

getFinished

isErrorsNotExists

getState

setState

isFinished

getStatusCode

setStatusCode

getStatusMessage

setStatusMessage

getThread

isAsync

getDownloadBufferSize

setDownloadBufferSize

getHttpHeaders

setHttpHeaders

getContentBuffer

getContentCharset

getText