io.jooby.internal

Class ReadOnlyContext

java.lang.Object

io.jooby.ForwardingContext

io.jooby.internal.ReadOnlyContext

All Implemented Interfaces:

Context, Registry

public class ReadOnlyContext
extends ForwardingContext

Field Summary

Fields inherited from interface io.jooby.Context

ACCEPT, GMT, PORT, RFC1123, RFC1123_PATTERN, SECURE_PORT

Constructor Summary

Constructors

Constructor and Description
ReadOnlyContext(Context context)

Method Summary

Modifier and Type	Method and Description
boolean	isResponseStarted() True if response already started.
Context	removeResponseHeader(String name) Remove a response header.
Context	render(Object value) Render a value and send the response to client.
Sender	responseSender() HTTP response channel as chunker.
OutputStream	responseStream() HTTP response channel as output stream.
OutputStream	responseStream(MediaType contentType) HTTP response channel as output stream.
Context	responseStream(MediaType contentType, SneakyThrows.Consumer<OutputStream> consumer) HTTP response channel as output stream.
Context	responseStream(SneakyThrows.Consumer<OutputStream> consumer) HTTP response channel as output stream.
PrintWriter	responseWriter() HTTP response channel as response writer.
PrintWriter	responseWriter(MediaType contentType) HTTP response channel as response writer.
PrintWriter	responseWriter(MediaType contentType, Charset charset) HTTP response channel as response writer.
Context	responseWriter(MediaType contentType, Charset charset, SneakyThrows.Consumer<PrintWriter> consumer) HTTP response channel as response writer.
Context	responseWriter(MediaType contentType, SneakyThrows.Consumer<PrintWriter> consumer) HTTP response channel as response writer.
Context	responseWriter(SneakyThrows.Consumer<PrintWriter> consumer) HTTP response channel as response writer.
Context	send(AttachedFile file) Send a file attached response.
Context	send(byte[] data) Send response data.
Context	send(ByteBuffer data) Send response data.
Context	send(FileChannel file) Send a file response.
Context	send(InputStream input) Send response data.
Context	send(Path file) Send a file response.
Context	send(ReadableByteChannel channel) Send response data.
Context	send(StatusCode statusCode) Send an empty response with the given status code.
Context	send(String data) Send response data.
Context	send(String data, Charset charset) Send response data.
Context	sendError(Throwable cause) Send an error response.
Context	sendError(Throwable cause, StatusCode statusCode) Send an error response.
Context	sendRedirect(StatusCode redirect, String location) Send a redirect response.
Context	sendRedirect(String location) Send a 302 response.
Context	setDefaultResponseType(MediaType contentType) Set the default response content type header.
Context	setResponseCode(int statusCode) Set response status code.
Context	setResponseCode(StatusCode statusCode) Set response status code.
Context	setResponseCookie(Cookie cookie) Set/add a cookie to response.
Context	setResponseHeader(String name, Date value) Set response header.
Context	setResponseHeader(String name, Instant value) Set response header.
Context	setResponseHeader(String name, Object value) Set response header.
Context	setResponseHeader(String name, String value) Set response header.
Context	setResponseLength(long length) Set response content length header.
Context	setResponseType(MediaType contentType) Set response content type header.
Context	setResponseType(MediaType contentType, Charset charset) Set response content type header.
Context	setResponseType(String contentType) Set response content type header.

Methods inherited from class io.jooby.ForwardingContext

accept, accept, attribute, attribute, body, body, body, convert, cookie, cookieMap, decode, decoder, detach, dispatch, dispatch, file, files, files, flash, flash, form, form, form, formMap, formMultimap, getAttributes, getHost, getHostAndPort, getMethod, getPort, getProtocol, getRemoteAddress, getRequestLength, getRequestPath, getRequestType, getRequestType, getRequestURL, getRequestURL, getRequestURL, getRequestURL, getResetHeadersOnError, getResponseCode, getResponseLength, getResponseType, getRoute, getRouter, getScheme, getServerHost, getServerPort, getUser, header, header, headerMap, headerMultimap, isInIoThread, isSecure, matches, multipart, multipart, multipart, multipartMap, multipartMultimap, path, path, path, pathMap, pathString, query, query, query, queryMap, queryMultimap, queryString, removeResponseHeaders, require, require, require, send, send, session, session, sessionOrNull, setPathMap, setResetHeadersOnError, setRoute, setUser, toString, upgrade

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.jooby.Context

getContextPath, readOnly, websocket

Constructor Detail

ReadOnlyContext

public ReadOnlyContext(@Nonnull
                       Context context)

