Package org.refcodes.net
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>
TheHttpClientContext.HttpClientContextBuilder
interface extends theHttpClientContext
with builder functionality as of the builder pattern.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.refcodes.net.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
All Methods Instance Methods Default Methods Modifier and Type Method Description default HttpClientContext.HttpClientContextBuilder
withBaseUrl(java.lang.String aBaseUrl)
Same asBaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL)
except that aMalformedURLException
may occur when creating theURL
instance from the givenString
.default HttpClientContext.HttpClientContextBuilder
withBaseUrl(java.lang.String aProtocol, java.lang.String aHost)
Same asBaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL)
except that aMalformedURLException
may occur when creating theURL
instance from the given parameters.default HttpClientContext.HttpClientContextBuilder
withBaseUrl(java.lang.String aProtocol, java.lang.String aHost, int aPort)
Builder method forBaseUrlAccessor.BaseUrlMutator.setBaseUrl(String, String, int)
.default HttpClientContext.HttpClientContextBuilder
withBaseUrl(java.lang.String aProtocol, java.lang.String aHost, int aPort, java.lang.String aPath)
Builder method forBaseUrlAccessor.BaseUrlMutator.setBaseUrl(String, String, int, String)
.default HttpClientContext.HttpClientContextBuilder
withBaseUrl(java.lang.String aProtocol, java.lang.String aHost, java.lang.String aPath)
Same asBaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL)
except that aMalformedURLException
may occur when creating theURL
instance from the given parameters.default HttpClientContext.HttpClientContextBuilder
withBaseUrl(java.net.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, java.lang.String aHost)
Same asBaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL)
except that aMalformedURLException
may occur when creating theURL
instance from the given parameters.default HttpClientContext.HttpClientContextBuilder
withBaseUrl(org.refcodes.data.Scheme aScheme, java.lang.String aHost, int aPort)
Builder method forBaseUrlAccessor.BaseUrlMutator.setBaseUrl(Scheme, String, int)
.default HttpClientContext.HttpClientContextBuilder
withBaseUrl(org.refcodes.data.Scheme aScheme, java.lang.String aHost, int aPort, java.lang.String aPath)
Builder method forBaseUrlAccessor.BaseUrlMutator.setBaseUrl(Scheme, String, int, String)
.default HttpClientContext.HttpClientContextBuilder
withBaseUrl(org.refcodes.data.Scheme aScheme, java.lang.String aHost, java.lang.String aPath)
Same asBaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL)
except that aMalformedURLException
may occur when creating theURL
instance from the given parameters.default HttpClientContext.HttpClientContextBuilder
withBaseUrl(Url aBaseUrl)
Sets the baseUrl
(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.net.BaseUrlAccessor
getBaseUrl
-
Methods inherited from interface org.refcodes.net.BaseUrlAccessor.BaseUrlMutator
setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl
-
-
-
-
Method Detail
-
withBaseUrl
default HttpClientContext.HttpClientContextBuilder withBaseUrl(Url aBaseUrl)
Sets the baseUrl
(protocol, host, port, path) for the base URL (protocol, host, port, path) property.- Specified by:
withBaseUrl
in interfaceBaseUrlAccessor.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(java.net.URL aBaseURL)
Sets the base URL (protocol, host, port, path) for the base URL (protocol, host, port, path) property.- Specified by:
withBaseUrl
in interfaceBaseUrlAccessor.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(java.lang.String aBaseUrl) throws java.net.MalformedURLException
Same asBaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL)
except that aMalformedURLException
may occur when creating theURL
instance from the givenString
.- Specified by:
withBaseUrl
in interfaceBaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>
- Parameters:
aBaseUrl
- TheString
representing theURL
.- Returns:
- The builder for applying multiple build operations.
- Throws:
java.net.MalformedURLException
- in case theString
cannot be converted to a valid (accepted)URL
.
-
withBaseUrl
default HttpClientContext.HttpClientContextBuilder withBaseUrl(java.lang.String aProtocol, java.lang.String aHost) throws java.net.MalformedURLException
Same asBaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL)
except that aMalformedURLException
may occur when creating theURL
instance from the given parameters.- Specified by:
withBaseUrl
in interfaceBaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>
- Parameters:
aProtocol
- The protocol (e.g. HTTP or HTTPS) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.- Returns:
- The builder for applying multiple build operations.
- Throws:
java.net.MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
withBaseUrl
default HttpClientContext.HttpClientContextBuilder withBaseUrl(org.refcodes.data.Scheme aScheme, java.lang.String aHost) throws java.net.MalformedURLException
Same asBaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL)
except that aMalformedURLException
may occur when creating theURL
instance from the given parameters.- Specified by:
withBaseUrl
in interfaceBaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>
- Parameters:
aScheme
- TheScheme
(e.g.Scheme.HTTP
orScheme.HTTPS
) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.- Returns:
- The builder for applying multiple build operations.
- Throws:
java.net.MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
withBaseUrl
default HttpClientContext.HttpClientContextBuilder withBaseUrl(java.lang.String aProtocol, java.lang.String aHost, java.lang.String aPath) throws java.net.MalformedURLException
Same asBaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL)
except that aMalformedURLException
may occur when creating theURL
instance from the given parameters.- Specified by:
withBaseUrl
in interfaceBaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>
- Parameters:
aProtocol
- The protocol (e.g. HTTP or HTTPS) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.aPath
- The path on the host to which the baseURL
is to point to.- Returns:
- The builder for applying multiple build operations.
- Throws:
java.net.MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
withBaseUrl
default HttpClientContext.HttpClientContextBuilder withBaseUrl(org.refcodes.data.Scheme aScheme, java.lang.String aHost, java.lang.String aPath) throws java.net.MalformedURLException
Same asBaseUrlAccessor.BaseUrlBuilder.withBaseUrl(URL)
except that aMalformedURLException
may occur when creating theURL
instance from the given parameters.- Specified by:
withBaseUrl
in interfaceBaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>
- Parameters:
aScheme
- TheScheme
(e.g.Scheme.HTTP
orScheme.HTTPS
) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.aPath
- The path on the host to which the baseURL
is to point to.- Returns:
- The builder for applying multiple build operations.
- Throws:
java.net.MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
withBaseUrl
default HttpClientContext.HttpClientContextBuilder withBaseUrl(java.lang.String aProtocol, java.lang.String aHost, int aPort) throws java.net.MalformedURLException
Builder method forBaseUrlAccessor.BaseUrlMutator.setBaseUrl(String, String, int)
.- Specified by:
withBaseUrl
in interfaceBaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>
- Parameters:
aProtocol
- The protocol (e.g. HTTP or HTTPS) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.aPort
- The port to be used when connecting to the host.- Returns:
- The builder for applying multiple build operations.
- Throws:
java.net.MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
withBaseUrl
default HttpClientContext.HttpClientContextBuilder withBaseUrl(org.refcodes.data.Scheme aScheme, java.lang.String aHost, int aPort) throws java.net.MalformedURLException
Builder method forBaseUrlAccessor.BaseUrlMutator.setBaseUrl(Scheme, String, int)
.- Specified by:
withBaseUrl
in interfaceBaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>
- Parameters:
aScheme
- TheScheme
(e.g.Scheme.HTTP
orScheme.HTTPS
) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.aPort
- The port to be used when connecting to the host.- Returns:
- The builder for applying multiple build operations.
- Throws:
java.net.MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
withBaseUrl
default HttpClientContext.HttpClientContextBuilder withBaseUrl(java.lang.String aProtocol, java.lang.String aHost, int aPort, java.lang.String aPath) throws java.net.MalformedURLException
Builder method forBaseUrlAccessor.BaseUrlMutator.setBaseUrl(String, String, int, String)
.- Specified by:
withBaseUrl
in interfaceBaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>
- Parameters:
aProtocol
- The protocol (e.g. HTTP or HTTPS) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.aPort
- The port to be used when connecting to the host.aPath
- The path on the host to which the baseURL
is to point to.- Returns:
- The builder for applying multiple build operations.
- Throws:
java.net.MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
withBaseUrl
default HttpClientContext.HttpClientContextBuilder withBaseUrl(org.refcodes.data.Scheme aScheme, java.lang.String aHost, int aPort, java.lang.String aPath) throws java.net.MalformedURLException
Builder method forBaseUrlAccessor.BaseUrlMutator.setBaseUrl(Scheme, String, int, String)
.- Specified by:
withBaseUrl
in interfaceBaseUrlAccessor.BaseUrlBuilder<HttpClientContext.HttpClientContextBuilder>
- Parameters:
aScheme
- TheScheme
(e.g.Scheme.HTTP
orScheme.HTTPS
) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.aPort
- The port to be used when connecting to the host.aPath
- The path on the host to which the baseURL
is to point to.- Returns:
- The builder for applying multiple build operations.
- Throws:
java.net.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 interfaceorg.refcodes.security.TrustStoreDescriptorAccessor.TrustStoreDescriptorBuilder<HttpClientContext.HttpClientContextBuilder>
-
-