Response (egothor2 4.0.5-SNAPSHOT API)

java.lang.Object
- org.egothor.robot.Response

```
public final class Response
extends Object
```
Response sent from a server.

Author:

Leo Galambos

Field Summary

Fields
Modifier and Type Field and Description

String DEFAULT_ENC
The default enconding we use (ISO-8859-1).

Fields
Modifier and Type	Field and Description
`String`	`DEFAULT_ENC` The default enconding we use (ISO-8859-1).

Constructor Summary

Constructors
Constructor and Description

Response()
Constructor for the Response object

Constructors
Constructor and Description
`Response()` Constructor for the Response object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dumpHeaders(Logger logger)`
`static String`	`getContentCharSet(String val, String def)` Parse the charset spec, i.e.
`byte[]`	`getData()`
`String`	`getHeader(String header, String defaultValue)` Gets the first header among HTTP headers or return the default value if the header is not in the response.
`ArrayList<Anchor>`	`getImageLinks()` Gets all img-src links discovered - only responses of text/html are analyzed by the html parser.
`long`	`getInvertizeTime()`
`ArrayList<Anchor>`	`getLinks()` Gets all links discovered - only responses of text/html are analyzed by the html parser.
`byte[]`	`getMD5()` Gets the md5 attribute of the data stream.
`String`	`getMsg()`
`long`	`getParseTime()`
`Reader`	`getReader()` Returns the content of this response with charset specified in HTTP header.
`Reader`	`getReader(String charset)` Returns a correct reader of the data stream.
`int`	`getStatus()`
`long`	`getTimestamp()` Gets the timestamp attribute of the Response object
`long`	`getUID()`
`String`	`getURI()`
`boolean`	`isFatalErr()` Fatal error is defined as `status` lower than 0.
`boolean`	`isMiscErr()` Error is miscellaneous when it is not a fatal error and it is not a success.
`String`	`isRedirect()` Response is a redirect when `status` is HTTP_MOVED_PERM or HTTP_MOVED_TEMP or HTTP_SEE_OTHER or 307, then this method returns `location` HTTP header value.
`boolean`	`isSuccess()` Response is a success when it ends with `status` HTTP_OK.
`void`	`load(DataInput in)` Loads the object from a stream.
`Document`	`process()` Process just the text/html document and create its Egothor's counterpart, return null in the case of other content types.
`void`	`setData(byte[] data)` Sets the data attribute of the Response object
`void`	`setEncoder(EventEncoder encoder)`
`void`	`setHeaders(HashMap<String,String> headers)` Sets the headers attribute of the Response object
`void`	`setMsg(String msg)` Sets the msg attribute of the Response object
`void`	`setStatus(int status)` Sets the status attribute of the Response object
`long`	`setTimestamp()` Sets the timestamp attribute of the Response object
`void`	`setUID(long uid)`
`void`	`setURI(String uri)`
`void`	`store(DataOutput out)` Saves the response into a stream.

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

- Field Detail
  - DEFAULT_ENC
```
public final String DEFAULT_ENC
```
    The default enconding we use (ISO-8859-1).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Response
```
public Response()
```
    Constructor for the Response object
- Method Detail
  - dumpHeaders
```
public void dumpHeaders(Logger logger)
```
  - setUID
```
public void setUID(long uid)
```
  - getUID
```
public long getUID()
```
  - setURI
```
public void setURI(String uri)
```
  - getURI
```
public String getURI()
```
  - setData
```
public void setData(byte[] data)
```
    Sets the data attribute of the Response object
    
    Parameters:
    
    data - The new data value
  - getData
```
public byte[] getData()
```
  - getParseTime
```
public long getParseTime()
```
  - getInvertizeTime
```
public long getInvertizeTime()
```
  - setHeaders
```
public void setHeaders(HashMap<String,String> headers)
```
    Sets the headers attribute of the Response object
    
    Parameters:
    
    headers - The new headers value
  - setMsg
```
public void setMsg(String msg)
```
    Sets the msg attribute of the Response object
    
    Parameters:
    
    msg - The new msg value
  - getMsg
```
public String getMsg()
```
  - setStatus
```
public void setStatus(int status)
```
    Sets the status attribute of the Response object
    
    Parameters:
    
    status - The new status value
  - setTimestamp
```
public long setTimestamp()
```
    Sets the timestamp attribute of the Response object
    
    Returns:
  - getContentCharSet
```
public static String getContentCharSet(String val,
                                       String def)