Method Detail

isResponseStarted

public boolean isResponseStarted()

Description copied from interface: Context

True if response already started.

Specified by:

isResponseStarted in interface Context

Overrides:

isResponseStarted in class ForwardingContext

Returns:

True if response already started.

send

@Nonnull
public Context send(@Nonnull
                             Path file)

Description copied from interface: Context

Send a file response.

Specified by:

send in interface Context

Overrides:

send in class ForwardingContext

Parameters:

file - File response.

Returns:

This context.

send

@Nonnull
public Context send(@Nonnull
                             byte[] data)

Description copied from interface: Context

Send response data.

Specified by:

send in interface Context

Overrides:

send in class ForwardingContext

Parameters:

data - Response.

Returns:

This context.

send

@Nonnull
public Context send(@Nonnull
                             String data)

Description copied from interface: Context

Send response data.

Specified by:

send in interface Context

Overrides:

send in class ForwardingContext

Parameters:

data - Response. Use UTF-8 charset.

Returns:

This context.

send

@Nonnull
public Context send(@Nonnull
                             ByteBuffer data)

Description copied from interface: Context

Send response data.

Specified by:

send in interface Context

Overrides:

send in class ForwardingContext

Parameters:

data - Response.

Returns:

This context.

send

@Nonnull
public Context send(@Nonnull
                             FileChannel file)

Description copied from interface: Context

Send a file response.

Specified by:

send in interface Context

Overrides:

send in class ForwardingContext

Parameters:

file - File response.

Returns:

This context.

send

@Nonnull
public Context send(@Nonnull
                             AttachedFile file)

Description copied from interface: Context

Send a file attached response.

Specified by:

send in interface Context

Overrides:

send in class ForwardingContext

Parameters:

file - Attached file.

Returns:

This context.

send

@Nonnull
public Context send(@Nonnull
                             InputStream input)

Description copied from interface: Context

Send response data.

Specified by:

send in interface Context

Overrides:

send in class ForwardingContext

Parameters:

input - Response.

Returns:

This context.

send

@Nonnull
public Context send(@Nonnull
                             StatusCode statusCode)

Description copied from interface: Context

Send an empty response with the given status code.

Specified by:

send in interface Context

Overrides:

send in class ForwardingContext

Parameters:

statusCode - Status code.

Returns:

This context.

send

@Nonnull
public Context send(@Nonnull
                             ReadableByteChannel channel)

Description copied from interface: Context

Send response data.

Specified by:

send in interface Context

Overrides:

send in class ForwardingContext

Parameters:

channel - Response input.

Returns:

This context.

send

@Nonnull
public Context send(@Nonnull
                             String data,
                             @Nonnull
                             Charset charset)

Description copied from interface: Context

Send response data.

Specified by:

send in interface Context

Overrides:

send in class ForwardingContext

Parameters:

data - Response.

charset - Charset.

Returns:

This context.

sendError

@Nonnull
public Context sendError(@Nonnull
                                  Throwable cause)

Description copied from interface: Context

Send an error response. Status code is computed via Router.errorCode(Throwable).

Specified by:

sendError in interface Context

Overrides:

sendError in class ForwardingContext

Parameters:

cause - Error. If this is a fatal error it is going to be rethrow it.

Returns:

This context.

sendError

@Nonnull
public Context sendError(@Nonnull
                                  Throwable cause,
                                  @Nonnull
                                  StatusCode statusCode)

Description copied from interface: Context

Send an error response.

Specified by:

sendError in interface Context

Overrides:

sendError in class ForwardingContext

Parameters:

cause - Error. If this is a fatal error it is going to be rethrow it.

statusCode - Status code.

Returns:

This context.

sendRedirect

@Nonnull
public Context sendRedirect(@Nonnull
                                     String location)

Description copied from interface: Context

Send a 302 response.

Specified by:

sendRedirect in interface Context

Overrides:

sendRedirect in class ForwardingContext

Parameters:

location - Location.

Returns:

This context.

sendRedirect

@Nonnull
public Context sendRedirect(@Nonnull
                                     StatusCode redirect,
                                     @Nonnull
                                     String location)

Description copied from interface: Context

Send a redirect response.

Specified by:

sendRedirect in interface Context

Overrides:

sendRedirect in class ForwardingContext

Parameters:

redirect - Redirect status code.

location - Location.

Returns:

This context.

render

@Nonnull
public Context render(@Nonnull
                               Object value)

Description copied from interface: Context

Render a value and send the response to client.

Specified by:

render in interface Context

Overrides:

render in class ForwardingContext

