com.sap.cloud.sdk.cloudplatform.connectivity

Class AbstractHttpDestination

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.AbstractHttpDestination

All Implemented Interfaces:

DestinationProperties, HttpDestination, HttpDestinationProperties

public abstract class AbstractHttpDestination
extends Object
implements HttpDestination

Abstract implementation of the HttpDestination interface that delegates all interface methods to a base HttpDestinationProperties object.

Field Summary

Fields inherited from interface com.sap.cloud.sdk.cloudplatform.connectivity.HttpDestinationProperties

HEADER_PROPERTY, log

Constructor Summary

Constructors

Constructor and Description
AbstractHttpDestination(HttpDestinationProperties baseDestination)

Method Summary

Modifier and Type	Method and Description
<ValueT> io.vavr.control.Option<ValueT>	get(com.sap.cloud.sdk.cloudplatform.connectivity.DestinationPropertyKey<ValueT> propertyKey) Convenience method to convert the Object return type of DestinationProperties.get(String) into any expected type.
io.vavr.control.Option<Object>	get(String key) Gets the value associated with the given key (if any).
<ValueT> io.vavr.control.Option<ValueT>	get(String key, Class<ValueT> expectedType) Convenience method to cast the Object return type of DestinationProperties.get(String) into the expected type.
<ValueT> io.vavr.control.Option<ValueT>	get(String key, Function<Object,ValueT> conversion) Convenience method to convert the Object return type of DestinationProperties.get(String) into any expected type.
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.
Collection<Header>	getHeaders(URI requestUri) Getter for a collection of header that should be added to the outgoing request for this destination.
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.
Iterable<String>	getPropertyNames() Retrieves the set of property keys of the destination.
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.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sap.cloud.sdk.cloudplatform.connectivity.HttpDestination

decorate

Constructor Detail

AbstractHttpDestination

public AbstractHttpDestination(HttpDestinationProperties baseDestination)

Method Detail

getUri

public URI getUri()

Description copied from interface: HttpDestinationProperties

Getter for the URI to communicate with.

This is a mandatory property of a HttpDestination.

Specified by:

getUri in interface HttpDestinationProperties

Returns:

The URI to be used with this destination.

getTlsVersion

public io.vavr.control.Option<String> getTlsVersion()

Description copied from interface: HttpDestinationProperties

The TLS version to be used when communicating over HTTP.

Specified by:

getTlsVersion in interface HttpDestinationProperties

Returns:

An Option wrapping the TLS version to use, if any.

getProxyConfiguration

public io.vavr.control.Option<ProxyConfiguration> getProxyConfiguration()

Description copied from interface: HttpDestinationProperties

The ProxyConfiguration to be used when communicating over HTTP.

Specified by:

getProxyConfiguration in interface HttpDestinationProperties

Returns:

An Option wrapping the ProxyConfiguration to use, if any.

getKeyStore

public io.vavr.control.Option<KeyStore> getKeyStore()

Description copied from interface: HttpDestinationProperties

The KeyStore to be used when communicating over HTTP.

Specified by:

getKeyStore in interface HttpDestinationProperties

Returns:

An Option wrapping the KeyStore to use, if any.

getKeyStorePassword

public io.vavr.control.Option<String> getKeyStorePassword()

Description copied from interface: HttpDestinationProperties

The password for the Key Store to be used when communicating over HTTP.

Specified by:

getKeyStorePassword in interface HttpDestinationProperties

Returns:

An Option wrapping the password to use, if any.

isTrustingAllCertificates

public boolean isTrustingAllCertificates()

Description copied from interface: HttpDestinationProperties

Indicates whether all server certificates should be accepted when communicating over HTTP.

Specified by:

isTrustingAllCertificates in interface HttpDestinationProperties

Returns:

true if all certificates should be accepted, false otherwise.

getBasicCredentials

public io.vavr.control.Option<BasicCredentials> getBasicCredentials()

Description copied from interface: HttpDestinationProperties

Returns the basic credentials to be used for authentication at the remote system.

Specified by:

getBasicCredentials in interface HttpDestinationProperties

Returns:

An Option wrapping the BasicCredentials to use, if any.

getAuthenticationType

public AuthenticationType getAuthenticationType()

Description copied from interface: HttpDestinationProperties

