com.sap.cloud.sdk.cloudplatform.connectivity

Class DefaultHttpDestination

java.lang.Object

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

All Implemented Interfaces:

DestinationProperties, HttpDestination, HttpDestinationProperties

public class DefaultHttpDestination
extends Object
implements HttpDestination

Immutable default implementation of the HttpDestination interface.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Header>	httpHeaders Headers prepared for this destination.

Constructor Summary

Constructors

Constructor and Description
DefaultHttpDestination(DestinationProperties baseProperties) Creates a new instance of based on the given "generic" destination.

Method Summary

Modifier and Type	Method and Description
static DefaultHttpDestination.Builder	builder(HttpDestinationProperties httpDestination) Starts a builder to be used to create a DefaultHttpDestination with some properties.
static DefaultHttpDestination.Builder	builder(String uri) Starts a builder to be used to create a DefaultHttpDestination with some properties.
static DefaultHttpDestination.Builder	builder(URI uri) Starts a builder to be used to create a DefaultHttpDestination with some properties.
static boolean	canDecorate(DestinationProperties destination) Verifies that the given "generic" destination might be decorated into a DefaultHttpDestination.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
io.vavr.control.Option<Object>	get(String someKey) Gets the value associated with the given key (if any).
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.
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<String>	getName()
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.
int	hashCode()
boolean	isTrustingAllCertificates() Indicates whether all server certificates should be accepted when communicating over HTTP.

Methods inherited from class java.lang.Object

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

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

decorate

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

get, get, get

Field Detail

httpHeaders

@Nonnull
protected final List<Header> httpHeaders

Headers prepared for this destination.

Constructor Detail

DefaultHttpDestination

public DefaultHttpDestination(@Nonnull
                              DestinationProperties baseProperties)

Creates a new instance of based on the given "generic" destination.

Parameters:

baseProperties - The destination to take the properties from.

Method Detail

canDecorate

public static boolean canDecorate(@Nonnull
                                  DestinationProperties destination)

Verifies that the given "generic" destination might be decorated into a DefaultHttpDestination.

Parameters:

destination - The destination to check.

Returns:

true, if the given destination is decoratable as a DefaultHttpDestination; false otherwise.

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.

builder

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

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

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
                                                              HttpDestinationProperties httpDestination)

Starts a builder to be used to create a DefaultHttpDestination with some properties. Copies all properties from the given destination to the returned builder instance. Also, all headers retrieved via HttpDestinationProperties.getHeaders(URI) for the destination URI are copied to the new destination.

Parameters:

httpDestination - The HttpDestinationProperties instance to copy the values for the new destination from.

Returns:

A new Builder instance.

get

@Nonnull
public io.vavr.control.Option<Object> get(@Nonnull
                                                   String someKey)

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

Specified by:

get in interface DestinationProperties

Parameters:

someKey - The key to get the value for.

Returns:

An Option object containing the value, if any.

getPropertyNames

@Nonnull
public Iterable<String> getPropertyNames()

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

getUri

@Nonnull
public URI getUri()

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.

getHeaders

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

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.

getTlsVersion

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

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.

getKeyStore

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

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

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

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

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

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

getAuthenticationType

@Nonnull
public AuthenticationType getAuthenticationType()

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

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.

getName

@Nonnull
public io.vavr.control.Option<String> getName()

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(@Nullable
                           Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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.

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.