Parameters:

value - Object value.

Returns:

This context.

responseStream

@Nonnull
public Context responseStream(@Nonnull
                                       SneakyThrows.Consumer<OutputStream> consumer)
                                throws Exception

Description copied from interface: Context

HTTP response channel as output stream. Usually for chunked responses.

Specified by:

responseStream in interface Context

Overrides:

responseStream in class ForwardingContext

Parameters:

consumer - Output stream consumer.

Returns:

HTTP channel as output stream. Usually for chunked responses.

Throws:

Exception - Is something goes wrong.

responseStream

@Nonnull
public Context responseStream(@Nonnull
                                       MediaType contentType,
                                       @Nonnull
                                       SneakyThrows.Consumer<OutputStream> consumer)
                                throws Exception

Description copied from interface: Context

HTTP response channel as output stream. Usually for chunked responses.

Specified by:

responseStream in interface Context

Overrides:

responseStream in class ForwardingContext

Parameters:

contentType - Content type.

consumer - Output stream consumer.

Returns:

HTTP channel as output stream. Usually for chunked responses.

Throws:

Exception - Is something goes wrong.

responseWriter

@Nonnull
public Context responseWriter(@Nonnull
                                       MediaType contentType,
                                       @Nonnull
                                       SneakyThrows.Consumer<PrintWriter> consumer)
                                throws Exception

Description copied from interface: Context

HTTP response channel as response writer.

Specified by:

responseWriter in interface Context

Overrides:

responseWriter in class ForwardingContext

Parameters:

contentType - Content type.

consumer - Writer consumer.

Returns:

This context.

Throws:

Exception - Is something goes wrong.

responseWriter

@Nonnull
public Context responseWriter(@Nonnull
                                       SneakyThrows.Consumer<PrintWriter> consumer)
                                throws Exception

Description copied from interface: Context

HTTP response channel as response writer.

Specified by:

responseWriter in interface Context

Overrides:

responseWriter in class ForwardingContext

Parameters:

consumer - Writer consumer.

Returns:

This context.

Throws:

Exception - Is something goes wrong.

responseWriter

@Nonnull
public Context responseWriter(@Nonnull
                                       MediaType contentType,
                                       @Nullable
                                       Charset charset,
                                       @Nonnull
                                       SneakyThrows.Consumer<PrintWriter> consumer)
                                throws Exception

Description copied from interface: Context

HTTP response channel as response writer.

Specified by:

responseWriter in interface Context

Overrides:

responseWriter in class ForwardingContext

Parameters:

contentType - Content type.

charset - Charset.

consumer - Writer consumer.

Returns:

This context.

Throws:

Exception - Is something goes wrong.

responseStream

@Nonnull
public OutputStream responseStream()

Description copied from interface: Context

HTTP response channel as output stream. Usually for chunked responses.

Specified by:

responseStream in interface Context

Overrides:

responseStream in class ForwardingContext

Returns:

HTTP channel as output stream. Usually for chunked responses.

responseStream

@Nonnull
public OutputStream responseStream(@Nonnull
                                            MediaType contentType)

Description copied from interface: Context

HTTP response channel as output stream. Usually for chunked responses.

Specified by:

responseStream in interface Context

Overrides:

responseStream in class ForwardingContext

Parameters:

contentType - Media type.

Returns:

HTTP channel as output stream. Usually for chunked responses.

responseWriter

@Nonnull
public PrintWriter responseWriter()

Description copied from interface: Context

HTTP response channel as response writer.

Specified by:

responseWriter in interface Context

Overrides:

responseWriter in class ForwardingContext

Returns:

HTTP channel as response writer. Usually for chunked response.

responseWriter

@Nonnull
public PrintWriter responseWriter(@Nonnull
                                           MediaType contentType)

Description copied from interface: Context

HTTP response channel as response writer.

Specified by:

responseWriter in interface Context

Overrides:

responseWriter in class ForwardingContext

Parameters:

contentType - Content type.

Returns:

HTTP channel as response writer. Usually for chunked response.

responseWriter

@Nonnull
public PrintWriter responseWriter(@Nonnull
                                           MediaType contentType,
                                           @Nullable
                                           Charset charset)

Description copied from interface: Context

HTTP response channel as response writer.

Specified by:

responseWriter in interface Context

Overrides:

responseWriter in class ForwardingContext

Parameters:

contentType - Content type.

charset - Charset.

Returns:

HTTP channel as response writer. Usually for chunked response.

responseSender

@Nonnull
public Sender responseSender()

Description copied from interface: Context

HTTP response channel as chunker.

