Module org.refcodes.web

Package org.refcodes.web

Interface HttpClientContext.HttpClientContextBuilder

All Superinterfaces:

BaseUrlAccessor, BaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>, BaseUrlAccessor.BaseUrlMutator, BaseUrlAccessor.BaseUrlProperty, org.refcodes.security.TrustStoreDescriptorAccessor, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<HttpClientContext.HttpClientContextBuilder>, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty

All Known Implementing Classes:

HttpClientContextBuilderImpl

Enclosing interface:

HttpClientContext

public static interface HttpClientContext.HttpClientContextBuilder
extends BaseUrlAccessor.BaseUrlProperty, BaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<HttpClientContext.HttpClientContextBuilder>

The HttpClientContext.HttpClientContextBuilder interface extends the HttpClientContext with builder functionality as of the builder pattern.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.web.BaseUrlAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.security.TrustStoreDescriptorAccessor

org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B extends org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<B>>, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator, org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty

Method Summary

Modifier and Type	Method	Description
default HttpClientContext.HttpClientContextBuilder	withBaseUrl(String aBaseUrl)	Same as BaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given String.
default HttpClientContext.HttpClientContextBuilder	withBaseUrl(String aProtocol, String aHost)	Same as BaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.
default HttpClientContext.HttpClientContextBuilder	withBaseUrl(String aProtocol, String aHost, int aPort)	Builder method for BaseUrlAccessor.BaseUrlMutator.setBaseUrl(String, String, int).
default HttpClientContext.HttpClientContextBuilder	withBaseUrl(String aProtocol, String aHost, int aPort, String aPath)	Builder method for BaseUrlAccessor.BaseUrlMutator.setBaseUrl(String, String, int, String).
default HttpClientContext.HttpClientContextBuilder	withBaseUrl(String aProtocol, String aHost, String aPath)	Same as BaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.
default HttpClientContext.HttpClientContextBuilder	withBaseUrl(URL aBaseURL)	Sets the base URL (protocol, host, port, path) for the base URL (protocol, host, port, path) property.
default HttpClientContext.HttpClientContextBuilder	withBaseUrl(org.refcodes.data.Scheme aScheme, String aHost)	Same as BaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.
default HttpClientContext.HttpClientContextBuilder	withBaseUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort)	Builder method for BaseUrlAccessor.BaseUrlMutator.setBaseUrl(Scheme, String, int).
default HttpClientContext.HttpClientContextBuilder	withBaseUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort, String aPath)	Builder method for BaseUrlAccessor.BaseUrlMutator.setBaseUrl(Scheme, String, int, String).
default HttpClientContext.HttpClientContextBuilder	withBaseUrl(org.refcodes.data.Scheme aScheme, String aHost, String aPath)	Same as BaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.
default HttpClientContext.HttpClientContextBuilder	withBaseUrl(Url aBaseUrl)	Sets the base Url (protocol, host, port, path) for the base URL (protocol, host, port, path) property.
default HttpClientContext.HttpClientContextBuilder	withTrustStoreDescriptor(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)

Methods inherited from interface org.refcodes.web.BaseUrlAccessor

getBaseUrl

Methods inherited from interface org.refcodes.web.BaseUrlAccessor.BaseUrlMutator

setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl

Methods inherited from interface org.refcodes.web.BaseUrlAccessor.BaseUrlProperty

letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl, letBaseUrl

Methods inherited from interface org.refcodes.security.TrustStoreDescriptorAccessor

getTrustStoreDescriptor

Methods inherited from interface org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorMutator

setTrustStoreDescriptor

Methods inherited from interface org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorProperty

letTrustStoreDescriptor

Method Details

withBaseUrl

default HttpClientContext.HttpClientContextBuilder withBaseUrl(Url aBaseUrl)

Sets the base Url (protocol, host, port, path) for the base URL (protocol, host, port, path) property.

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>

Parameters:

aBaseUrl - The base URL (protocol, host, port, path) to be stored by the local address property.

Returns:

The builder for applying multiple build operations.

withBaseUrl

default HttpClientContext.HttpClientContextBuilder withBaseUrl(URL aBaseURL)

Sets the base URL (protocol, host, port, path) for the base URL (protocol, host, port, path) property.

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>

Parameters:

aBaseURL - The base URL (protocol, host, port, path) to be stored by the local address property.

Returns:

The builder for applying multiple build operations.

withBaseUrl

default HttpClientContext.HttpClientContextBuilder withBaseUrl(String aBaseUrl)
                                                        throws MalformedURLException

Same as BaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given String.

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>

Parameters:

aBaseUrl - The String representing the URL.

Returns:

The builder for applying multiple build operations.

Throws:

MalformedURLException - in case the String cannot be converted to a valid (accepted) URL.

withBaseUrl

default HttpClientContext.HttpClientContextBuilder withBaseUrl(String aProtocol,
String aHost)
                                                        throws MalformedURLException

Same as BaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>

Parameters:

aProtocol - The protocol (e.g. HTTP or HTTPS) to be used for the base URL.

aHost - The host to which the base URL is to point to.

Returns:

The builder for applying multiple build operations.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.

withBaseUrl

default HttpClientContext.HttpClientContextBuilder withBaseUrl(org.refcodes.data.Scheme aScheme,
String aHost)
                                                        throws MalformedURLException

Same as BaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>

Parameters:

aScheme - The Scheme (e.g. Scheme.HTTP or Scheme.HTTPS) to be used for the base URL.

aHost - The host to which the base URL is to point to.

Returns:

The builder for applying multiple build operations.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.

withBaseUrl

default HttpClientContext.HttpClientContextBuilder withBaseUrl(String aProtocol,
String aHost,
String aPath)
                                                        throws MalformedURLException

Same as BaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>

Parameters:

aProtocol - The protocol (e.g. HTTP or HTTPS) to be used for the base URL.

aHost - The host to which the base URL is to point to.

aPath - The path on the host to which the base URL is to point to.

Returns:

The builder for applying multiple build operations.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.

withBaseUrl

default HttpClientContext.HttpClientContextBuilder withBaseUrl(org.refcodes.data.Scheme aScheme,
String aHost,
String aPath)
                                                        throws MalformedURLException

Same as BaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>

Parameters:

aScheme - The Scheme (e.g. Scheme.HTTP or Scheme.HTTPS) to be used for the base URL.

aHost - The host to which the base URL is to point to.

aPath - The path on the host to which the base URL is to point to.

Returns:

The builder for applying multiple build operations.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.

withBaseUrl

default HttpClientContext.HttpClientContextBuilder withBaseUrl(String aProtocol,
String aHost,
int aPort)
                                                        throws MalformedURLException

Builder method for BaseUrlAccessor.BaseUrlMutator.setBaseUrl(String, String, int).

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>

Parameters:

aProtocol - The protocol (e.g. HTTP or HTTPS) to be used for the base URL.

aHost - The host to which the base URL is to point to.

aPort - The port to be used when connecting to the host.

Returns:

The builder for applying multiple build operations.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.

withBaseUrl

default HttpClientContext.HttpClientContextBuilder withBaseUrl(org.refcodes.data.Scheme aScheme,
String aHost,
int aPort)
                                                        throws MalformedURLException

Builder method for BaseUrlAccessor.BaseUrlMutator.setBaseUrl(Scheme, String, int).

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>

Parameters:

aScheme - The Scheme (e.g. Scheme.HTTP or Scheme.HTTPS) to be used for the base URL.

aHost - The host to which the base URL is to point to.

aPort - The port to be used when connecting to the host.

Returns:

The builder for applying multiple build operations.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.

withBaseUrl

default HttpClientContext.HttpClientContextBuilder withBaseUrl(String aProtocol,
String aHost,
int aPort,
String aPath)
                                                        throws MalformedURLException

Builder method for BaseUrlAccessor.BaseUrlMutator.setBaseUrl(String, String, int, String).

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>

Parameters:

aProtocol - The protocol (e.g. HTTP or HTTPS) to be used for the base URL.

aHost - The host to which the base URL is to point to.

aPort - The port to be used when connecting to the host.

aPath - The path on the host to which the base URL is to point to.

Returns:

The builder for applying multiple build operations.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.

withBaseUrl

default HttpClientContext.HttpClientContextBuilder withBaseUrl(org.refcodes.data.Scheme aScheme,
String aHost,
int aPort,
String aPath)
                                                        throws MalformedURLException

Builder method for BaseUrlAccessor.BaseUrlMutator.setBaseUrl(Scheme, String, int, String).

Specified by:

withBaseUrl in interface BaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>

Parameters:

aScheme - The Scheme (e.g. Scheme.HTTP or Scheme.HTTPS) to be used for the base URL.

aHost - The host to which the base URL is to point to.

aPort - The port to be used when connecting to the host.

aPath - The path on the host to which the base URL is to point to.

Returns:

The builder for applying multiple build operations.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.

withTrustStoreDescriptor

default HttpClientContext.HttpClientContextBuilder withTrustStoreDescriptor(org.refcodes.security.TrustStoreDescriptor aStoreDescriptor)

Specified by:

withTrustStoreDescriptor in interface org.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<HttpClientContext.HttpClientContextBuilder>