Response (mangooio-core 3.6.0 API)

java.lang.Object
- io.mangoo.routing.Response

public final class Response
extends Object

Author:: svenkubiak

Constructor Summary

Constructors
Constructor and Description

Response()

Constructors
Constructor and Description
`Response()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Response`	`andBinaryContent(byte[] content)` Sends binary content to the client skipping rendering
`Response`	`andBinaryFile(File file)` Sends a binary file to the client skipping rendering
`Response`	`andBody(String body)` Sets the body of the response.
`Response`	`andCharset(String charset)` Sets a specific charset to the response
`Response`	`andContent(Map<String,Object> content)` Adds an additional content map to the content rendered in the template.
`Response`	`andContent(String name, Object object)` Adds a value to the template that can be accessed using ${name} in the template
`Response`	`andContentType(String contentType)` Sets a specific content type to use for the response.
`Response`	`andCookie(io.undertow.server.handlers.Cookie cookie)` Adds an additional Cookie to the response which is passed to the client
`Response`	`andEmptyBody()` Disables template rendering, sending an empty body in the response
`Response`	`andEtag()` Adds an ETag header to the response by hashing (MD5) the response body.
`Response`	`andHeader(io.undertow.util.HttpString key, String value)` Adds an additional header to the request response.
`Response`	`andHeaders(Map<io.undertow.util.HttpString,String> headers)` Adds an additional header map to the response.
`Response`	`andJsonBody(Object jsonObject)` Converts a given Object to JSON and passing it to the response.
`Response`	`andTemplate(String template)` Sets a specific template to use for the response
`Response`	`andTextBody(String text)` Sets the body of the response.
`Response`	`end()` Tells a filter that the response ends and that the request handler should not execute further filters by sending the current response to the client.
`byte[]`	`getBinaryContent()`
`String`	`getBinaryFileName()`
`String`	`getBody()`
`String`	`getCharset()`
`Map<String,Object>`	`getContent()`
`String`	`getContentType()`
`List<io.undertow.server.handlers.Cookie>`	`getCookies()`
`Map<io.undertow.util.HttpString,String>`	`getHeaders()`
`String`	`getRedirectTo()`
`int`	`getStatusCode()`
`String`	`getTemplate()`
`boolean`	`isBinary()`
`boolean`	`isEndResponse()`
`boolean`	`isETag()`
`boolean`	`isRedirect()`
`boolean`	`isRendered()`
`static Response`	`withBadRequest()` Creates a response object with HTTP status code 400
`static Response`	`withCreated()` Creates a response object with HTTP status code 201
`static Response`	`withForbidden()` Creates a response object with HTTP status code 401
`static Response`	`withInternalServerError()` Creates a response object with HTTP status code 500
`static Response`	`withNotFound()` Creates a response object with HTTP status code 404
`static Response`	`withOk()` Creates a response object with HTTP status code 200
`static Response`	`withRedirect(String redirectTo)` Creates a response object with a given url to redirect to
`static Response`	`withStatusCode(int statusCode)` Creates a response object with a given HTTP status code
`static Response`	`withUnauthorized()` Creates a response object with HTTP status code 403

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

- Constructor Detail
  - Response
```
public Response()
```
- Method Detail
  - getStatusCode
```
public int getStatusCode()
```
  - getContentType
```
public String getContentType()
```
  - getCharset
```
public String getCharset()
```
  - getBody
```
public String getBody()
```
  - getCookies
```
public List<io.undertow.server.handlers.Cookie> getCookies()
```
  - getBinaryContent
```
public byte[] getBinaryContent()
```
  - getTemplate
```
public String getTemplate()
```
  - isETag
```
public boolean isETag()
```
  - getBinaryFileName
```
public String getBinaryFileName()
```
  - getContent
```
public Map<String,Object> getContent()
```
  - isRedirect
```
public boolean isRedirect()
```
  - isBinary
```
public boolean isBinary()
```
  - isRendered
```
public boolean isRendered()
```
  - isEndResponse
```
public boolean isEndResponse()
```
  - getRedirectTo
```
public String getRedirectTo()
```
  - getHeaders
```
public Map<io.undertow.util.HttpString,String> getHeaders()
```
  - withOk
```
public static Response withOk()
```
    Creates a response object with HTTP status code 200
    
    Returns:
    
    A response object Response
  - withCreated
```
public static Response withCreated()
```
    Creates a response object with HTTP status code 201
    
    Returns:
    
    A response object Response
  - withNotFound
```
public static Response withNotFound()
```
    Creates a response object with HTTP status code 404
    
    Returns:
    
    A response object Response
  - withForbidden
```
public static Response withForbidden()
```
    Creates a response object with HTTP status code 401
    
    Returns:
    
    A response object Response
  - withUnauthorized
```
public static Response withUnauthorized()
```
    Creates a response object with HTTP status code 403
    
    Returns:
    
    A response object Response
  - withBadRequest
```
public static Response withBadRequest()
```
    Creates a response object with HTTP status code 400
    
    Returns:
    
    A response object Response
  - withInternalServerError
