Class HttpClientOptions

java.lang.Object

java.util.AbstractMap<String,Object>

java.util.HashMap<String,Object>

org.refcodes.ontology.Taxonomy

org.refcodes.runtime.Settings

org.refcodes.runtime.Options

org.refcodes.rest.HttpClientOptions

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, ExecutorServiceAccessor, Clearable, EmptyAccessor, Ontology, Diagnosable, Schemable<DiagnosticOptions>, TrustStoreDescriptorAccessor, Containable, ImmutableTable<String,Object>, ImmutableTable.MutableTable<String,Object>, Keys<String,Object>, Keys.MutableKeys<String,Object>, Keys.MutableValues<String,Object>, BaseUrlAccessor, HttpClientContext

public class HttpClientOptions
extends Options
implements HttpClientContext, ExecutorServiceAccessor

Typed Options implementation describing the configuration of an HTTP client.

The HttpClientOptions class combines:

• the semantic contract of HttpClientContext
• the flexibility of the Options infrastructure
• type-safe convenience accessors
• support for environment variables and system properties
• diagnostic schema generation

Supported configuration properties are declared by the HttpClientOntology.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpClientOptions.Builder	Builder for creating HttpClientOptions instances.

Nested classes/interfaces inherited from class Settings

Settings.Node, Settings.Properties, Settings.Root

Nested classes/interfaces inherited from class AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface BaseUrlAccessor

BaseUrlAccessor.BaseUrlBuilder<B>, BaseUrlAccessor.BaseUrlMutator, BaseUrlAccessor.BaseUrlProperty

Nested classes/interfaces inherited from interface EmptyAccessor

EmptyAccessor.EmptyBuilder<B>, EmptyAccessor.EmptyMutator, EmptyAccessor.EmptyProperty

Nested classes/interfaces inherited from interface ExecutorServiceAccessor

ExecutorServiceAccessor.ExecutorServiceBuilder<B>, ExecutorServiceAccessor.ExecutorServiceMutator, ExecutorServiceAccessor.ExecutorServiceProperty

Nested classes/interfaces inherited from interface ImmutableTable

ImmutableTable.MutableTable<K,V>

Nested classes/interfaces inherited from interface Keys

Keys.MutableKeys<K,V>, Keys.MutableValues<K,V>

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Nested classes/interfaces inherited from interface TrustStoreDescriptorAccessor

TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B>, TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty

Field Summary

Fields inherited from class Taxonomy

NAMESPACE_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
	HttpClientOptions()	Constructs an empty HttpClientOptions instance.
protected	HttpClientOptions(HttpClientOptions.Builder aBuilder)	Constructs a new instance from the given builder.

Method Summary

Modifier and Type	Method	Description
static HttpClientOptions.Builder	builder()	Creates a new HttpClientOptions.Builder.
Url	getBaseUrl()	Returns the configured base Url.
ExecutorService	getExecutorService()
TrustStoreDescriptor	getTrustStoreDescriptor()	Returns the configured TLS/SSL truststore descriptor.

Methods inherited from class Options

enrichSchema, get, getOption, put, register, toSchema

Methods inherited from class Settings

createResult, fromNamespace, merge, ofNamespace, removeNamespace, toSchema, toSchema, transformKeys, transformValues

Methods inherited from class Taxonomy

contains, containsNamespace, get, get, get, get, getOr, namespaces, put, put, remove, toKey, toNormalized

Methods inherited from class HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, getOrDefault, isEmpty, keySet, merge, newHashMap, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class AbstractMap

equals, hashCode, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Clearable

clear

Methods inherited from interface Containable

size

Methods inherited from interface EmptyAccessor

isEmpty

Methods inherited from interface ImmutableTable.MutableTable

delete, put

Methods inherited from interface Keys

containsKey, containsValue, getOr, keySet, values

Methods inherited from interface Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface Ontology

get, get, getOr, getOr, getOr

Constructor Details

HttpClientOptions

public HttpClientOptions()

Constructs an empty HttpClientOptions instance.

HttpClientOptions

protected HttpClientOptions(HttpClientOptions.Builder aBuilder)

Constructs a new instance from the given builder.

Parameters:

aBuilder - The builder from which to populate this instance.

Method Details

getBaseUrl

public Url getBaseUrl()

Returns the configured base Url.

Specified by:

getBaseUrl in interface BaseUrlAccessor

Returns:

The configured base Url or null.

getTrustStoreDescriptor

public TrustStoreDescriptor getTrustStoreDescriptor()

Returns the configured TLS/SSL truststore descriptor.

Specified by:

getTrustStoreDescriptor in interface TrustStoreDescriptorAccessor

Returns:

The configured truststore descriptor or null.

getExecutorService

public ExecutorService getExecutorService()

Specified by:

getExecutorService in interface ExecutorServiceAccessor

builder

public static HttpClientOptions.Builder builder()

Creates a new HttpClientOptions.Builder.

Returns:

A new builder instance.