io.knotx.configuration

Class CustomHttpHeader

java.lang.Object

io.knotx.configuration.CustomHttpHeader

public class CustomHttpHeader
extends Object

Describes a custom header

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getName()
String	getValue()
CustomHttpHeader	setName(String name) Set the name of the request header.
CustomHttpHeader	setValue(String value) Set the 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

CustomHttpHeader

public CustomHttpHeader()

Default Constructor

CustomHttpHeader

public CustomHttpHeader(CustomHttpHeader other)

Default copy constructor

Parameters:

other - the customHeader configuration to copy

CustomHttpHeader

public CustomHttpHeader(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 CustomHttpHeader setName(String name)

Set the 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 CustomHttpHeader setValue(String value)

Set the 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 String getName()

Returns:

a request header name

getValue

public String getValue()

Returns:

a request header value