```
public static Response withInternalServerError()
```
    Creates a response object with HTTP status code 500
    
    Returns:
    
    A response object Response
  - withStatusCode
```
public static Response withStatusCode(int statusCode)
```
    Creates a response object with a given HTTP status code
    
    Parameters:
    
    statusCode - The status code to set
    
    Returns:
    
    A response object Response
  - withRedirect
```
public static Response withRedirect(String redirectTo)
```
    Creates a response object with a given url to redirect to
    
    Parameters:
    
    redirectTo - The URL to redirect to
    
    Returns:
    
    A response object Response
  - andTemplate
```
public Response andTemplate(String template)
```
    Sets a specific template to use for the response
    
    Parameters:
    
    template - The path to the template (e.g. /mytemplate/template.ftl)
    
    Returns:
    
    A response object Response
  - andContentType
```
public Response andContentType(String contentType)
```
    Sets a specific content type to use for the response. Default is "text/html"
    
    Parameters:
    
    contentType - The content type to use
    
    Returns:
    
    A response object Response
  - andCharset
```
public Response andCharset(String charset)
```
    Sets a specific charset to the response
    
    Parameters:
    
    charset - The charset to use
    
    Returns:
    
    A response object Response
  - andContent
```
public Response andContent(String name,
                           Object object)
```
    Adds a value to the template that can be accessed using ${name} in the template
    
    Parameters:
    
    name - The name of the value
    
    object - The actual value
    
    Returns:
    
    A response object Response
  - andBody
```
public Response andBody(String body)
```
    Sets the body of the response. If a body is added, no template rendering will be performed. The default content type "text/html" will be used.
    
    Parameters:
    
    body - The body for the response
    
    Returns:
    
    A response object Response
  - andCookie
```
public Response andCookie(io.undertow.server.handlers.Cookie cookie)
```
    Adds an additional Cookie to the response which is passed to the client
    
    Parameters:
    
    cookie - The cookie to add
    
    Returns:
    
    A response object Response
  - andJsonBody
```
public Response andJsonBody(Object jsonObject)
```
    Converts a given Object to JSON and passing it to the response. If an object is given, no template rendering will be performed and the content type for the response will be set to "application/json"
    
    Parameters:
    
    jsonObject - The object to convert to JSON
    
    Returns:
    
    A response object Response
  - andBinaryFile
```
public Response andBinaryFile(File file)
```
    Sends a binary file to the client skipping rendering
    
    Parameters:
    
    file - The file to send
    
    Returns:
    
    A response object Response
  - andBinaryContent
```
public Response andBinaryContent(byte[] content)
```
    Sends binary content to the client skipping rendering
    
    Parameters:
    
    content - The content to to send
    
    Returns:
    
    A response object Response
  - andTextBody
```
public Response andTextBody(String text)
```
    Sets the body of the response. If a body is added, no template rendering will be performed. The content type "text/plain" will be used.
    
    Parameters:
    
    text - The text for the response
    
    Returns:
    
    A response object Response
  - andEmptyBody
```
public Response andEmptyBody()
```
    Disables template rendering, sending an empty body in the response
    
    Returns:
    
    A response object Response
  - andHeader
```
public Response andHeader(io.undertow.util.HttpString key,
                          String value)
```
    Adds an additional header to the request response. If an header key already exists, it will we overwritten with the latest value.
    
    Parameters:
    
    key - The header constant from Headers class (e.g. Headers.CONTENT_TYPE)
    
    value - The header value
    
    Returns:
    
    A response object Response
  - andContent
```
public Response andContent(Map<String,Object> content)
```
    Adds an additional content map to the content rendered in the template. Already existing values with the same key are overwritten.
    
    Parameters:
    
    content - The content map to add
    
    Returns:
    
    A response object Response
  - andHeaders
```
public Response andHeaders(Map<io.undertow.util.HttpString,String> headers)
```
    Adds an additional header map to the response. Already existing values with the same key are overwritten.
    
    Parameters:
    
    headers - The headers map to add
    
    Returns:
    
    A response object Response
  - andEtag
```
public Response andEtag()
```
    Adds an ETag header to the response by hashing (MD5) the response body. Be aware that for every request the hash has to be generated. This will most likely increase CPU usage. See https://en.wikipedia.org/wiki/HTTP_ETag
    
    Returns:
    
    A response object Response
  - end
```
public Response end()
```
    Tells a filter that the response ends and that the request handler should not execute further filters by sending the current response to the client. This is only used within a filter.
    
    Returns:
    
    A response object Response

Class Response

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Response

Method Detail

getStatusCode

getContentType

getCharset

getBody

getCookies

getBinaryContent

getTemplate

isETag

getBinaryFileName

getContent

isRedirect

isBinary

isRendered

isEndResponse

getRedirectTo

getHeaders

withOk

withCreated

withNotFound

withForbidden

withUnauthorized

withBadRequest

withInternalServerError

withStatusCode

withRedirect

andTemplate

andContentType

andCharset

andContent

andBody

andCookie

andJsonBody

andBinaryFile

andBinaryContent

andTextBody

andEmptyBody

andHeader

andContent

andHeaders

andEtag

end