Package com.linecorp.armeria.common

Class HttpResponseBuilder

java.lang.Object

com.linecorp.armeria.common.AbstractHttpMessageBuilder

com.linecorp.armeria.common.HttpResponseBuilder

All Implemented Interfaces:

HttpMessageSetters

@UnstableApi
public final class HttpResponseBuilder
extends AbstractHttpMessageBuilder

Builds a new HttpResponse.

Method Summary

Modifier and Type	Method	Description
HttpResponseBuilder	badGateway()	Sets 502 Bad Gateway to the status of this response.
HttpResponseBuilder	badRequest()	Sets 400 Bad Request to the status of this response.
HttpResponse	build()	Builds the response.
HttpResponseBuilder	content(MediaType contentType, byte[] content)	Sets the content for this response.
HttpResponseBuilder	content(MediaType contentType, HttpData content)	Sets the content for this response.
HttpResponseBuilder	content(MediaType contentType, CharSequence content)	Sets the content for this response.
HttpResponseBuilder	content(MediaType contentType, String content)	Sets the content for this response.
HttpResponseBuilder	content(MediaType contentType, String format, Object... content)	Sets the content for this response.
HttpResponseBuilder	content(MediaType contentType, org.reactivestreams.Publisher<? extends HttpData> content)	Sets the Publisher for this response.
HttpResponseBuilder	content(String content)	Sets the content as UTF-8 for this response.
HttpResponseBuilder	content(String format, Object... content)	Sets the content as UTF-8 for this response.
HttpResponseBuilder	content(org.reactivestreams.Publisher<? extends HttpData> content)	Sets the Publisher for this response.
HttpResponseBuilder	contentJson(Object content)	Sets the content for this response.
HttpResponseBuilder	cookie(Cookie cookie)	Sets a cookie for this response.
HttpResponseBuilder	cookies(Iterable<? extends Cookie> cookies)	Sets multiple cookies for this response.
HttpResponseBuilder	created()	Sets 201 Created to the status of this response.
HttpResponseBuilder	forbidden()	Sets 403 Forbidden to the status of this response.
HttpResponseBuilder	header(CharSequence name, Object value)	Adds a header to this response.
HttpResponseBuilder	headers(Iterable<? extends Map.Entry<? extends CharSequence,String>> headers)	Adds multiple headers to this response.
HttpResponseBuilder	internalServerError()	Sets 500 Internal Server Error to the status of this response.
HttpResponseBuilder	movedPermanently()	Sets 301 Moved Permanently to the status of this response.
HttpResponseBuilder	notFound()	Sets 404 Not Found to the status of this response.
HttpResponseBuilder	ok()	Sets 200 OK to the status of this response.
HttpResponseBuilder	status(int statusCode)	Sets the status for this response.
HttpResponseBuilder	status(HttpStatus status)	Sets the status for this response.
HttpResponseBuilder	trailer(CharSequence name, Object value)	Adds an HTTP trailer for this message.
HttpResponseBuilder	trailers(Iterable<? extends Map.Entry<? extends CharSequence,String>> trailers)	Adds HTTP trailers to this response.
HttpResponseBuilder	unauthorized()	Sets 401 Unauthorized to the status of this response.

Methods inherited from class com.linecorp.armeria.common.AbstractHttpMessageBuilder

publisher

Methods inherited from class java.lang.Object

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

Method Details

status

public HttpResponseBuilder status(int statusCode)

Sets the status for this response.

status

public HttpResponseBuilder status(HttpStatus status)

Sets the status for this response.

ok

public HttpResponseBuilder ok()

Sets 200 OK to the status of this response.

created

public HttpResponseBuilder created()

Sets 201 Created to the status of this response.

movedPermanently

public HttpResponseBuilder movedPermanently()

Sets 301 Moved Permanently to the status of this response.

badRequest

public HttpResponseBuilder badRequest()

Sets 400 Bad Request to the status of this response.

unauthorized

public HttpResponseBuilder unauthorized()

Sets 401 Unauthorized to the status of this response.

forbidden

public HttpResponseBuilder forbidden()

Sets 403 Forbidden to the status of this response.

notFound

public HttpResponseBuilder notFound()

Sets 404 Not Found to the status of this response.

internalServerError

public HttpResponseBuilder internalServerError()

Sets 500 Internal Server Error to the status of this response.

badGateway

public HttpResponseBuilder badGateway()

Sets 502 Bad Gateway to the status of this response.

content

public HttpResponseBuilder content(String content)

Sets the content as UTF-8 for this response.

Specified by:

content in interface HttpMessageSetters

