ServerResponse (PF-All 7.4.0 API)

java.lang.Object
- org.pfsw.net.http.ServerResponse

All Implemented Interfaces:

IExtensibleFluentApi<ServerResponse>
```
public class ServerResponse
extends java.lang.Object
```
Holds all data received from a server as response to a single HTTP request.

Constructor Summary

Constructors
Constructor and Description

ServerResponse(int responseCode)

ServerResponse(int responseCode, java.lang.String responseMessage)

Constructors
Constructor and Description
`ServerResponse(int responseCode)`
`ServerResponse(int responseCode, java.lang.String responseMessage)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`addAllHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerMap)` Add all name/values from the given map.
`T`	`addHeader(HttpHeaderName name, java.lang.String value)` Add a header value to the header with the given name.
`T`	`addHeader(java.lang.String name, java.lang.String value)` Add a header value to the header with the given name.
`T`	`addHeaders(java.util.Map<HttpHeaderName,java.util.List<java.lang.String>> headerMap)` Add all name/values from the given map.
`T`	`appendContent(byte[] data)` Appends the given bytes to the content.
`T`	`appendContent(java.io.InputStream inStream)` Appends the bytes from the given stream to the content.
`void`	`appendContent(java.lang.String text)` Appends the given text to the content using the currently defined character encoding.
`protected java.nio.charset.Charset`	`asCharset(java.lang.String contentType)`
`protected MediaType`	`asMediaType(java.lang.String contentType)`
`static ServerResponse`	`create(int responseCode)`
`static ServerResponse`	`create(int responseCode, java.lang.String responseMessage)`
`java.nio.charset.Charset`	`getCharset()` Returns the character encoding defined in the Content-Type header or null if it is not set.
`protected java.nio.charset.Charset`	`getCharsetEncoding()`
`protected java.io.ByteArrayOutputStream`	`getContentBuffer()`
`byte[]`	`getContentData()` Returns the content data or null if no content is available.
`protected java.io.ByteArrayOutputStream`	`getContentDataStream()`
`int`	`getContentLength()`
`MediaType`	`getContentMediaType()` Returns the media type specified in the "Content-Type" header of null if not set.
`java.io.Reader`	`getContentReader()` Returns the content data as reader (with correct char encoding) or null if no content is available.
`java.lang.String`	`getContentText()` Returns the content data as text (with correct char encoding) or null if no content is available.
`protected java.lang.String`	`getContentTypeHeader()` Returns the "Content-Type" header unparsed.
`protected java.nio.charset.Charset`	`getDefaultCharset()`
`java.lang.String`	`getHeader(HttpHeaderName name)` Returns a single value (the first) of the header with the given name.
`java.lang.String`	`getHeader(java.lang.String name)` Returns a single value (the first) of the header with the given name.
`protected Headers`	`getHeaders()`
`java.lang.String`	`getLocationHeader()` Returns the value of the "Location" header or null if it is not present.
`protected Logger`	`getLogger()`
`protected int`	`getReadBufferSize()`
`int`	`getResponseCode()`
`java.lang.String`	`getResponseMessage()`
`boolean`	`hasContentData()`
`boolean`	`isCodeIn(int... codes)` Returns true if the response has a status code that equals one of the given codes.
`boolean`	`isCodeInRange(int fromCode, int toCode)` Returns true if the response has a status code that is in the specified code range (fromCode and toCode both included).
`boolean`	`isOk()` Returns true if the response has returned with the OK status code (i.e.
`boolean`	`isRedirect()` Returns true if the response code is one of the redirect codes 301, 302, 303, 307, 308.
`T`	`removeHeader(HttpHeaderName name)` Returns the header with the given name and all its associated values.
`T`	`removeHeader(java.lang.String name)` Returns the header with the given name and all its associated values.
`T`	`self()`
`ServerResponse`	`setCharEncoding(java.lang.String charEncoding)` Sets the character encoding to be used on the received content when it gets converted to text.
`T`	`setCharset(java.nio.charset.Charset charset)` Sets the character encoding in the Content-Type header or removes it if the given parameter is null.
`protected T`	`setContentDataStream(java.io.ByteArrayOutputStream bodyData)`
`T`	`setContentMediaType(MediaType mediaType)` Sets the media type in the Content-Type header or removes the entire header if the given parameter is null.
`T`	`setContentType(MediaType mediaType, java.nio.charset.Charset charset)` Sets the "Content-Type" header.
`protected T`	`setContentTypeHeader(MediaType mediaType, java.nio.charset.Charset charset)` Sets the "Content-Type" header.
`T`	`setHeader(HttpHeaderName name, java.lang.String value)` A a header with a single value.
`T`	`setHeader(java.lang.String name, java.lang.String value)` A a header with a single value.
`ServerResponse`	`setResponseMessage(java.lang.String responseMessage)`
`java.lang.String`	`toString()`

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

- Constructor Detail
  - ServerResponse
```
public ServerResponse(int responseCode)
```
  - ServerResponse
```
public ServerResponse(int responseCode,
                      java.lang.String responseMessage)
