com.sap.cloud.sdk.cloudplatform.connectivity

Class ClientCredentialsHttpDestination

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.ClientCredentialsHttpDestination

All Implemented Interfaces:

DestinationProperties, HttpDestination, HttpDestinationProperties

public final class ClientCredentialsHttpDestination
extends Object
implements HttpDestination

HttpDestination implementation automatically adding an authentication header retrieved from an XSUAA service with client credentials.

Constructor Summary

Constructors

Constructor and Description
ClientCredentialsHttpDestination(HttpDestinationProperties baseDestination, ClientCredentials clientCredentials, ClientCredentialsGrantType grantType, URI xsuaaUri, XsuaaService xsuaaService) Wraps the given destination and adds the authentication header retrieved from the given XSUAA service with the given credentials via the given grant type.
ClientCredentialsHttpDestination(HttpDestinationProperties baseDestination, ClientCredentials clientCredentials, URI xsuaaUri, XsuaaService xsuaaService) Wraps the given destination and adds the authentication header retrieved from the given XSUAA service with the given credentials via the ClientCredentialsGrantType.CLIENT_CREDENTIALS grant type.

Method Summary

Modifier and Type	Method and Description
io.vavr.control.Option<Object>	get(String key) 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.
ClientCredentials	getClientCredentials() Returns the credentials to be used to retrieve the AuthToken.
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()
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.
URI	getXsuaaUri() Returns the URI to be used to retrieve the AuthToken.
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

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

get, get, get

Constructor Detail

ClientCredentialsHttpDestination

public ClientCredentialsHttpDestination(@Nonnull
                                        HttpDestinationProperties baseDestination,
                                        @Nonnull
                                        ClientCredentials clientCredentials,
                                        @Nonnull
                                        URI xsuaaUri,
                                        @Nonnull
                                        XsuaaService xsuaaService)

Wraps the given destination and adds the authentication header retrieved from the given XSUAA service with the given credentials via the ClientCredentialsGrantType.CLIENT_CREDENTIALS grant type.

Parameters:

baseDestination - The destination to wrap.

clientCredentials - The credentials to be used to retrieve the AuthToken.

xsuaaUri - The URI of the XSUAA service to retrieve the AuthToken from.

xsuaaService - XsuaaService instance to be used to retrieve the AuthToken.

ClientCredentialsHttpDestination

public ClientCredentialsHttpDestination(@Nonnull
                                        HttpDestinationProperties baseDestination,
                                        @Nonnull
                                        ClientCredentials clientCredentials,
                                        @Nullable
                                        ClientCredentialsGrantType grantType,
                                        @Nonnull
                                        URI xsuaaUri,
                                        @Nonnull
                                        XsuaaService xsuaaService)

Wraps the given destination and adds the authentication header retrieved from the given XSUAA service with the given credentials via the given grant type.

Parameters:

baseDestination - The destination to wrap.

clientCredentials - The credentials to be used to retrieve the AuthToken.

grantType - The grant type to retrieve the access token with.

xsuaaUri - The URI of the XSUAA service to retrieve the AuthToken from.

xsuaaService - XsuaaService instance to be used to retrieve the AuthToken.

Method Detail

get

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

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.

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.

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.

getProxyConfiguration

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

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

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.

getBasicCredentials

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

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

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

getTrustStore

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

Specified by:

getTrustStore in interface HttpDestinationProperties

Returns:

The optional trust store of the destination.

getTrustStorePassword

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

Specified by:

getTrustStorePassword in interface HttpDestinationProperties

Returns:

The optional trust store password of the destination.

getXsuaaUri

@Nonnull
public URI getXsuaaUri()

Returns the URI to be used to retrieve the AuthToken.

Returns:

The URI provided on creation time.

getClientCredentials

@Nonnull
public ClientCredentials getClientCredentials()

Returns the credentials to be used to retrieve the AuthToken.

Returns:

The credentials provided on creation time.

getHeaders

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

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