org.jooby

Interface Response

All Known Implementing Classes:

Response.Forwarding

public interface Response

Give you access to the actual HTTP response. You can read/write headers and write HTTP body.

Since:

0.1.0

Author:

edgar

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Response.Forwarding A forwarding response.

Method Summary

Modifier and Type	Method and Description
void	after(Route.After handler) Append an after handler, will be execute before sending response.
Charset	charset() If charset is not set this method returns charset defined in the request body.
Response	charset(Charset charset) Set the Charset to use and set the Content-Type header with the current charset.
Response	clearCookie(String name) Discard a cookie from response.
boolean	committed() Returns a boolean indicating if the response has been committed.
void	complete(Route.Complete handler) Append complete handler, will be execute after sending response.
Response	cookie(Cookie.Definition cookie) Adds the specified cookie to the response.
Response	cookie(Cookie cookie) Adds the specified cookie to the response.
default Response	cookie(String name, String value) Adds the specified cookie to the response.
default void	download(File file) Transfer the file at path as an "attachment".
default void	download(String location) Transfer the file at path as an "attachment".
default void	download(String filename, File file) Transfer the file at path as an "attachment".
void	download(String filename, InputStream stream) Transfer the file at path as an "attachment".
void	download(String filename, String location) Transfer the file at path as an "attachment".
void	end() Ends current request/response cycle by releasing any existing resources and committing the response into the channel.
Mutant	header(String name) Get a header with the given name.
Response	header(String name, Iterable<Object> values) Sets a response header with the given name and value.
default Response	header(String name, Object... values) Sets a response header with the given name and value.
Response	header(String name, Object value) Sets a response header with the given name and value.
boolean	isResetHeadersOnError() Indicates if headers are cleared/reset on error.
Response	length(long length) Set the length of the response and set the Content-Length header.
void	redirect(Status status, String location) Redirect to the given url with status code defaulting to Status.FOUND.
default void	redirect(String location) Redirect to the given url with status code defaulting to Status.FOUND.
default void	send(Object result) Responsible of writing the given body into the HTTP response.
void	send(Result result) Responsible of writing the given body into the HTTP response.
void	setResetHeadersOnError(boolean value) Indicates if headers are cleared/reset on error.
Optional<Status>	status()
default Response	status(int status) Set the HTTP response status.
Response	status(Status status) Set the HTTP response status.
Optional<MediaType>	type()
Response	type(MediaType type) Set the response media type and set the Content-Type header.
default Response	type(String type) Set the response media type and set the Content-Type header.

Method Detail

download

void download(String filename,
              InputStream stream)
       throws Throwable

Transfer the file at path as an "attachment". Typically, browsers will prompt the user for download. The Content-Disposition "filename=" parameter (i.e. the one that will appear in the browser dialog) is set to filename.

Parameters:

filename - A file name to use.

stream - A stream to attach.

Throws:

Exception - If something goes wrong.

Throwable

download

default void download(String location)
               throws Throwable

Transfer the file at path as an "attachment". Typically, browsers will prompt the user for download. The Content-Disposition "filename=" parameter (i.e. the one that will appear in the browser dialog) is set to filename by default.

Parameters:

location - Classpath location of the file.

Throws:

Exception - If something goes wrong.

Throwable

download

void download(String filename,
              String location)
       throws Throwable

Transfer the file at path as an "attachment". Typically, browsers will prompt the user for download. The Content-Disposition "filename=" parameter (i.e. the one that will appear in the browser dialog) is set to filename by default.

Parameters:

filename - A file name to use.

location - classpath location of the file.

Throws:

Exception - If something goes wrong.

Throwable

download

default void download(File file)
               throws Throwable

Transfer the file at path as an "attachment". Typically, browsers will prompt the user for download. The Content-Disposition "filename=" parameter (i.e. the one that will appear in the browser dialog) is set to filename by default.

Parameters:

file - A file to use.

Throws:

Exception - If something goes wrong.

Throwable

download

default void download(String filename,
                      File file)
               throws Throwable

Transfer the file at path as an "attachment". Typically, browsers will prompt the user for download. The Content-Disposition "filename=" parameter (i.e. the one that will appear in the browser dialog) is set to filename.

Parameters:

filename - A file name to use.

file - A file to use.

Throws:

Exception - If something goes wrong.

Throwable

cookie

@Nonnull
default Response cookie(String name,
                                 String value)

Adds the specified cookie to the response.

Parameters:

name - A cookie's name.

value - A cookie's value.

Returns:

This response.

cookie

@Nonnull
Response cookie(Cookie.Definition cookie)

Adds the specified cookie to the response.

Parameters:

cookie - A cookie definition.

Returns:

This response.

cookie

@Nonnull
Response cookie(Cookie cookie)

Adds the specified cookie to the response.

Parameters:

cookie - A cookie.

Returns:

This response.

clearCookie

@Nonnull
Response clearCookie(String name)

Discard a cookie from response. Discard is done by setting maxAge=0.

Parameters:

name - Cookie's name.

Returns:

This response.

header

@Nonnull
Mutant header(String name)

Get a header with the given name.

Parameters:

name - A name.

Returns:

A HTTP header.

header

@Nonnull
Response header(String name,
                         Object value)

Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one.

Parameters:

name - Header's name.

value - Header's value.

Returns:

This response.

header

@Nonnull
default Response header(String name,
                                 Object... values)

Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one.

Parameters:

name - Header's name.

values - Header's value.

Returns:

This response.

header

@Nonnull
Response header(String name,
                         Iterable<Object> values)

Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one.

Parameters:

name - Header's name.

values - Header's value.

Returns:

This response.

charset

@Nonnull
Charset charset()

If charset is not set this method returns charset defined in the request body. If the request doesn't specify a character encoding, this method return the global charset: application.charset.

Returns:

A current charset.

charset

@Nonnull
Response charset(Charset charset)

Set the Charset to use and set the Content-Type header with the current charset.

Parameters:

charset - A charset.

Returns:

This response.

length

@Nonnull
Response length(long length)

Set the length of the response and set the Content-Length header.

Parameters:

length - Length of response.

Returns:

This response.

type

@Nonnull
Optional<MediaType> type()

Returns:

Get the response type.

type

@Nonnull
Response type(MediaType type)

Set the response media type and set the Content-Type header.

Parameters:

type - A media type.

Returns:

This response.

type

@Nonnull
default Response type(String type)

Set the response media type and set the Content-Type header.

Parameters:

type - A media type.

Returns:

This response.

send

default void send(@Nullable
                  Object result)
           throws Throwable

Responsible of writing the given body into the HTTP response.

Parameters:

result - The HTTP body.

Throws:

Exception - If the response write fails.

Throwable

send

void send(Result result)
   throws Throwable

Responsible of writing the given body into the HTTP response.

Parameters:

result - A HTTP response.

Throws:

Exception - If the response write fails.

Throwable

redirect

default void redirect(String location)
               throws Throwable

Redirect to the given url with status code defaulting to Status.FOUND.

  rsp.redirect("/foo/bar");
  rsp.redirect("http://example.com");
  rsp.redirect("http://example.com");
  rsp.redirect("../login");
 

Redirects can be a fully qualified URI for redirecting to a different site:

   rsp.redirect("http://google.com");
 

Redirects can be relative to the root of the host name. For example, if you were on http://example.com/admin/post/new, the following redirect to /admin would land you at http://example.com/admin:

   rsp.redirect("/admin");
 

Redirects can be relative to the current URL. A redirection of post/new, from http://example.com/blog/admin/ (notice the trailing slash), would give you http://example.com/blog/admin/post/new.

   rsp.redirect("post/new");
 

Redirecting to post/new from http://example.com/blog/admin (no trailing slash), will take you to http://example.com/blog/post/new.

If you found the above behavior confusing, think of path segments as directories (have trailing slashes) and files, it will start to make sense.

Pathname relative redirects are also possible. If you were on http://example.com/admin/post/new, the following redirect would land you at http//example.com/admin:

   rsp.redirect("..");
 

A back redirection will redirect the request back to the Referer, defaulting to / when missing.

   rsp.redirect("back");
 

Parameters:

location - Either a relative or absolute location.

Throws:

Throwable - If redirection fails.

redirect

void redirect(Status status,
              String location)
       throws Throwable

Redirect to the given url with status code defaulting to Status.FOUND.

  rsp.redirect("/foo/bar");
  rsp.redirect("http://example.com");
  rsp.redirect("http://example.com");
  rsp.redirect("../login");
 

Redirects can be a fully qualified URI for redirecting to a different site:

   rsp.redirect("http://google.com");
 

Redirects can be relative to the root of the host name. For example, if you were on http://example.com/admin/post/new, the following redirect to /admin would land you at http://example.com/admin:

   rsp.redirect("/admin");
 

Redirects can be relative to the current URL. A redirection of post/new, from http://example.com/blog/admin/ (notice the trailing slash), would give you http://example.com/blog/admin/post/new.

   rsp.redirect("post/new");
 

Redirecting to post/new from http://example.com/blog/admin (no trailing slash), will take you to http://example.com/blog/post/new.

If you found the above behavior confusing, think of path segments as directories (have trailing slashes) and files, it will start to make sense.

Pathname relative redirects are also possible. If you were on http://example.com/admin/post/new, the following redirect would land you at http//example.com/admin:

   rsp.redirect("..");
 

A back redirection will redirect the request back to the Referer, defaulting to / when missing.

   rsp.redirect("back");
 

Parameters:

status - A redirect status.

location - Either a relative or absolute location.

Throws:

Throwable - If redirection fails.

status

@Nonnull
Optional<Status> status()

Returns:

A HTTP status or empty if status was not set yet.

status

@Nonnull
Response status(Status status)

Set the HTTP response status.

Parameters:

status - A HTTP status.

Returns:

This response.

status

@Nonnull
default Response status(int status)

Set the HTTP response status.

Parameters:

status - A HTTP status.

Returns:

This response.

committed

boolean committed()

Returns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written.

Returns:

a boolean indicating if the response has been committed

end

void end()

Ends current request/response cycle by releasing any existing resources and committing the response into the channel. This method is automatically call it from a send method, so you are not force to call this method per each request/response cycle. It's recommended for quickly ending the response without any data:

   rsp.status(304).end();
 

Keep in mind that an explicit call to this method will stop the execution of handlers. So, any handler further in the chain won't be executed once end has been called.

after

void after(Route.After handler)

Append an after handler, will be execute before sending response.

Parameters:

handler - A handler

See Also:

Route.After

complete

void complete(Route.Complete handler)

Append complete handler, will be execute after sending response.

Parameters:

handler - A handler

See Also:

Route.After

isResetHeadersOnError

boolean isResetHeadersOnError()

Indicates if headers are cleared/reset on error.

Returns:

Indicates if headers are cleared/reset on error. Default is true.

setResetHeadersOnError

void setResetHeadersOnError(boolean value)

Indicates if headers are cleared/reset on error.

Parameters:

value - True to reset.