HttpHeaders (http-base 0.1 API)

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

```
public class HttpHeaders
extends Object
```
Http заголовки

Author:

Kamnev Georgiy (nt.gocha@gmail.com)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpHeaders.ContentRange` Размер запрашивой порции
`static class`	`HttpHeaders.Range` Диапазон запрашиваемых байтов фрагмента

Field Summary

Fields
Modifier and Type Field and Description

static String CONTENT_TYPE

Fields
Modifier and Type	Field and Description
`static String`	`CONTENT_TYPE`

Constructor Summary

Constructors
Modifier Constructor and Description

HttpHeaders()

HttpHeaders(HttpHeaders source)

protected HttpHeaders(Map<String,List<String>> multiMap)

Constructors
Modifier	Constructor and Description
	`HttpHeaders()`
	`HttpHeaders(HttpHeaders source)`
`protected`	`HttpHeaders(Map<String,List<String>> multiMap)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpHeaders`	`clone()`
`Map<String,List<String>>`	`cloneHeaders()`
`static HttpHeaders`	`createFromMultiMap(Map<String,List<String>> multiMap)`
`String`	`get(String key)` Возвращает значение указанного заголовка
`String`	`getAccept()`
`Charset`	`getAcceptCharset()`
`String`	`getAcceptLanguage()`
`String`	`getAcceptRanges()` Принимает запросы на фрагментарное скачивание (Accept-Ranges: bytes)
`String`	`getContentDispositionFileName()` Имя файла вложения
`String`	`getContentDispositionHeader()`
`long`	`getContentLength()` Размер содержимого в байтах (Content-Length)
`HttpHeaders.ContentRange`	`getContentRange()` Размер части данных
`String`	`getContentRangeHeader()` Content-Range: bytes 88080384-160993791/160993792
`String`	`getContentType()` mime тип (Content-Type: text/html)
`Charset`	`getContentTypeCharset()` Кодировка символов (Content-Type: text/html;charset=utf-8)
`String`	`getContentTypeHeader()` Заголовок Content-type
`String`	`getCookie()`
`String`	`getFirst(String key)` Возвращает значение указанного заголовка
`Date`	`getIfModifiedSinceGMT()` Возвращает время для проверки: изменился ли объект с указаного времени (заголовок If-Modified-Since) Если время не указано, вернет null.
`Date`	`getIfModifiedSinceLocal()` Возвращает время для проверки: изменился ли объект с указаного времени (заголовок If-Modified-Since) в локальном времени.
`protected static Set<String>`	`getKeysIgnoreCase(Map<String,List<String>> headers, String key)`
`Date`	`getLastModifiedGMT()` Возвращает время по гринвичу последнего изменения объекта (заголовок Last-Modified) Если время не указано, вернет null.
`Date`	`getLastModifiedLocal()` Возвращает время последнего изменения объекта (заголовок Last-Modified) в локальном времени.
`String`	`getLocation()` Указывает redirect
`Map<String,List<String>>`	`getMultiMap()`
`HttpHeaders.Range`	`getRange()` Указывает размер запрашиваемого фрагмента
`String`	`getRangeHeader()`
`String`	`getReferer()` Указывает referer, откуда пришел
`String`	`getSetCookie()`
`String`	`getUserAgent()`
`protected String`	`parseQuotedString(String text, int offset)` парсинг экранированной строки.
`HttpHeaders`	`set(String key, String value)` Установка заголовка
`void`	`setAccept(String accept)`
`void`	`setAcceptCharset(Charset accept)` Accept-Charset: UTF-8
`void`	`setAcceptLanguage(String accept)` ru-RU,ru;q=0.8,en-US;q=0.6,en;q=0.4
`void`	`setCookie(String setCookie)`
`void`	`setIfModifiedSinceGMT(Date date)` Устанавливает время для проверки: изменился ли объект с указаного времени (заголовок If-Modified-Since).
`void`	`setIfModifiedSinceLocal(Date date)` Устанавливает время для проверки: изменился ли объект с указаного времени (заголовок If-Modified-Since).
`void`	`setLastModifiedGMT(Date date)` Устанавливает время последнего изменения объекта (заголовок Last-Modified)
`void`	`setLastModifiedLocal(Date date)` Устанавливает время последнего изменения объекта (заголовок Last-Modified)
`void`	`setLocation(String location)` Указывает redirect
`void`	`setRange(long from, long to)` Указывает размер запрашиваемого фрагмента
`void`	`setRangeHeader(String val)` указывает заголовок Range
`void`	`setReferer(String referer)` Указывает referer, откуда пришел
`void`	`setSetCookie(String setCookie)`
`void`	`setUserAgent(String useragent)` HttpClient.class.getName()+"/"+"0.1-SNAPSHOT"
`String`	`toString()`

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

- Field Detail
  - CONTENT_TYPE
```
public static final String CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpHeaders
```
protected HttpHeaders(Map<String,List<String>> multiMap)
```
  - HttpHeaders
