public interface HttpDestinationProperties extends DestinationProperties
Modifier and Type | Field and Description |
---|---|
static String |
HEADER_PROPERTY
Constant prefix for header key.
|
static org.slf4j.Logger |
log
Logger for interface.
|
Modifier and Type | Method and Description |
---|---|
AuthenticationType |
getAuthenticationType()
Returns the authentication type to be expected when authenticating at the remote system.
|
io.vavr.control.Option<BasicCredentials> |
getBasicCredentials()
Returns the basic credentials to be used for authentication at the remote system.
|
default Collection<Header> |
getHeaders(URI requestUri)
Getter for a collection of header that should be added to the outgoing request for this destination.
|
default Collection<Header> |
getHeadersFromProperties()
Helper method to create the collection of headers by also considering the properties.
|
io.vavr.control.Option<KeyStore> |
getKeyStore()
The KeyStore to be used when communicating over HTTP.
|
io.vavr.control.Option<String> |
getKeyStorePassword()
The password for the Key Store to be used when communicating over HTTP.
|
io.vavr.control.Option<ProxyConfiguration> |
getProxyConfiguration()
The
ProxyConfiguration to be used when communicating over HTTP. |
io.vavr.control.Option<ProxyType> |
getProxyType()
Returns the
ProxyType that is configured for this destination. |
default SecurityConfigurationStrategy |
getSecurityConfigurationStrategy()
Defines from where the HTTP Security Configuration (see
HttpSecuritySettings ) for outbound HTTP calls via
this destination is determined from. |
io.vavr.control.Option<String> |
getTlsVersion()
The TLS version to be used when communicating over HTTP.
|
io.vavr.control.Option<KeyStore> |
getTrustStore()
Returns the optional trust store of the destination.
|
io.vavr.control.Option<String> |
getTrustStorePassword()
Returns the optional trust store password of the destination.
|
URI |
getUri()
Getter for the
URI to communicate with. |
boolean |
isTrustingAllCertificates()
Indicates whether all server certificates should be accepted when communicating over HTTP.
|
get, get, get, get, getPropertyNames
static final org.slf4j.Logger log
static final String HEADER_PROPERTY
@Nonnull URI getUri()
URI
to communicate with.
This is a mandatory property of a HttpDestination.
URI
to be used with this destination.@Nonnull io.vavr.control.Option<String> getTlsVersion()
Option
wrapping the TLS version to use, if any.@Nonnull io.vavr.control.Option<ProxyConfiguration> getProxyConfiguration()
ProxyConfiguration
to be used when communicating over HTTP.Option
wrapping the ProxyConfiguration
to use, if any.@Nonnull io.vavr.control.Option<KeyStore> getKeyStore()
Option
wrapping the KeyStore to use, if any.@Nonnull io.vavr.control.Option<String> getKeyStorePassword()
Option
wrapping the password to use, if any.boolean isTrustingAllCertificates()
true
if all certificates should be accepted, false
otherwise.@Nonnull io.vavr.control.Option<BasicCredentials> getBasicCredentials()
Option
wrapping the BasicCredentials
to use, if any.@Nonnull AuthenticationType getAuthenticationType()
@Nonnull io.vavr.control.Option<ProxyType> getProxyType()
ProxyType
that is configured for this destination.Option
wrapping the ProxyType
to use, if any.@Nonnull io.vavr.control.Option<KeyStore> getTrustStore()
DestinationAccessException
- If there is an issue accessing the trust store.@Nonnull io.vavr.control.Option<String> getTrustStorePassword()
@Nonnull @Beta default SecurityConfigurationStrategy getSecurityConfigurationStrategy()
HttpSecuritySettings
) for outbound HTTP calls via
this destination is determined from.SecurityConfigurationStrategy
of the destination@Nonnull default Collection<Header> getHeaders(@Nonnull URI requestUri)
requestUri
- The target URI of a request to which HTTP headers should be added.@Nonnull default Collection<Header> getHeadersFromProperties()
Copyright © 2021 SAP SE. All rights reserved.