```
    Parse the charset spec, i.e. text/html;charset=ISO-8859-2 . If the charset attribute is not given, def is returned.
    
    Parameters:
    
    val - Description of the Parameter
    
    def - Description of the Parameter
    
    Returns:
    
    The contentCharSet value
  - isFatalErr
```
public boolean isFatalErr()
```
    Fatal error is defined as status lower than 0.
    
    Returns:
    
    The fatalErr value
  - getHeader
```
public String getHeader(String header,
                        String defaultValue)
```
    Gets the first header among HTTP headers or return the default value if the header is not in the response.
    
    Parameters:
    
    header - Description of the Parameter
    
    defaultValue -
    
    Returns:
    
    The firstHeader value
  - getLinks
```
public ArrayList<Anchor> getLinks()
```
    Gets all links discovered - only responses of text/html are analyzed by the html parser. All links are normalized.
    
    Returns:
    
    The links value
  - getImageLinks
```
public ArrayList<Anchor> getImageLinks()
```
    Gets all img-src links discovered - only responses of text/html are analyzed by the html parser. All links are normalized.
    
    Returns:
    
    The links value
  - process
```
public Document process()
```
    Process just the text/html document and create its Egothor's counterpart, return null in the case of other content types.
    
    Returns:
  - getMD5
```
public byte[] getMD5()
```
    Gets the md5 attribute of the data stream.
    
    Returns:
    
    The md5 value
  - isMiscErr
```
public boolean isMiscErr()
```
    Error is miscellaneous when it is not a fatal error and it is not a success.
    
    Returns:
    
    The miscErr value
    
    See Also:
    
    isFatalErr(), isSuccess()
  - getReader
```
public Reader getReader(String charset)
```
    Returns a correct reader of the data stream.
    
    Parameters:
    
    charset - a charset to be used over the data
    
    Returns:
    
    The reader value
  - getReader
```
public Reader getReader()
```
    Returns the content of this response with charset specified in HTTP header. If the specification is missing, then DEFAULT_ENC is used instead.
    
    Returns:
    
    the content of this response
  - isRedirect
```
public String isRedirect()
```
    Response is a redirect when status is HTTP_MOVED_PERM or HTTP_MOVED_TEMP or HTTP_SEE_OTHER or 307, then this method returns location HTTP header value.
    
    Returns:
    
    Not-null value when the document is redirected elsewhere
  - isSuccess
```
public boolean isSuccess()
```
    Response is a success when it ends with status HTTP_OK.
    
    Returns:
    
    The success value
  - getTimestamp
```
public long getTimestamp()
```
    Gets the timestamp attribute of the Response object
    
    Returns:
    
    The timestamp value
  - store
```
public void store(DataOutput out)
           throws IOException
```
    Saves the response into a stream.
    
    Parameters:
    
    out - The stream
    
    Throws:
    
    IOException
  - load
```
public void load(DataInput in)
          throws IOException
```
    Loads the object from a stream.
    
    Parameters:
    
    in - The stream
    
    Throws:
    
    IOException
  - setEncoder
```
public void setEncoder(EventEncoder encoder)
```
  - getStatus
```
public int getStatus()
```

Class Response

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ENC

Constructor Detail

Response

Method Detail

dumpHeaders

setUID

getUID

setURI

getURI

setData

getData

getParseTime

getInvertizeTime

setHeaders

setMsg

getMsg

setStatus

setTimestamp

getContentCharSet

isFatalErr

getHeader

getLinks

getImageLinks

process

getMD5

isMiscErr

getReader

getReader

isRedirect

isSuccess

getTimestamp

store

load

setEncoder

getStatus