io.jooby.internal

Class WebSocketSender

java.lang.Object

io.jooby.ForwardingContext

io.jooby.internal.WebSocketSender

All Implemented Interfaces:

Context, DefaultContext, Registry

public class WebSocketSender
extends ForwardingContext
implements DefaultContext

Field Summary

Fields inherited from interface io.jooby.Context

ACCEPT, GMT, PORT, RFC1123, RFC1123_PATTERN, SECURE_PORT

Constructor Summary

Constructors

Constructor and Description
WebSocketSender(Context context, WebSocket ws)

Method Summary

Modifier and Type	Method and Description
Context	render(Object value) Render a value and send the response to client.
Context	send(byte[] data) Send response data.
Context	send(String data, Charset charset) Send response data.
Context	setDefaultResponseType(MediaType contentType) Set the default response content type header.
Context	setResetHeadersOnError(boolean value) Set whenever reset/clear headers on application error.
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, forward, getAttributes, getHost, getHostAndPort, getMethod, getPort, getProtocol, getRemoteAddress, getRequestLength, getRequestPath, getRequestType, getRequestType, getRequestURL, getRequestURL, getResetHeadersOnError, getResponseCode, getResponseHeader, getResponseLength, getResponseType, getRoute, getRouter, getScheme, getServerHost, getServerPort, getUser, header, header, headerMap, headerMultimap, isInIoThread, isResponseStarted, isSecure, matches, multipart, multipart, multipart, multipartMap, multipartMultimap, onComplete, path, path, path, pathMap, query, query, query, queryMap, queryMultimap, queryString, removeResponseHeader, removeResponseHeaders, require, require, require, responseSender, responseStream, responseStream, responseStream, responseStream, responseWriter, responseWriter, responseWriter, responseWriter, responseWriter, responseWriter, send, send, send, send, send, send, send, send, send, send, sendError, sendError, sendRedirect, sendRedirect, session, session, sessionOrNull, setHost, setMethod, setPathMap, setPort, setRemoteAddress, setRequestPath, setRoute, setScheme, setUser, toString, upgrade, upgrade

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jooby.DefaultContext

accept, accept, attribute, attribute, body, body, convert, cookie, decode, decoder, file, files, files, flash, flash, form, form, formMap, formMultimap, forward, getHost, getHostAndPort, getPort, getRequestLength, getRequestType, getRequestType, getRequestURL, getRequestURL, getServerHost, getServerPort, getUser, header, headerMap, headerMultimap, isSecure, matches, multipart, multipart, multipartMap, multipartMultimap, path, path, path, query, query, queryMap, queryMultimap, queryString, require, require, require, responseStream, responseStream, responseStream, responseWriter, responseWriter, responseWriter, responseWriter, responseWriter, send, send, send, send, sendError, sendError, sendRedirect, sendRedirect, session, session, sessionOrNull, setUser

Methods inherited from interface io.jooby.Context

body, cookieMap, detach, dispatch, dispatch, form, getAttributes, getContextPath, getMethod, getProtocol, getRemoteAddress, getRequestPath, getResetHeadersOnError, getResponseCode, getResponseHeader, getResponseLength, getResponseType, getRoute, getRouter, getScheme, header, isInIoThread, isResponseStarted, multipart, onComplete, pathMap, query, readOnly, removeResponseHeader, removeResponseHeaders, responseSender, responseStream, responseWriter, send, send, send, send, send, send, setHost, setMethod, setPathMap, setPort, setRemoteAddress, setRequestPath, setRoute, setScheme, upgrade, upgrade, websocket

Constructor Detail

WebSocketSender

public WebSocketSender(@Nonnull
                       Context context,
                       @Nonnull
                       WebSocket ws)

Method Detail

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.

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.

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

Specified by:

render in interface DefaultContext

Overrides:

render in class ForwardingContext

Parameters:

value - Object value.

Returns:

This context.

setResetHeadersOnError

public Context setResetHeadersOnError(boolean value)

Description copied from interface: Context

Set whenever reset/clear headers on application error.

Specified by:

setResetHeadersOnError in interface Context

Overrides:

setResetHeadersOnError in class ForwardingContext

Parameters:

value - True for reset/clear headers.

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.

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

Specified by:

setResponseCode in interface DefaultContext

Overrides:

setResponseCode in class ForwardingContext

Parameters:

statusCode - Status code.

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
                                          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
                                          Date value)

Description copied from interface: Context

Set response header.

Specified by:

setResponseHeader in interface Context

Specified by:

setResponseHeader in interface DefaultContext

Overrides:

setResponseHeader in class ForwardingContext

Parameters:

name - Header name.

value - Header value.

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

Specified by:

setResponseHeader in interface DefaultContext

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

Specified by:

setResponseHeader in interface DefaultContext

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,
                                        @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.

setResponseType

@Nonnull
public Context setResponseType(@Nonnull
                                        MediaType contentType)

Description copied from interface: Context

Set response content type header.

Specified by:

setResponseType in interface Context

Specified by:

setResponseType in interface DefaultContext

Overrides:

setResponseType in class ForwardingContext

Parameters:

contentType - Content type.

Returns:

This context.