```
- Method Detail
  - create
```
public static ServerResponse create(int responseCode)
```
  - create
```
public static ServerResponse create(int responseCode,
                                    java.lang.String responseMessage)
```
  - getResponseCode
```
public int getResponseCode()
```
  - getResponseMessage
```
public java.lang.String getResponseMessage()
```
  - setResponseMessage
```
public ServerResponse setResponseMessage(java.lang.String responseMessage)
```
  - setCharEncoding
```
public ServerResponse setCharEncoding(java.lang.String charEncoding)
```
    Sets the character encoding to be used on the received content when it gets converted to text.
    
    Parameters:
    
    charEncoding - The encoding name (e.g. "UTF-8"). If null the default HTTP encoding will be set.
  - isOk
```
public boolean isOk()
```
    Returns true if the response has returned with the OK status code (i.e. 200).
  - isRedirect
```
public boolean isRedirect()
```
    Returns true if the response code is one of the redirect codes 301, 302, 303, 307, 308.
  - isCodeIn
```
public boolean isCodeIn(int... codes)
```
    Returns true if the response has a status code that equals one of the given codes.
  - isCodeInRange
```
public boolean isCodeInRange(int fromCode,
                             int toCode)
```
    Returns true if the response has a status code that is in the specified code range (fromCode and toCode both included).
  - getLocationHeader
```
public java.lang.String getLocationHeader()
```
    Returns the value of the "Location" header or null if it is not present.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - setContentType
```
public T setContentType(MediaType mediaType,
                        java.nio.charset.Charset charset)
```
    Sets the "Content-Type" header. If mediaType is null the header will be removed.
    
    Parameters:
    
    mediaType - The media type to set. If null the header will be removed.
    
    charset - The charset to be set. If null it will be ignored.
  - getCharset
```
public java.nio.charset.Charset getCharset()
```
    Returns the character encoding defined in the Content-Type header or null if it is not set.
  - setCharset
```
public T setCharset(java.nio.charset.Charset charset)
```
    Sets the character encoding in the Content-Type header or removes it if the given parameter is null.
    
    Throws:
    
    java.lang.IllegalStateException - If no media type is specified yet.
  - getContentMediaType
```
public MediaType getContentMediaType()
```
    Returns the media type specified in the "Content-Type" header of null if not set.
  - setContentMediaType
```
public T setContentMediaType(MediaType mediaType)
```
    Sets the media type in the Content-Type header or removes the entire header if the given parameter is null.
  - hasContentData
```
public boolean hasContentData()
```
  - getContentLength
```
public int getContentLength()
```
  - appendContent
```
public T appendContent(byte[] data)
```
    Appends the given bytes to the content.
  - appendContent
```
public T appendContent(java.io.InputStream inStream)
                throws java.io.IOException