Overrides:

content in class AbstractHttpMessageBuilder

content

public HttpResponseBuilder content(MediaType contentType,
 CharSequence content)

Sets the content for this response.

Specified by:

content in interface HttpMessageSetters

Overrides:

content in class AbstractHttpMessageBuilder

content

public HttpResponseBuilder content(MediaType contentType,
 String content)

Sets the content for this response.

Specified by:

content in interface HttpMessageSetters

Overrides:

content in class AbstractHttpMessageBuilder

content

@FormatMethod
public HttpResponseBuilder content(@FormatString
 String format,
 Object... content)

Sets the content as UTF-8 for this response. The content is formatted by String.format(Locale, String, Object...) with English locale.

Specified by:

content in interface HttpMessageSetters

Overrides:

content in class AbstractHttpMessageBuilder

content

@FormatMethod
public HttpResponseBuilder content(MediaType contentType,
 @FormatString
 String format,
 Object... content)

Sets the content for this response. The content is formatted by String.format(Locale, String, Object...) with English locale.

Specified by:

content in interface HttpMessageSetters

Overrides:

content in class AbstractHttpMessageBuilder

content

public HttpResponseBuilder content(MediaType contentType,
 byte[] content)

Sets the content for this response. The content will be wrapped using HttpData.wrap(byte[]), so any changes made to content will be reflected in the response.

Specified by:

content in interface HttpMessageSetters

Overrides:

content in class AbstractHttpMessageBuilder

content

public HttpResponseBuilder content(MediaType contentType,
 HttpData content)

Sets the content for this response.

Specified by:

content in interface HttpMessageSetters

Overrides:

content in class AbstractHttpMessageBuilder

content

public HttpResponseBuilder content(org.reactivestreams.Publisher<? extends HttpData> content)

Sets the Publisher for this response.

Specified by:

content in interface HttpMessageSetters

Overrides:

content in class AbstractHttpMessageBuilder

content

public HttpResponseBuilder content(MediaType contentType,
 org.reactivestreams.Publisher<? extends HttpData> content)

Sets the Publisher for this response.

Specified by:

content in interface HttpMessageSetters

Overrides:

content in class AbstractHttpMessageBuilder

contentJson

public HttpResponseBuilder contentJson(Object content)

Sets the content for this response. The content is converted into JSON format using the default ObjectMapper.

Specified by:

contentJson in interface HttpMessageSetters

Overrides:

contentJson in class AbstractHttpMessageBuilder

header

public HttpResponseBuilder header(CharSequence name,
 Object value)

Adds a header to this response. For example:

 HttpResponse.builder()
             .ok()
             .content("Hello, Armeria")
             .header("Server", "foo")
             .build();
 

Specified by:

header in interface HttpMessageSetters

Overrides:

header in class AbstractHttpMessageBuilder

headers

public HttpResponseBuilder headers(Iterable<? extends Map.Entry<? extends CharSequence,String>> headers)

Adds multiple headers to this response. For example:

 HttpResponse.builder()
             .ok()
             .content("Hello, Armeria")
             .headers(HttpHeaders.of("x-test-header", "foo", "Server", "baz"))
             .build();
 

Specified by:

headers in interface HttpMessageSetters

Overrides:

headers in class AbstractHttpMessageBuilder

See Also:

• HttpHeaders

trailer

public HttpResponseBuilder trailer(CharSequence name,
 Object value)

Description copied from interface: HttpMessageSetters

Adds an HTTP trailer for this message.

Specified by:

trailer in interface HttpMessageSetters

Overrides:

trailer in class AbstractHttpMessageBuilder

trailers

public HttpResponseBuilder trailers(Iterable<? extends Map.Entry<? extends CharSequence,String>> trailers)

Adds HTTP trailers to this response.

Specified by:

trailers in interface HttpMessageSetters

Overrides:

trailers in class AbstractHttpMessageBuilder

cookie

public HttpResponseBuilder cookie(Cookie cookie)

Sets a cookie for this response. For example:

 HttpResponse.builder()
             .ok()
             .cookie(Cookie.ofSecure("cookie", "foo"))
             .build();
 

See Also:

• Cookie

cookies

public HttpResponseBuilder cookies(Iterable<? extends Cookie> cookies)

Sets multiple cookies for this response.

 HttpResponse.builder()
             .ok()
             .cookies(Cookies.ofSecure(Cookie.ofSecure("cookie1", "foo"),
                                       Cookie.ofSecure("cookie2", "bar")))
             .build();
 

See Also:

• Cookies

build

public HttpResponse build()

Builds the response.