Class DirectHandler.TransportResponse.Builder

java.lang.Object

io.helidon.http.DirectHandler.TransportResponse.Builder

All Implemented Interfaces:

Builder<DirectHandler.TransportResponse.Builder, DirectHandler.TransportResponse>, Supplier<DirectHandler.TransportResponse>

Enclosing class:

DirectHandler.TransportResponse

public static class DirectHandler.TransportResponse.Builder
extends Object
implements Builder<DirectHandler.TransportResponse.Builder, DirectHandler.TransportResponse>

Fluent API builder for DirectHandler.TransportResponse.

Method Summary

Modifier and Type	Method	Description
DirectHandler.TransportResponse	build()	Build the instance from this builder.
DirectHandler.TransportResponse.Builder	entity(byte[] entity)	Custom entity.
DirectHandler.TransportResponse.Builder	entity(String entity)	Custom entity.
DirectHandler.TransportResponse.Builder	header(Header header)	Set a header (if exists, it would be replaced).
DirectHandler.TransportResponse.Builder	header(HeaderName name, String... values)	Set a header (if exists, it would be replaced).
DirectHandler.TransportResponse.Builder	headers(ServerResponseHeaders headers)	Set headers.
DirectHandler.TransportResponse.Builder	keepAlive(boolean keepAlive)	Configure keep alive.
DirectHandler.TransportResponse.Builder	status(Status status)	Custom status.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default DirectHandler.TransportResponse	get()
default DirectHandler.TransportResponse.Builder	identity()	Instance of this builder as the correct type.
default DirectHandler.TransportResponse.Builder	update(Consumer<DirectHandler.TransportResponse.Builder> consumer)	Update the builder in a fluent API way.

Method Details

build

public DirectHandler.TransportResponse build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<DirectHandler.TransportResponse.Builder, DirectHandler.TransportResponse>

Returns:

instance of the built type

status

public DirectHandler.TransportResponse.Builder status(Status status)

Custom status.

Parameters:

status - status to use, default is bad request

Returns:

updated builder

headers

public DirectHandler.TransportResponse.Builder headers(ServerResponseHeaders headers)

Set headers. The transport may replace or remove Content-Length to match the final response representation and status.

Parameters:

headers - headers to use

Returns:

updated builder

header

public DirectHandler.TransportResponse.Builder header(HeaderName name,
 String... values)

Set a header (if exists, it would be replaced). Keep alive header is ignored, please use keepAlive(boolean). The transport may replace or remove Content-Length to match the final response representation and status.

Parameters:

name - name of the header

values - value of the header

Returns:

updated builder

header

public DirectHandler.TransportResponse.Builder header(Header header)

Set a header (if exists, it would be replaced). Keep alive header is ignored, please use keepAlive(boolean). The transport may replace or remove Content-Length to match the final response representation and status.

Parameters:

header - header value

Returns:

updated builder

keepAlive

public DirectHandler.TransportResponse.Builder keepAlive(boolean keepAlive)

Configure keep alive.

Parameters:

keepAlive - whether to keep alive

Returns:

updated builder

entity

public DirectHandler.TransportResponse.Builder entity(String entity)

Custom entity. Uses the content, reads it as UTF-8, configures an initial Content-Length header for a non-empty entity, and configures Content-Type header to text/plain. The transport determines the final content length.

Use entity(byte[]) for custom encoding.

Note that this method does not do any escaping (such as HTML encoding), make sure the entity is safe.

Parameters:

entity - response entity

Returns:

updated builder

entity

public DirectHandler.TransportResponse.Builder entity(byte[] entity)

Custom entity. Uses the content and configures an initial Content-Length header for a non-empty entity. The transport determines the final content length.

Use entity(String) for simple text messages.

Parameters:

entity - response entity

Returns:

updated builder