```
    Appends the bytes from the given stream to the content.
    
    Parameters:
    
    inStream - The stream from which to read the bytes (must not be null).
    
    Throws:
    
    java.io.IOException - If any problem with the input stream occurs.
  - appendContent
```
public void appendContent(java.lang.String text)
```
    Appends the given text to the content using the currently defined character encoding.
    
    Parameters:
    
    text - The text to be appended (null will be ignored).
    
    Throws:
    
    java.lang.IllegalStateException - If no encoding is set.
  - getContentData
```
public byte[] getContentData()
```
    Returns the content data or null if no content is available.
  - getContentReader
```
public java.io.Reader getContentReader()
```
    Returns the content data as reader (with correct char encoding) or null if no content is available.
  - getContentText
```
public java.lang.String getContentText()
```
    Returns the content data as text (with correct char encoding) or null if no content is available.
  - addAllHeaders
```
public T addAllHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerMap)
```
    Add all name/values from the given map.
    
    Parameters:
    
    headerMap - The header names and values to be a added (if null, nothing will be done).
  - addHeaders
```
public T addHeaders(java.util.Map<HttpHeaderName,java.util.List<java.lang.String>> headerMap)
```
    Add all name/values from the given map.
    
    Parameters:
    
    headerMap - The header names and values to be a added (if null, nothing will be done).
  - addHeader
```
public T addHeader(java.lang.String name,
                   java.lang.String value)
```
    Add a header value to the header with the given name. If the header does not exist yet it will be created.
  - addHeader
```
public T addHeader(HttpHeaderName name,
                   java.lang.String value)
```
    Add a header value to the header with the given name. If the header does not exist yet it will be created.
  - setHeader
```
public T setHeader(java.lang.String name,
                   java.lang.String value)
```
    A a header with a single value. If the header does not exist yet it will be created, otherwise its value(s) will be replaced by the given value.
  - setHeader
```
public T setHeader(HttpHeaderName name,
                   java.lang.String value)
```
    A a header with a single value. If the header does not exist yet it will be created, otherwise its value(s) will be replaced by the given value.
  - getHeader
```
public java.lang.String getHeader(java.lang.String name)
```
    Returns a single value (the first) of the header with the given name. If the header does not exist null will be returned.
  - getHeader
```
public java.lang.String getHeader(HttpHeaderName name)
```
    Returns a single value (the first) of the header with the given name. If the header does not exist null will be returned.
  - removeHeader
```
public T removeHeader(java.lang.String name)
```
    Returns the header with the given name and all its associated values.
  - removeHeader
```
public T removeHeader(HttpHeaderName name)
```
    Returns the header with the given name and all its associated values.
  - self
```
public T self()
```
    Specified by:
    
    self in interface IExtensibleFluentApi<T extends org.pfsw.net.http.CommunicationData>
  - asMediaType
```
protected MediaType asMediaType(java.lang.String contentType)
```
  - asCharset
```
protected java.nio.charset.Charset asCharset(java.lang.String contentType)
```
  - getContentTypeHeader
```
protected java.lang.String getContentTypeHeader()
```
    Returns the "Content-Type" header unparsed. That is with media type and charset.
  - setContentTypeHeader
```
protected T setContentTypeHeader(MediaType mediaType,
                                 java.nio.charset.Charset charset)
```
    Sets the "Content-Type" header. If mediaType is null the header will be removed.
  - getCharsetEncoding
```
protected java.nio.charset.Charset getCharsetEncoding()
```
  - getDefaultCharset
```
protected java.nio.charset.Charset getDefaultCharset()
```
  - getContentBuffer
```
protected java.io.ByteArrayOutputStream getContentBuffer()
```
  - getContentDataStream
```
protected java.io.ByteArrayOutputStream getContentDataStream()
```
  - setContentDataStream
```
protected T setContentDataStream(java.io.ByteArrayOutputStream bodyData)
```
  - getHeaders
```
protected Headers getHeaders()
```
  - getReadBufferSize
```
protected int getReadBufferSize()
```
  - getLogger
```
protected Logger getLogger()
```

Class ServerResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServerResponse

ServerResponse

Method Detail

create

create

getResponseCode

getResponseMessage

setResponseMessage

setCharEncoding

isOk

isRedirect

isCodeIn

isCodeInRange

getLocationHeader

toString

setContentType

getCharset

setCharset

getContentMediaType

setContentMediaType

hasContentData

getContentLength

appendContent

appendContent

appendContent

getContentData

getContentReader

getContentText

addAllHeaders

addHeaders

addHeader

addHeader

setHeader

setHeader

getHeader

getHeader

removeHeader

removeHeader

self

asMediaType

asCharset

getContentTypeHeader

setContentTypeHeader

getCharsetEncoding

getDefaultCharset

getContentBuffer

getContentDataStream

setContentDataStream

getHeaders

getReadBufferSize

getLogger