io.knotx.server.handler.http.response.header

Class CustomHttpHeaderOptions

java.lang.Object

io.knotx.server.handler.http.response.header.CustomHttpHeaderOptions

public class CustomHttpHeaderOptions
extends java.lang.Object

Describes a custom header that is send with every HTTP response from the server

Constructor Summary

Constructors

Constructor and Description
CustomHttpHeaderOptions() Default Constructor
CustomHttpHeaderOptions(CustomHttpHeaderOptions other) Default copy constructor
CustomHttpHeaderOptions(io.vertx.core.json.JsonObject json) Creates from JSON

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
java.lang.String	getValue()
CustomHttpHeaderOptions	setName(java.lang.String name) Name of the request header.
CustomHttpHeaderOptions	setValue(java.lang.String value) Value of the request header.
io.vertx.core.json.JsonObject	toJson() Convert to JSON

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomHttpHeaderOptions

public CustomHttpHeaderOptions()

Default Constructor

CustomHttpHeaderOptions

public CustomHttpHeaderOptions(CustomHttpHeaderOptions other)

Default copy constructor

Parameters:

other - the customHeader configuration to copy

CustomHttpHeaderOptions

public CustomHttpHeaderOptions(io.vertx.core.json.JsonObject json)

Creates from JSON

Parameters:

json - the JSON

Method Detail

toJson

public io.vertx.core.json.JsonObject toJson()

Convert to JSON

Returns:

the JSON

setName

public CustomHttpHeaderOptions setName(java.lang.String name)

Name of the request header.

Parameters:

name - name of the custom header

Returns:

a reference to this, so the API can be used fluently

setValue

public CustomHttpHeaderOptions setValue(java.lang.String value)

Value of the request header.

Parameters:

value - value of the custom header

Returns:

a reference to this, so the API can be used fluently

getName

public java.lang.String getName()

Returns:

a request header name

getValue

public java.lang.String getValue()

Returns:

a request header value