Package com.sap.cloud.sdk.cloudplatform.connectivity

Class DefaultHttpDestination

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.DefaultHttpDestination

All Implemented Interfaces:

Destination, DestinationProperties, HttpDestination, HttpDestinationProperties

public final class DefaultHttpDestination
extends Object
implements HttpDestination

Immutable default implementation of the HttpDestination interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultHttpDestination.Builder	Builder class to allow for easy creation of an immutable DefaultHttpDestination instance.

Method Summary

Modifier and Type	Method	Description
static DefaultHttpDestination.Builder	builder(String uri)	Starts a builder to be used to create a DefaultHttpDestination with property: .
static DefaultHttpDestination.Builder	builder(URI uri)	Starts a builder to be used to create a DefaultHttpDestination with some properties.
boolean	equals(Object o)
static DefaultHttpDestination.Builder	fromDestination(Destination destination)	Creates a new DefaultHttpDestination instance from the given Destination by copying all properties returned by DestinationProperties.getPropertyNames().
static DefaultHttpDestination.Builder	fromMap(Map<String,?> map)	Creates a new DefaultHttpDestination instance from the given map of properties.
static DefaultHttpDestination.Builder	fromProperties(DestinationProperties properties)	Creates a new DefaultHttpDestination instance from the given DestinationProperties by copying all properties returned by DestinationProperties.getPropertyNames().
<ValueT> io.vavr.control.Option<ValueT>	get(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 headers that should be added to the outgoing request for this destination.
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 how the SSLContext 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.
int	hashCode()
boolean	isTrustingAllCertificates()	Indicates whether all server certificates should be accepted when communicating over HTTP.
DefaultHttpDestination.Builder	toBuilder()	Returns a new DefaultHttpDestination.Builder instance that is initialized with this DefaultHttpDestination.
String	toString()

Methods inherited from class java.lang.Object

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

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

asHttp, asRfc, isHttp, isRfc

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

getHeaders

Method Details

getHeaders

@Nonnull
public Collection<Header> getHeaders(@Nonnull
 URI requestUri)

Description copied from interface: HttpDestinationProperties

Getter for a collection of headers 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.

getUri

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
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.

getTrustStore

@Nonnull
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

@Nonnull
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

@Nonnull
public SecurityConfigurationStrategy getSecurityConfigurationStrategy()

Description copied from interface: HttpDestinationProperties

Defines from how the SSLContext for outbound HTTP calls via this destination is determined from.

Specified by:

getSecurityConfigurationStrategy in interface HttpDestinationProperties

Returns:

The optional SecurityConfigurationStrategy of the destination

getBasicCredentials

@Nonnull
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

@Nonnull
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

@Nonnull
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.

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

toBuilder

@Nonnull
public DefaultHttpDestination.Builder toBuilder()

Returns a new DefaultHttpDestination.Builder instance that is initialized with this DefaultHttpDestination.

Please note that this operation performs a shallow copy only. As a consequence, complex objects (such as the KeyStores) will be copied by reference only, which leads to a shared state between the destination and the DefaultHttpDestination to be created.

Returns:

A new DefaultHttpDestination.Builder instance.

Since:

5.0.0

See Also:

• fromDestination(Destination)

builder

@Nonnull
public static DefaultHttpDestination.Builder builder(@Nonnull
 String uri)

Starts a builder to be used to create a DefaultHttpDestination with property: .

Parameters:

uri - The uri of the DefaultHttpDestination to be created. In case this is no valid URI an IllegalArgumentException will be thrown.

Returns:

A new Builder instance.

Throws:

IllegalArgumentException - if the given uri is no valid URI.

builder

@Nonnull
public static DefaultHttpDestination.Builder builder(@Nonnull
 URI uri)

Starts a builder to be used to create a DefaultHttpDestination with some properties.

Parameters:

uri - The uri of the DefaultHttpDestination to be created.

Returns:

A new Builder instance.

fromMap

@Nonnull
public static DefaultHttpDestination.Builder fromMap(@Nonnull
 Map<String,?> map)

Creates a new DefaultHttpDestination instance from the given map of properties.

Parameters:

map - The map of properties to create the builder from.

Returns:

A new DefaultHttpDestination.Builder instance.

Since:

5.0.0

fromProperties

@Nonnull
public static DefaultHttpDestination.Builder fromProperties(@Nonnull
 DestinationProperties properties)

Creates a new DefaultHttpDestination instance from the given DestinationProperties by copying all properties returned by DestinationProperties.getPropertyNames(). In addition, if the given destination is an instance of DefaultHttpDestination, all additional properties that are specific to the HttpDestinationProperties instance will be copied as well. This especially also includes any statically added DestinationHeaderProviders and Headers attached to the destination.

Please note that this operation performs a shallow copy only. As a consequence, complex objects (such as the KeyStores) will be copied by reference only, which leads to a shared state between the destination and the DefaultHttpDestination to be created.

Parameters:

properties - The DestinationProperties to create the builder from.

Returns:

A new DefaultHttpDestination.Builder instance.

Throws:

IllegalArgumentException - if the provided properties are not an instance of either DefaultDestination or DefaultHttpDestination.

Since:

5.0.0

fromDestination

@Nonnull
public static DefaultHttpDestination.Builder fromDestination(@Nonnull
 Destination destination)

Creates a new DefaultHttpDestination instance from the given Destination by copying all properties returned by DestinationProperties.getPropertyNames(). In addition, if the given destination is an instance of DefaultHttpDestination, all additional properties that are specific to the HttpDestinationProperties instance will be copied as well. This especially also includes any statically added DestinationHeaderProviders and Headers attached to the destination.

Please note that this operation performs a shallow copy only. As a consequence, complex objects (such as the KeyStores) will be copied by reference only, which leads to a shared state between the destination and the DefaultHttpDestination to be created.

Parameters:

destination - The Destination to create the builder from.

Returns:

A new DefaultHttpDestination.Builder instance.

Throws:

IllegalArgumentException - if the provided destination is not an instance of either DefaultDestination or DefaultHttpDestination.

Since:

5.0.0

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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(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.