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

Class TransparentProxyDestination

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.TransparentProxyDestination

All Implemented Interfaces:

Destination, DestinationProperties, HttpDestination, HttpDestinationProperties

public class TransparentProxyDestination
extends Object
implements HttpDestination

* Immutable implementation of the HttpDestination interface for using the transparent proxy.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TransparentProxyDestination.AbstractBuilder<B extends TransparentProxyDestination.AbstractBuilder<B>>	Abstract base class for builders to share common functionality like adding headers and properties.
static final class	TransparentProxyDestination.Builder	Builder for creating a destination TransparentProxyDestination.
static final class	TransparentProxyDestination.GatewayBuilder	Builder for creating a destination-gateway TransparentProxyDestination.

Method Summary

Modifier and Type	Method	Description
static TransparentProxyDestination.Builder	destination(String uri)	Creates a new builder for a destination.
boolean	equals(Object o)
static TransparentProxyDestination.GatewayBuilder	gateway(String destinationName, String uri)	Creates a new builder for a destination-gateway.
<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 arg0)	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.
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.Destination

asHttp, asRfc, isHttp, isRfc

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

getHeaders, getSecurityConfigurationStrategy

Method Details

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.

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.

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.

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.

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.

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

destination

@Nonnull
public static TransparentProxyDestination.Builder destination(@Nonnull
 String uri)

Creates a new builder for a destination.

A destination connects directly to a specified URL and does not use the destination-gateway. It allows setting generic headers but does not support gateway-specific properties like destination name or fragments.

Returns:

A new TransparentProxyDestination.Builder instance.

gateway

@Nonnull
public static TransparentProxyDestination.GatewayBuilder gateway(@Nonnull
 String destinationName,
 @Nonnull
 String uri)

Creates a new builder for a destination-gateway.

A destination-gateway requires a destination name and will be routed through the central destination-gateway. It supports all gateway-specific properties like fragments, tenant context, and authentication flows.

Parameters:

destinationName - The name of the destination to be resolved by the gateway.

Returns:

A new TransparentProxyDestination.GatewayBuilder instance.

get

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

Description copied from interface: DestinationProperties

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

Specified by:

get in interface DestinationProperties

Parameters:

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