Specified by:

responseSender in interface Context

Overrides:

responseSender in class ForwardingContext

Returns:

HTTP channel as chunker. Usually for chunked response.

removeResponseHeader

@Nonnull
public Context removeResponseHeader(@Nonnull
                                             String name)

Description copied from interface: Context

Remove a response header.

Specified by:

removeResponseHeader in interface Context

Overrides:

removeResponseHeader in class ForwardingContext

Parameters:

name - Header's name.

Returns:

This context.

setResponseCookie

@Nonnull
public Context setResponseCookie(@Nonnull
                                          Cookie cookie)

Description copied from interface: Context

Set/add a cookie to response.

Specified by:

setResponseCookie in interface Context

Overrides:

setResponseCookie in class ForwardingContext

Parameters:

cookie - Cookie to add.

Returns:

This context.

setResponseHeader

@Nonnull
public Context setResponseHeader(@Nonnull
                                          String name,
                                          @Nonnull
                                          Date value)

Description copied from interface: Context

Set response header.

Specified by:

setResponseHeader in interface Context

Overrides:

setResponseHeader in class ForwardingContext

Parameters:

name - Header name.

value - Header value.

Returns:

This context.

setResponseCode

@Nonnull
public Context setResponseCode(int statusCode)

Description copied from interface: Context

Set response status code.

Specified by:

setResponseCode in interface Context

Overrides:

setResponseCode in class ForwardingContext

Parameters:

statusCode - Status code.

Returns:

This context.

setResponseCode

@Nonnull
public Context setResponseCode(@Nonnull
                                        StatusCode statusCode)

Description copied from interface: Context

Set response status code.

Specified by:

setResponseCode in interface Context

Overrides:

setResponseCode in class ForwardingContext

Parameters:

statusCode - Status code.

Returns:

This context.

setResponseHeader

@Nonnull
public Context setResponseHeader(@Nonnull
                                          String name,
                                          @Nonnull
                                          Object value)

Description copied from interface: Context

Set response header.

Specified by:

setResponseHeader in interface Context

Overrides:

setResponseHeader in class ForwardingContext

Parameters:

name - Header name.

value - Header value.

Returns:

This context.

setResponseHeader

@Nonnull
public Context setResponseHeader(@Nonnull
                                          String name,
                                          @Nonnull
                                          String value)

Description copied from interface: Context

Set response header.

Specified by:

setResponseHeader in interface Context

Overrides:

setResponseHeader in class ForwardingContext

Parameters:

name - Header name.

value - Header value.

Returns:

This context.

setResponseHeader

@Nonnull
public Context setResponseHeader(@Nonnull
                                          String name,
                                          @Nonnull
                                          Instant value)

Description copied from interface: Context

Set response header.

Specified by:

setResponseHeader in interface Context

Overrides:

setResponseHeader in class ForwardingContext

Parameters:

name - Header name.

value - Header value.

Returns:

This context.

setResponseLength

@Nonnull
public Context setResponseLength(long length)

Description copied from interface: Context

Set response content length header.

Specified by:

setResponseLength in interface Context

Overrides:

setResponseLength in class ForwardingContext

Parameters:

length - Response length.

Returns:

This context.

setResponseType

@Nonnull
public Context setResponseType(@Nonnull
                                        String contentType)

Description copied from interface: Context

Set response content type header.

Specified by:

setResponseType in interface Context

Overrides:

setResponseType in class ForwardingContext

Parameters:

contentType - Content type.

Returns:

This context.

setResponseType

@Nonnull
public Context setResponseType(@Nonnull
                                        MediaType contentType)

Description copied from interface: Context

Set response content type header.

Specified by:

setResponseType in interface Context

Overrides:

setResponseType in class ForwardingContext

Parameters:

contentType - Content type.

Returns:

This context.

setResponseType

@Nonnull
public Context setResponseType(@Nonnull
                                        MediaType contentType,
                                        @Nullable
                                        Charset charset)

Description copied from interface: Context

Set response content type header.

Specified by:

setResponseType in interface Context

Overrides:

setResponseType in class ForwardingContext

Parameters:

contentType - Content type.

charset - Charset.

Returns:

This context.

setDefaultResponseType

@Nonnull
public Context setDefaultResponseType(@Nonnull
                                               MediaType contentType)

Description copied from interface: Context

Set the default response content type header. It is used if the response content type header was not set yet.

Specified by:

setDefaultResponseType in interface Context

Overrides:

setDefaultResponseType in class ForwardingContext

Parameters:

contentType - Content type.

Returns:

This context.