com.sap.cloud.sdk.cloudplatform.connectivity

Class ScpCfHttpDestination

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.AbstractScpDestination

com.sap.cloud.sdk.cloudplatform.connectivity.ScpCfHttpDestination

All Implemented Interfaces:

DestinationProperties, HttpDestination, HttpDestinationProperties

public class ScpCfHttpDestination
extends AbstractScpDestination
implements HttpDestination

SCP Cloud Foundry specific representation of a HTTP destination as a collection of key-value pairs.

Additionally provides a builder to construct instances.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.sap.cloud.sdk.cloudplatform.connectivity.AbstractScpDestination

baseDestination

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScpCfHttpDestination(DestinationProperties baseDestination) Create an instance by wrapping an existing DestinationProperties object.
protected	ScpCfHttpDestination(HttpDestinationProperties baseDestination) Create an instance by wrapping an existing HttpDestinationProperties object.

Method Summary

Modifier and Type	Method and Description
static ScpCfHttpDestination.Builder	builder(String name, String uri) Starts a builder to be used to create a ScpCfHttpDestination with some properties.
static ScpCfHttpDestination.Builder	builder(String name, URI uri) Starts a builder to be used to create a ScpCfHttpDestination with some properties.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
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<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()
io.vavr.control.Option<String>	getTrustStorePassword()
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 com.sap.cloud.sdk.cloudplatform.connectivity.AbstractScpDestination

get, getName, getPropertyNames, getType, 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.HttpDestination

decorate

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

get, get, get, get, getPropertyNames

Constructor Detail

ScpCfHttpDestination

protected ScpCfHttpDestination(@Nonnull
                               DestinationProperties baseDestination)

Create an instance by wrapping an existing DestinationProperties object. To be representable as a ScpCfHttpDestination, the existing destination object must have the following:

• DestinationProperty.NAME property set.
• DestinationProperty.TYPE property set to DestinationType.HTTP.
• DestinationProperty.URI property set to a valid URL.

Parameters:

baseDestination - Existing destination object that implements the DestinationProperties interface.

ScpCfHttpDestination

protected ScpCfHttpDestination(@Nonnull
                               HttpDestinationProperties baseDestination)

Create an instance by wrapping an existing HttpDestinationProperties object. To be representable as a ScpCfHttpDestination, the existing destination object must have the following:

• DestinationProperty.NAME property set.
• DestinationProperty.TYPE property set to DestinationType.HTTP.
• DestinationProperty.URI property set to a valid URL.

Parameters:

baseDestination - Existing destination object that implements the HttpDestinationProperties interface.

Method Detail

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.

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.

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.

getTrustStorePassword

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

Specified by:

getTrustStorePassword in interface HttpDestinationProperties

Returns:

The optional trust store password of the destination.

getHeaders

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

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.

Throws:

DestinationAccessException

builder

@Nonnull
public static ScpCfHttpDestination.Builder builder(@Nonnull
                                                            String name,
                                                            @Nonnull
                                                            URI uri)

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

Parameters:

name - The name of the destination.

uri - The URI of the destination.

Returns:

A builder to set up a new ScpCfHttpDestination.

builder

@Nonnull
public static ScpCfHttpDestination.Builder builder(@Nonnull
                                                            String name,
                                                            @Nonnull
                                                            String uri)

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

Parameters:

uri - The URI (as a String) of the destination.

name - The name of the destination.

Returns:

A builder to set up a new ScpCfHttpDestination.

Throws:

IllegalArgumentException - If the given string cannot be converted to a URI, as described by URI.create(String).

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class AbstractScpDestination

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class AbstractScpDestination

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractScpDestination

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.

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.

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.

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.

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.

getTrustStore

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

Specified by:

getTrustStore in interface HttpDestinationProperties

Returns:

The optional trust store of the destination.