```
public HttpHeaders()
```
  - HttpHeaders
```
public HttpHeaders(HttpHeaders source)
```
- Method Detail
  - createFromMultiMap
```
public static HttpHeaders createFromMultiMap(Map<String,List<String>> multiMap)
```
  - getMultiMap
```
public Map<String,List<String>> getMultiMap()
```
  - clone
```
public HttpHeaders clone()
```
    Overrides:
    
    clone in class Object
  - cloneHeaders
```
public Map<String,List<String>> cloneHeaders()
```
  - getFirst
```
public String getFirst(String key)
```
    Возвращает значение указанного заголовка
    
    Parameters:
    
    key - имя заголовка, регистр не имеет значения
    
    Returns:
    
    значение или null, если заголовок не указан
  - get
```
public String get(String key)
```
    Возвращает значение указанного заголовка
    
    Parameters:
    
    key - имя заголовка, регистр не имеет значения
    
    Returns:
    
    значение или null, если заголовок не указан
  - getKeysIgnoreCase
```
protected static Set<String> getKeysIgnoreCase(Map<String,List<String>> headers,
                                               String key)
```
  - set
```
public HttpHeaders set(String key,
                       String value)
```
    Установка заголовка
    
    Parameters:
    
    key - Заголовок
    
    value - Значение или null - для удаления
    
    Returns:
    
    Заголовки с новыми данными (этот же объект)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getContentTypeHeader
```
public String getContentTypeHeader()
```
    Заголовок Content-type
    
    Returns:
    
    значение Content-type, пример: Content-Type: text/html;charset=utf-8
  - getContentTypeCharset
```
public Charset getContentTypeCharset()
```
    Кодировка символов (Content-Type: text/html;charset=utf-8)
    
    Returns:
    
    Кодировка или null
  - getContentType
```
public String getContentType()
```
    mime тип (Content-Type: text/html)
    
    Returns:
    
    mime тип или null
  - getContentLength
```
public long getContentLength()
```
    Размер содержимого в байтах (Content-Length)
    
    Returns:
    
    Размер содержимого в байтах или -1, если не указан
  - getContentDispositionHeader
```
public String getContentDispositionHeader()
```
  - parseQuotedString
```
protected String parseQuotedString(String text,
                                   int offset)
```
    парсинг экранированной строки.
    quotedString ::= ws* quote qchar* quote .
    quote ::= '"'
    qhcar ::= escapeChar | nonEscapeChar
    escapeChar ::= '\' char
    nonEscapeChar ::= char except quote
    
    Parameters:
    
    text - текст
    
    offset - начало
    
    Returns:
    
    декодированная строка
  - getContentDispositionFileName
```
public String getContentDispositionFileName()
```
    Имя файла вложения
    
    Returns:
    
    имя файла вложения или null
  - getAcceptRanges
```
public String getAcceptRanges()
```
    Принимает запросы на фрагментарное скачивание (Accept-Ranges: bytes)
    
    Returns:
    
    как указываются диапазоны докачки или null
  - getRangeHeader
```
public String getRangeHeader()
```
  - getRange
```
public HttpHeaders.Range getRange()
```
    Указывает размер запрашиваемого фрагмента
    
    Returns:
    
    Описание фрагмента или null
  - setRange
```
public void setRange(long from,
                     long to)
```
    Указывает размер запрашиваемого фрагмента
    
    Parameters:
    
    from - с какого байта начать (от нуля)
    
    to - по какой байт включительно закончить (от нуля), или -1 - то до конца
  - setRangeHeader
```
public void setRangeHeader(String val)
```
    указывает заголовок Range
    
    Parameters:
    
    val - Значение заголовка
  - getContentRangeHeader
```
public String getContentRangeHeader()
```
    Content-Range: bytes 88080384-160993791/160993792
    
    Returns:
    
    Значение заголовка
  - getContentRange
```
public HttpHeaders.ContentRange getContentRange()
```
    Размер части данных
    
    Returns:
    
    размер запрашивой порции или null
  - getAccept
```
public String getAccept()
```
  - setAccept
```
public void setAccept(String accept)
```
  - getAcceptLanguage
```
public String getAcceptLanguage()
```
  - setAcceptLanguage
```
public void setAcceptLanguage(String accept)
```
    ru-RU,ru;q=0.8,en-US;q=0.6,en;q=0.4
    
    Parameters:
    
    accept - Значение заголовка
  - getUserAgent
```
public String getUserAgent()
```
  - setUserAgent
```
public void setUserAgent(String useragent)
```
    HttpClient.class.getName()+"/"+"0.1-SNAPSHOT"
    
    Parameters:
    
    useragent - Значение заголовка
  - getAcceptCharset
```
public Charset getAcceptCharset()
```
  - setAcceptCharset
