io.knotx.repository.http

Class HttpRepositoryOptions

java.lang.Object

io.knotx.repository.http.HttpRepositoryOptions

public class HttpRepositoryOptions
extends Object

Describes a configuration of Http Repository connector

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ADDRESS Default EB address of the HTTP repository

Constructor Summary

Constructors

Constructor and Description
HttpRepositoryOptions() Default constructor
HttpRepositoryOptions(HttpRepositoryOptions other) Copy constructor
HttpRepositoryOptions(io.vertx.core.json.JsonObject json) Create an settings from JSON

Method Summary

Modifier and Type	Method and Description
String	getAddress()
Set<String>	getAllowedRequestHeaders()
List<Pattern>	getAllowedRequestHeadersPatterns()
ClientDestination	getClientDestination()
io.vertx.core.http.HttpClientOptions	getClientOptions()
CustomHttpHeader	getCustomHttpHeader()
HttpRepositoryOptions	setAddress(String address) Set the EB address of the HTTP repository verticle
HttpRepositoryOptions	setAllowedRequestHeaderPatterns(List<Pattern> allowedRequestHeaderPatterns)
HttpRepositoryOptions	setAllowedRequestHeaders(Set<String> allowedRequestHeaders) Set the collection of patterns of allowed request headers.
HttpRepositoryOptions	setClientDestination(ClientDestination clientDestination) Set the remote location of the repository
HttpRepositoryOptions	setClientOptions(io.vertx.core.http.HttpClientOptions clientOptions) Set the HttpClientOptions used by the HTTP client to communicate with remote http repository
HttpRepositoryOptions	setCustomHttpHeader(CustomHttpHeader customHttpHeader) Set the header (name and value) to be sent in every request to the remote repository
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

Field Detail

DEFAULT_ADDRESS

public static final String DEFAULT_ADDRESS

Default EB address of the HTTP repository

See Also:

Constant Field Values

Constructor Detail

HttpRepositoryOptions

public HttpRepositoryOptions()

Default constructor

HttpRepositoryOptions

public HttpRepositoryOptions(HttpRepositoryOptions other)

Copy constructor

Parameters:

other - the instance to copy

HttpRepositoryOptions

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

Create an settings from JSON

Parameters:

json - the JSON

Method Detail

toJson

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

Convert to JSON

Returns:

the JSON

getAddress

public String getAddress()

Returns:

EB address of the HTTP repository verticle

setAddress

public HttpRepositoryOptions setAddress(String address)

Set the EB address of the HTTP repository verticle

Parameters:

address - an EB address of the verticle

Returns:

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

getClientOptions

public io.vertx.core.http.HttpClientOptions getClientOptions()

Returns:

HttpClientOptions

setClientOptions

public HttpRepositoryOptions setClientOptions(io.vertx.core.http.HttpClientOptions clientOptions)

Set the HttpClientOptions used by the HTTP client to communicate with remote http repository

Parameters:

clientOptions - HttpClientOptions object

Returns:

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

getClientDestination

public ClientDestination getClientDestination()

Returns:

ClientDestination

setClientDestination

public HttpRepositoryOptions setClientDestination(ClientDestination clientDestination)

Set the remote location of the repository

Parameters:

clientDestination - a ClientDestination object

Returns:

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

getAllowedRequestHeaders

public Set<String> getAllowedRequestHeaders()

Returns:

Set of allowed headers patterns

setAllowedRequestHeaders

public HttpRepositoryOptions setAllowedRequestHeaders(Set<String> allowedRequestHeaders)

Set the collection of patterns of allowed request headers. Only headers matching any of the pattern from the set will be sent to the HTTP repository

Parameters:

allowedRequestHeaders - a Set of patterns of allowed request headers

Returns:

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

getCustomHttpHeader

public CustomHttpHeader getCustomHttpHeader()

Returns:

a Custom Header to be sent in every request to the remote repository

setCustomHttpHeader

public HttpRepositoryOptions setCustomHttpHeader(CustomHttpHeader customHttpHeader)

Set the header (name and value) to be sent in every request to the remote repository

Parameters:

customHttpHeader - the header name and value

Returns:

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

getAllowedRequestHeadersPatterns

public List<Pattern> getAllowedRequestHeadersPatterns()

setAllowedRequestHeaderPatterns

public HttpRepositoryOptions setAllowedRequestHeaderPatterns(List<Pattern> allowedRequestHeaderPatterns)