Returns the authentication type to be expected when authenticating at the remote system.

Specified by:

getAuthenticationType in interface HttpDestinationProperties

Returns:

This destination authentication type.

getProxyType

public io.vavr.control.Option<ProxyType> getProxyType()

Description copied from interface: HttpDestinationProperties

Returns the ProxyType that is configured for this destination.

Specified by:

getProxyType in interface HttpDestinationProperties

Returns:

An Option wrapping the ProxyType to use, if any.

getTrustStore

public io.vavr.control.Option<KeyStore> getTrustStore()

Description copied from interface: HttpDestinationProperties

Returns the optional trust store of the destination.

Specified by:

getTrustStore in interface HttpDestinationProperties

Returns:

The optional trust store of the destination.

getTrustStorePassword

public io.vavr.control.Option<String> getTrustStorePassword()

Description copied from interface: HttpDestinationProperties

Returns the optional trust store password of the destination.

Specified by:

getTrustStorePassword in interface HttpDestinationProperties

Returns:

The optional trust store password of the destination.

getSecurityConfigurationStrategy

public SecurityConfigurationStrategy getSecurityConfigurationStrategy()

Description copied from interface: HttpDestinationProperties

Defines from where the HTTP Security Configuration (see HttpSecuritySettings) for outbound HTTP calls via this destination is determined from.

Specified by:

getSecurityConfigurationStrategy in interface HttpDestinationProperties

Returns:

The optional SecurityConfigurationStrategy of the destination

getHeaders

public Collection<Header> getHeaders(URI requestUri)

Description copied from interface: HttpDestinationProperties

Getter for a collection of header that should be added to the outgoing request for this destination.

Specified by:

getHeaders in interface HttpDestinationProperties

Parameters:

requestUri - The target URI of a request to which HTTP headers should be added.

Returns:

A collection with all headers to be used when communicating with the target of the destination.

getHeadersFromProperties

public Collection<Header> getHeadersFromProperties()

Description copied from interface: HttpDestinationProperties

Helper method to create the collection of headers by also considering the properties.

Specified by:

getHeadersFromProperties in interface HttpDestinationProperties

Returns:

A collection with all headers that were given as properties.

get

public io.vavr.control.Option<Object> get(String key)

Description copied from interface: DestinationProperties

Gets the value associated with the given key (if any).

Specified by:

get in interface DestinationProperties

Parameters:

key - The key to get the value for.

Returns:

An Option object containing the value, if any.

getPropertyNames

public Iterable<String> getPropertyNames()

Description copied from interface: DestinationProperties

Retrieves the set of property keys of the destination.

Specified by:

getPropertyNames in interface DestinationProperties

Returns:

An iterable of type String which is the set of property keys for a destination

get

public <ValueT> io.vavr.control.Option<ValueT> get(String key,
                                                   Class<ValueT> expectedType)

Description copied from interface: DestinationProperties

Convenience method to cast the Object return type of DestinationProperties.get(String) into the expected type.

Specified by:

get in interface DestinationProperties

Type Parameters:

ValueT - The expected type of the value.

Parameters:

key - The key to get the value for.

expectedType - The expected type to cast the value to.

Returns:

An Option object containing the converted value, if any.

get

public <ValueT> io.vavr.control.Option<ValueT> get(String key,
                                                   Function<Object,ValueT> conversion)

Description copied from interface: DestinationProperties

Convenience method to convert the Object return type of DestinationProperties.get(String) into any expected type.

Specified by:

get in interface DestinationProperties

Type Parameters:

ValueT - The expected type of the value.

Parameters:

key - The key to get the value for.

conversion - A function converting the object given by DestinationProperties.get(String) into the expected type. Will never be called if no value (or null) is present for the given key.

Returns:

An Option object containing the converted value, if any.

get

public <ValueT> io.vavr.control.Option<ValueT> get(com.sap.cloud.sdk.cloudplatform.connectivity.DestinationPropertyKey<ValueT> propertyKey)

Description copied from interface: DestinationProperties

Convenience method to convert the Object return type of DestinationProperties.get(String) into any expected type.

Specified by:

get in interface DestinationProperties

Type Parameters:

ValueT - The expected type of the value.

Parameters:

propertyKey - The DestinationPropertyKey for the value to retrieve.

Returns:

An Option object containing the converted value, if any.