```
public void setAcceptCharset(Charset accept)
```
    Accept-Charset: UTF-8
    
    Parameters:
    
    accept - Значение заголовка
  - getLocation
```
public String getLocation()
```
    Указывает redirect
    
    Returns:
    
    куда переход или null
  - setLocation
```
public void setLocation(String location)
```
    Указывает redirect
    
    Parameters:
    
    location - куда переход
  - getReferer
```
public String getReferer()
```
    Указывает referer, откуда пришел
    
    Returns:
    
    откуда пришел или null
  - setReferer
```
public void setReferer(String referer)
```
    Указывает referer, откуда пришел
    
    Parameters:
    
    referer - откуда пришел
  - getSetCookie
```
public String getSetCookie()
```
  - setSetCookie
```
public void setSetCookie(String setCookie)
```
  - getCookie
```
public String getCookie()
```
  - setCookie
```
public void setCookie(String setCookie)
```
  - getLastModifiedLocal
```
public Date getLastModifiedLocal()
```
    Возвращает время последнего изменения объекта (заголовок Last-Modified) в локальном времени. Если время не указано, вернет null.
    
    Returns:
    
    Локальное время изменения объекта (или null)
  - setLastModifiedLocal
```
public void setLastModifiedLocal(Date date)
```
    Устанавливает время последнего изменения объекта (заголовок Last-Modified)
    
    Parameters:
    
    date - лоакльное время изменения или null что бы удалить заголовок Last-Modified
  - getLastModifiedGMT
```
public Date getLastModifiedGMT()
```
    Возвращает время по гринвичу последнего изменения объекта (заголовок Last-Modified) Если время не указано, вернет null.
    
    Returns:
    
    Время, по гринвичу, изменения объекта (или null)
  - setLastModifiedGMT
```
public void setLastModifiedGMT(Date date)
```
    Устанавливает время последнего изменения объекта (заголовок Last-Modified)
    
    Parameters:
    
    date - время, по гринвичу, изменения или null что бы удалить заголовок Last-Modified
  - getIfModifiedSinceLocal
```
public Date getIfModifiedSinceLocal()
```
    Возвращает время для проверки: изменился ли объект с указаного времени (заголовок If-Modified-Since) в локальном времени. Если время не указано, вернет null.
    
    Returns:
    
    Локальное время изменения объекта (или null)
  - setIfModifiedSinceLocal
```
public void setIfModifiedSinceLocal(Date date)
```
    Устанавливает время для проверки: изменился ли объект с указаного времени (заголовок If-Modified-Since).
    
    При запросе GET, если объект не изменился и сервер поддерживает заголовок, то:
    вернет ответ 304 - объет не изменился, вместо 200
    вернет ответ другое значение - если дата указана не верно, или что либо еще ...
    
    Если объект изменился то вернет 200 или другое значение, но не 304
    
    Parameters:
    
    date - лоакльное время изменения или null что бы удалить заголовок If-Modified-Since
  - getIfModifiedSinceGMT
```
public Date getIfModifiedSinceGMT()
```
    Возвращает время для проверки: изменился ли объект с указаного времени (заголовок If-Modified-Since) Если время не указано, вернет null.
    
    Returns:
    
    Время, по гринвичу, изменения объекта (или null)
  - setIfModifiedSinceGMT
```
public void setIfModifiedSinceGMT(Date date)
```
    Устанавливает время для проверки: изменился ли объект с указаного времени (заголовок If-Modified-Since).
    
    При запросе GET, если объект не изменился и сервер поддерживает заголовок, то:
    вернет ответ 304 - объет не изменился, вместо 200
    вернет ответ другое значение - если дата указана не верно, или что либо еще ...
    
    Если объект изменился то вернет 200 или другое значение, но не 304
    
    Parameters:
    
    date - время, по гринвичу, изменения или null что бы удалить заголовок If-Modified-Since

Class HttpHeaders

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONTENT_TYPE

Constructor Detail

HttpHeaders

HttpHeaders

HttpHeaders

Method Detail

createFromMultiMap

getMultiMap

clone

cloneHeaders

getFirst

get

getKeysIgnoreCase

set

toString

getContentTypeHeader

getContentTypeCharset

getContentType

getContentLength

getContentDispositionHeader

parseQuotedString

getContentDispositionFileName

getAcceptRanges

getRangeHeader

getRange

setRange

setRangeHeader

getContentRangeHeader

getContentRange

getAccept

setAccept

getAcceptLanguage

setAcceptLanguage

getUserAgent

setUserAgent

getAcceptCharset

setAcceptCharset

getLocation

setLocation

getReferer

setReferer

getSetCookie

setSetCookie

getCookie

setCookie

getLastModifiedLocal

setLastModifiedLocal

getLastModifiedGMT

setLastModifiedGMT

getIfModifiedSinceLocal

setIfModifiedSinceLocal

getIfModifiedSinceGMT

setIfModifiedSinceGMT