io.micronaut.servlet.engine

Class DefaultServletHttpResponse<B>

java.lang.Object

io.micronaut.servlet.engine.DefaultServletHttpResponse<B>

Type Parameters:

B - The body type

All Implemented Interfaces:

io.micronaut.core.attr.AttributeHolder, io.micronaut.core.attr.MutableAttributeHolder, io.micronaut.http.HttpMessage<B>, io.micronaut.http.HttpResponse<B>, io.micronaut.http.MutableHttpMessage<B>, io.micronaut.http.MutableHttpResponse<B>, ServletHttpResponse<javax.servlet.http.HttpServletResponse,B>

@Internal
public class DefaultServletHttpResponse<B>
extends java.lang.Object
implements ServletHttpResponse<javax.servlet.http.HttpServletResponse,B>

Implementation of ServletHttpResponse for the Servlet API.

Since:

1.0.0

Author:

graemerocher

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultServletHttpResponse(DefaultServletHttpRequest request, javax.servlet.http.HttpServletResponse delegate) Default constructor.

Method Summary

Modifier and Type	Method and Description
<T> io.micronaut.http.MutableHttpResponse<T>	body(T body)
io.micronaut.http.MutableHttpResponse<B>	contentLength(long length)
io.micronaut.http.MutableHttpResponse<B>	contentType(java.lang.CharSequence contentType)
io.micronaut.http.MutableHttpResponse<B>	contentType(io.micronaut.http.MediaType mediaType)
io.micronaut.http.MutableHttpResponse<B>	cookie(io.micronaut.http.cookie.Cookie cookie)
io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object>	getAttributes()
java.util.Optional<B>	getBody()
java.util.Optional<io.micronaut.http.MediaType>	getContentType()
io.micronaut.http.MutableHttpHeaders	getHeaders()
javax.servlet.http.HttpServletResponse	getNativeResponse()
java.io.OutputStream	getOutputStream() Returns an OutputStream that can be used to write the body of the response.
io.micronaut.http.HttpStatus	getStatus()
java.io.BufferedWriter	getWriter() Returns a BufferedWriter that can be used to write the text body of the response.
io.micronaut.http.MutableHttpResponse<B>	header(java.lang.CharSequence name, java.lang.CharSequence value)
io.micronaut.http.MutableHttpResponse<B>	locale(java.util.Locale locale)
io.micronaut.http.MutableHttpResponse<B>	status(io.micronaut.http.HttpStatus status)
io.micronaut.http.MutableHttpResponse<B>	status(io.micronaut.http.HttpStatus status, java.lang.CharSequence message)
io.micronaut.http.MutableHttpResponse<B>	status(int status)
io.micronaut.http.MutableHttpResponse<B>	status(int status, java.lang.CharSequence message)
org.reactivestreams.Publisher<io.micronaut.http.MutableHttpResponse<?>>	stream(org.reactivestreams.Publisher<?> dataPublisher) Streams data using the given data publisher.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.http.MutableHttpResponse

attribute, characterEncoding, characterEncoding, contentEncoding, cookies, headers, headers

Methods inherited from interface io.micronaut.http.HttpResponse

accepted, accepted, badRequest, badRequest, body, code, created, created, created, getCookie, getCookies, header, noContent, notAllowed, notAllowed, notAllowedGeneric, notFound, notFound, notModified, ok, ok, permanentRedirect, reason, redirect, seeOther, serverError, serverError, setAttribute, status, status, status, temporaryRedirect, unauthorized, unprocessableEntity, uri

Methods inherited from interface io.micronaut.http.MutableHttpMessage

basicAuth, bearerAuth

Methods inherited from interface io.micronaut.http.HttpMessage

getBody, getBody, getCharacterEncoding, getContentLength, getLocale

Methods inherited from interface io.micronaut.core.attr.MutableAttributeHolder

removeAttribute

Methods inherited from interface io.micronaut.core.attr.AttributeHolder

getAttribute, getAttribute

Constructor Detail

DefaultServletHttpResponse

protected DefaultServletHttpResponse(DefaultServletHttpRequest request,
                                     javax.servlet.http.HttpServletResponse delegate)

Default constructor.

Parameters:

request - The servlet request

delegate - The servlet response

Method Detail

stream

public org.reactivestreams.Publisher<io.micronaut.http.MutableHttpResponse<?>> stream(org.reactivestreams.Publisher<?> dataPublisher)

Description copied from interface: ServletHttpResponse

Streams data using the given data publisher.

Specified by:

stream in interface ServletHttpResponse<javax.servlet.http.HttpServletResponse,B>

Parameters:

dataPublisher - The data publisher

Returns:

Emits the response once the stream has completed

getContentType

@NonNull
public java.util.Optional<io.micronaut.http.MediaType> getContentType()

Specified by:

getContentType in interface io.micronaut.http.HttpMessage<B>

contentType

public io.micronaut.http.MutableHttpResponse<B> contentType(java.lang.CharSequence contentType)

Specified by:

contentType in interface io.micronaut.http.MutableHttpMessage<B>

Specified by:

contentType in interface io.micronaut.http.MutableHttpResponse<B>

contentType

public io.micronaut.http.MutableHttpResponse<B> contentType(io.micronaut.http.MediaType mediaType)

Specified by:

contentType in interface io.micronaut.http.MutableHttpMessage<B>

Specified by:

contentType in interface io.micronaut.http.MutableHttpResponse<B>

contentLength

public io.micronaut.http.MutableHttpResponse<B> contentLength(long length)

Specified by:

contentLength in interface io.micronaut.http.MutableHttpMessage<B>

Specified by:

contentLength in interface io.micronaut.http.MutableHttpResponse<B>

locale

public io.micronaut.http.MutableHttpResponse<B> locale(java.util.Locale locale)

Specified by:

locale in interface io.micronaut.http.MutableHttpResponse<B>

header

public io.micronaut.http.MutableHttpResponse<B> header(java.lang.CharSequence name,
                                                       java.lang.CharSequence value)

Specified by:

header in interface io.micronaut.http.MutableHttpMessage<B>

Specified by:

header in interface io.micronaut.http.MutableHttpResponse<B>

status

public io.micronaut.http.MutableHttpResponse<B> status(int status)

Specified by:

status in interface io.micronaut.http.MutableHttpResponse<B>

status

public io.micronaut.http.MutableHttpResponse<B> status(int status,
                                                       java.lang.CharSequence message)

Specified by:

status in interface io.micronaut.http.MutableHttpResponse<B>

status

public io.micronaut.http.MutableHttpResponse<B> status(io.micronaut.http.HttpStatus status)

Specified by:

status in interface io.micronaut.http.MutableHttpResponse<B>

getNativeResponse

public javax.servlet.http.HttpServletResponse getNativeResponse()

Specified by:

getNativeResponse in interface ServletHttpResponse<javax.servlet.http.HttpServletResponse,B>

Returns:

The native response type.

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Description copied from interface: ServletHttpResponse

Returns an OutputStream that can be used to write the body of the response. This method is typically used to write binary data. If the body is text, the ServletHttpResponse.getWriter() method is more appropriate.

Specified by:

getOutputStream in interface ServletHttpResponse<javax.servlet.http.HttpServletResponse,B>

Returns:

The output stream

Throws:

java.io.IOException - if a valid OutputStream cannot be returned for some reason.

getWriter

public java.io.BufferedWriter getWriter()
                                 throws java.io.IOException

Description copied from interface: ServletHttpResponse

Returns a BufferedWriter that can be used to write the text body of the response. If the written text will not be US-ASCII, you should specify a character encoding by calling MutableHttpResponse.contentEncoding(CharSequence) before calling this method.

Specified by:

getWriter in interface ServletHttpResponse<javax.servlet.http.HttpServletResponse,B>

Returns:

The writer

Throws:

java.io.IOException - if a valid BufferedWriter cannot be returned for some reason.

cookie

public io.micronaut.http.MutableHttpResponse<B> cookie(io.micronaut.http.cookie.Cookie cookie)

Specified by:

cookie in interface io.micronaut.http.MutableHttpResponse<B>

getHeaders

@NonNull
public io.micronaut.http.MutableHttpHeaders getHeaders()

Specified by:

getHeaders in interface io.micronaut.http.HttpMessage<B>

Specified by:

getHeaders in interface io.micronaut.http.MutableHttpMessage<B>

getAttributes

@NonNull
public io.micronaut.core.convert.value.MutableConvertibleValues<java.lang.Object> getAttributes()

Specified by:

getAttributes in interface io.micronaut.core.attr.AttributeHolder

Specified by:

getAttributes in interface io.micronaut.core.attr.MutableAttributeHolder

Specified by:

getAttributes in interface io.micronaut.http.HttpMessage<B>

getBody

@NonNull
public java.util.Optional<B> getBody()

Specified by:

getBody in interface io.micronaut.http.HttpMessage<B>

body

public <T> io.micronaut.http.MutableHttpResponse<T> body(@Nullable
                                                         T body)

Specified by:

body in interface io.micronaut.http.MutableHttpMessage<B>

Specified by:

body in interface io.micronaut.http.MutableHttpResponse<B>

status

public io.micronaut.http.MutableHttpResponse<B> status(io.micronaut.http.HttpStatus status,
                                                       java.lang.CharSequence message)

Specified by:

status in interface io.micronaut.http.MutableHttpResponse<B>

getStatus

public io.micronaut.http.HttpStatus getStatus()

Specified by:

getStatus in interface io.micronaut.http.HttpResponse<B>