Response (JWIG)

java.lang.Object
- dk.brics.jwig.Response

```
public class Response
extends Object
```
Response for an HTTP request.

Constructor Summary

Constructors
Constructor and Description

Response()
Constructs a new empty response with status code 200 (OK).

Response(Response p)
Constructs a new empty response from an existing one.

Constructors
Constructor and Description
`Response()` Constructs a new empty response with status code 200 (OK).
`Response(Response p)` Constructs a new empty response from an existing one.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCookie(Cookie c)` Adds a cookie.
`void`	`addSession(Session s)` Adds a session as relevant for the response.
`String`	`getETag()` Returns the current ETag of this response.
`AbstractHandler`	`getHandler(String name)` Returns a registered handler, or null if not found.
`Collection<AbstractHandler>`	`getHandlers()` Returns the registered handlers.
`long`	`getLastModified()` Returns the current Last-Modified timestamp of this response.
`Object`	`getObject()` Returns the payload
`Object`	`getResult()`
`Set<Session>`	`getSessions()` Returns the associated sessions.
`int`	`getStatus()` Returns the status code.
`String`	`getText()` Returns the plain-text payload.
`XML`	`getXML()` Returns the XML payload.
`boolean`	`hasPayload()`
`boolean`	`isAugmented()` Returns augmented status.
`boolean`	`isText()` Checks whether the payload is plain-text.
`boolean`	`isXML()` Checks whether the payload is XML.
`void`	`refresh(Object value)` Refreshes the ETag and the Last-Modified timestamp.
`void`	`setAugmented(boolean augmented)` Sets augmented status.
`void`	`setContentType(String contenttype)` Sets the Content-Type.
`void`	`setHandler(String name, AbstractHandler sh)` Registers a handler for this response.
`void`	`setResult(Object result)`
`void`	`setStatus(int status)` Sets the status code.
`void`	`setText(String str)` Sets the payload to the given plain-text value.
`void`	`setXML(XML xml)` Sets the payload to the given XML value.
`void`	`write(HttpServletRequest request, HttpServletResponse response)` Writes this response as HTTP response to the client and closes the response.

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

- Constructor Detail
  - Response
```
public Response()
```
    Constructs a new empty response with status code 200 (OK).
  - Response
```
public Response(Response p)
```
    Constructs a new empty response from an existing one. Inherits handlers, status, sessions, content type from the existing response object.
- Method Detail
  - addCookie
```
public void addCookie(Cookie c)
```
    Adds a cookie.
  - addSession
```
public void addSession(Session s)
```
    Adds a session as relevant for the response.
  - getETag
```
public String getETag()
```
    Returns the current ETag of this response.
  - getHandler
```
public AbstractHandler getHandler(String name)
```
    Returns a registered handler, or null if not found.
  - getHandlers
```
public Collection<AbstractHandler> getHandlers()
```
    Returns the registered handlers.
  - getLastModified
```
public long getLastModified()
```
    Returns the current Last-Modified timestamp of this response.
  - getObject
```
public Object getObject()
```
    Returns the payload
  - getResult
```
public Object getResult()
```
  - getSessions
```
public Set<Session> getSessions()
```
    Returns the associated sessions.
    
    Returns:
    non-null set of sessions
  - getStatus
```
public int getStatus()
```
    Returns the status code.
  - getText
```
public String getText()
               throws JWIGException
```
    Returns the plain-text payload.
    
    Throws:
    
    JWIGException - if the response has no plain-text value
  - getXML
```
public XML getXML()
           throws JWIGException
```
    Returns the XML payload.
    
    Throws:
    
    JWIGException - if the response has no XML value
  - hasPayload
```
public boolean hasPayload()
```
  - isAugmented
```
public boolean isAugmented()
```
    Returns augmented status.
  - isText
```
public boolean isText()
```
    Checks whether the payload is plain-text.
  - isXML
```
public boolean isXML()
```
    Checks whether the payload is XML.
  - refresh
```
public void refresh(Object value)
```
    Refreshes the ETag and the Last-Modified timestamp.
  - setAugmented
```
public void setAugmented(boolean augmented)
```
    Sets augmented status.
  - setContentType
```
public void setContentType(String contenttype)
```
    Sets the Content-Type. Usually set automatically depending on the payload.
  - setHandler
```
public void setHandler(String name,
              AbstractHandler sh)
```
    Registers a handler for this response.
  - setResult
```
public void setResult(Object result)
```
  - setStatus
```
public void setStatus(int status)
```
    Sets the status code. Default: 200 (OK) (See HttpServletResponse for possible status codes)
  - setText
```
public void setText(String str)
```
    Sets the payload to the given plain-text value.
  - setXML
```
public void setXML(XML xml)
```
    Sets the payload to the given XML value.
  - write
```
public void write(HttpServletRequest request,
         HttpServletResponse response)
```
    Writes this response as HTTP response to the client and closes the response.

Class Response

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Response

Response

Method Detail

addCookie

addSession

getETag

getHandler

getHandlers

getLastModified

getObject

getResult

getSessions

getStatus

getText

getXML

hasPayload

isAugmented

isText

isXML

refresh

setAugmented

setContentType

setHandler

setResult

setStatus

setText

setXML

write